com.xpn.xwiki.plugin.charts.params
Class AbstractChartParam

java.lang.Object
  extended by com.xpn.xwiki.plugin.charts.params.AbstractChartParam
All Implemented Interfaces:
ChartParam
Direct Known Subclasses:
BooleanChartParam, ChoiceChartParam, ColorChartParam, DoubleChartParam, FloatChartParam, FontChartParam, IntegerChartParam, ListChartParam, LocaleChartParam, MapChartParam, Point2DChartParam, RectangleInsetsChartParam, ShapeChartParam, StringChartParam, StrokeChartParam

public abstract class AbstractChartParam
extends java.lang.Object
implements ChartParam


Field Summary
static java.lang.String LIST_SEPARATOR
           
static java.lang.String MAP_ASSIGNMENT
           
static java.lang.String MAP_SEPARATOR
           
protected  java.lang.String name
           
protected  boolean optional
           
 
Constructor Summary
AbstractChartParam(java.lang.String name)
           
AbstractChartParam(java.lang.String name, boolean optional)
           
 
Method Summary
abstract  java.lang.Object convert(java.lang.String value)
           
 boolean equals(java.lang.Object obj)
           
protected  java.lang.Object getChoiceArg(java.util.Map map, java.lang.String name, java.util.Map choices)
           
protected  double getDoubleArg(java.util.Map map, java.lang.String name)
           
protected  float getFloatArg(java.util.Map map, java.lang.String name)
           
protected  int getIntArg(java.util.Map map, java.lang.String name)
           
protected  java.util.List getListArg(java.util.Map map, java.lang.String name)
           
 java.lang.String getName()
           
protected  java.lang.String getStringArg(java.util.Map map, java.lang.String name)
           
protected  java.lang.String getStringOptionalArg(java.util.Map map, java.lang.String name)
           
abstract  java.lang.Class getType()
           
 int hashCode()
           
 boolean isOptional()
           
protected  java.util.List parseList(java.lang.String value)
           
protected  java.util.Map parseMap(java.lang.String value)
           
protected  java.util.Map parseMap(java.lang.String value, int expectedTokenCount)
           
protected  float[] toFloatArray(java.util.List list)
           
protected  java.util.List toFloatList(java.util.List list)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

name

protected java.lang.String name

optional

protected boolean optional

MAP_SEPARATOR

public static final java.lang.String MAP_SEPARATOR
See Also:
Constant Field Values

MAP_ASSIGNMENT

public static final java.lang.String MAP_ASSIGNMENT
See Also:
Constant Field Values

LIST_SEPARATOR

public static final java.lang.String LIST_SEPARATOR
See Also:
Constant Field Values
Constructor Detail

AbstractChartParam

public AbstractChartParam(java.lang.String name)

AbstractChartParam

public AbstractChartParam(java.lang.String name,
                          boolean optional)
Method Detail

getName

public java.lang.String getName()
Specified by:
getName in interface ChartParam

isOptional

public boolean isOptional()
Specified by:
isOptional in interface ChartParam

getType

public abstract java.lang.Class getType()
Specified by:
getType in interface ChartParam

convert

public abstract java.lang.Object convert(java.lang.String value)
                                  throws ParamException
Specified by:
convert in interface ChartParam
Throws:
ParamException

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getStringArg

protected java.lang.String getStringArg(java.util.Map map,
                                        java.lang.String name)
                                 throws MissingArgumentException
Throws:
MissingArgumentException

getStringOptionalArg

protected java.lang.String getStringOptionalArg(java.util.Map map,
                                                java.lang.String name)

getIntArg

protected int getIntArg(java.util.Map map,
                        java.lang.String name)
                 throws MissingArgumentException,
                        InvalidArgumentException
Throws:
MissingArgumentException
InvalidArgumentException

getFloatArg

protected float getFloatArg(java.util.Map map,
                            java.lang.String name)
                     throws MissingArgumentException,
                            InvalidArgumentException
Throws:
MissingArgumentException
InvalidArgumentException

getDoubleArg

protected double getDoubleArg(java.util.Map map,
                              java.lang.String name)
                       throws MissingArgumentException,
                              InvalidArgumentException
Throws:
MissingArgumentException
InvalidArgumentException

getChoiceArg

protected java.lang.Object getChoiceArg(java.util.Map map,
                                        java.lang.String name,
                                        java.util.Map choices)
                                 throws MissingArgumentException,
                                        InvalidArgumentException
Throws:
MissingArgumentException
InvalidArgumentException

getListArg

protected java.util.List getListArg(java.util.Map map,
                                    java.lang.String name)
                             throws MissingArgumentException
Throws:
MissingArgumentException

parseMap

protected java.util.Map parseMap(java.lang.String value)
                          throws InvalidArgumentException
Throws:
InvalidArgumentException

parseMap

protected java.util.Map parseMap(java.lang.String value,
                                 int expectedTokenCount)
                          throws InvalidArgumentException
Throws:
InvalidArgumentException

parseList

protected java.util.List parseList(java.lang.String value)

toFloatList

protected java.util.List toFloatList(java.util.List list)
                              throws InvalidArgumentException
Throws:
InvalidArgumentException

toFloatArray

protected float[] toFloatArray(java.util.List list)
                        throws InvalidArgumentException
Throws:
InvalidArgumentException


Copyright 2003 Ludovic Dubost