/src/main/java/com/googlecode/charts4j/parameters/Parameter.java

http://charts4j.googlecode.com/ · Java · 56 lines · 6 code · 5 blank · 45 comment · 0 complexity · 960b7e26e93fb12513d287720050579d MD5 · raw file

  1. /**
  2. *
  3. * The MIT License
  4. *
  5. * Copyright (c) 2011 the original author or authors.
  6. *
  7. * Permission is hereby granted, free of charge, to any person obtaining a copy
  8. * of this software and associated documentation files (the "Software"), to deal
  9. * in the Software without restriction, including without limitation the rights
  10. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11. * copies of the Software, and to permit persons to whom the Software is
  12. * furnished to do so, subject to the following conditions:
  13. * The above copyright notice and this permission notice shall be included in
  14. * all copies or substantial portions of the Software.
  15. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21. * THE SOFTWARE.
  22. */
  23. package com.googlecode.charts4j.parameters;
  24. /**
  25. * <b>For Charts4J internal use only.</b> All implementors of this interface
  26. * are responsible for creating one Google Chart API URL parameter string.
  27. *
  28. * @author Julien Chastang (julien.c.chastang at gmail dot com)
  29. */
  30. interface Parameter {
  31. /**
  32. * Get the Google Chart API URL parameter key.
  33. *
  34. * @return the string
  35. */
  36. String getKey();
  37. /**
  38. * Get the Google Chart API URL parameter value.
  39. *
  40. * @return the string
  41. */
  42. String getValue();
  43. /**
  44. * Creates the Google Chart API URL parameter string.
  45. *
  46. * @return the string
  47. */
  48. String toURLParameterString();
  49. }