JIDE Common Layer 2.7.6

com.jidesoft.converter
Class ArrayConverter

java.lang.Object
  extended by com.jidesoft.converter.ArrayConverter
All Implemented Interfaces:
ObjectConverter
Direct Known Subclasses:
DefaultArrayConverter, DimensionConverter, InsetsConverter, MultipleEnumConverter, PointConverter, RectangleConverter

public abstract class ArrayConverter
extends java.lang.Object
implements ObjectConverter

An abstract class that is extended by any converters that convert to/from an array-like format, such as 1, 2, 3. Examples are Point. Point(100, 200) can convert to/from "100, 200"
You have the choice of what the separator is; separator is the ", " in the Point example above.


Constructor Summary
ArrayConverter(java.lang.String separator, int size, java.lang.Class<?> elementClass)
          Creates an ArrayConverter.
ArrayConverter(java.lang.String separator, int size, java.lang.Class<?>[] elementClasses)
          Creates an ArrayConverter.
 
Method Summary
 java.lang.Object[] arrayFromString(java.lang.String string, ConverterContext context)
          Converts from string to an array of objects, using separator to separate the string.
 java.lang.String arrayToString(java.lang.Object[] objects, ConverterContext context)
          Converts from array to string by concating them with separators.
protected  java.lang.Object fromString(int i, java.lang.String s, ConverterContext context)
           
 java.lang.Class<?> getElementClass()
          Gets the element class for the array.
protected  java.lang.String toString(int i, java.lang.Object o, ConverterContext context)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.jidesoft.converter.ObjectConverter
fromString, supportFromString, supportToString, toString
 

Constructor Detail

ArrayConverter

public ArrayConverter(java.lang.String separator,
                      int size,
                      java.lang.Class<?> elementClass)
Creates an ArrayConverter.

Parameters:
separator - separator to separate values. It should contain at least non-empty character.
size - size of the array
elementClass - class of the array element. Assume all elements have the same class type. If not, use the constructor which takes Class[] as parameter.

ArrayConverter

public ArrayConverter(java.lang.String separator,
                      int size,
                      java.lang.Class<?>[] elementClasses)
Creates an ArrayConverter.

Parameters:
separator - separator to separate values. It should contain at least non-empty character.
size - size of the array
elementClasses - classes of the array element. The length must be the same as size. If not, IllegalArgumentException will be thrown.
Method Detail

arrayToString

public java.lang.String arrayToString(java.lang.Object[] objects,
                                      ConverterContext context)
Converts from array to string by concating them with separators.

Parameters:
objects - an array of objects
context - converter context
Returns:
string all objects concatenated with separators

toString

protected java.lang.String toString(int i,
                                    java.lang.Object o,
                                    ConverterContext context)

arrayFromString

public java.lang.Object[] arrayFromString(java.lang.String string,
                                          ConverterContext context)
Converts from string to an array of objects, using separator to separate the string.

Parameters:
string - string to be converted
context - converter context
Returns:
the array

fromString

protected java.lang.Object fromString(int i,
                                      java.lang.String s,
                                      ConverterContext context)

getElementClass

public java.lang.Class<?> getElementClass()
Gets the element class for the array.

Returns:
the element class for the array.

JIDE Common Layer 2.7.6