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

 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
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
24 */
25
26package com.googlecode.charts4j.parameters;
27
28/**
29 * <b>For Charts4J internal use only.</b> All implementors of this interface
30 * are responsible for creating one Google Chart API URL parameter string.
31 *
32 * @author Julien Chastang (julien.c.chastang at gmail dot com)
33 */
34interface Parameter {
35
36    /**
37     * Get the Google Chart API URL parameter key.
38     * 
39     * @return the string
40     */
41    String getKey();
42
43    /**
44     * Get the Google Chart API URL parameter value.
45     * 
46     * @return the string
47     */
48    String getValue();
49
50    /**
51     * Creates the Google Chart API URL parameter string.
52     *
53     * @return the string
54     */
55    String toURLParameterString();
56}