org.apache.velocity.tools.config
Class Data

java.lang.Object
  extended by org.apache.velocity.tools.config.Data
All Implemented Interfaces:
java.lang.Comparable<Data>
Direct Known Subclasses:
Property

public class Data
extends java.lang.Object
implements java.lang.Comparable<Data>

This class represents configured data. If added to a FactoryConfiguration, its values will be made available in the application-scoped toolboxes produced by any ToolboxFactory configured using that configuration.

This class also implements all the functionality of Propertys, which may added to any Configuration subclass, including ToolConfiguration, ToolboxConfiguration, and FactoryConfiguration. In other words, anything you can do in a Data configuration, you can do with a Property.

Some features supported here are:

Version:
$Id: Data.java 511959 2007-02-26 19:24:39Z nbubna $
Author:
Nathan Bubna

Nested Class Summary
protected static class Data.AutoConverter
           
protected static class Data.FieldConverter
           
protected static class Data.NumberConverter
           
protected static class Data.Type
          Delineates the standard, known types and their associated target classes (setTargetClass(java.lang.Class) and converters (setConverter(java.lang.Class)).
 
Field Summary
private  org.apache.commons.beanutils.Converter converter
           
protected static Data.Type DEFAULT_TYPE
           
private  boolean isList
           
private  java.lang.String key
           
private  java.lang.Class target
           
private  java.lang.String typeValue
           
private  java.lang.Object value
           
 
Constructor Summary
Data()
           
 
Method Summary
 int compareTo(Data datum)
           
protected  java.lang.Object convert(java.lang.Object value)
           
private  java.util.List convertList(java.lang.Object val)
           
private  java.lang.Object convertValue(java.lang.Object value)
           
 void convertWith(org.apache.commons.beanutils.Converter converter)
          This is a convenience method for those doing configuration in java.
 boolean equals(java.lang.Object obj)
           
 java.lang.Object getConvertedValue()
           
 org.apache.commons.beanutils.Converter getConverter()
           
 java.lang.String getKey()
           
 java.lang.Class getTargetClass()
           
 java.lang.String getType()
           
 java.lang.Object getValue()
           
 int hashCode()
           
 void setClass(java.lang.String classname)
          This doesn't take a Class parameter because this class was not created for all-java configuration.
 void setClassname(java.lang.String classname)
           
 void setConverter(java.lang.Class clazz)
           
 void setConverter(java.lang.String classname)
           
 void setKey(java.lang.String key)
           
 void setTargetClass(java.lang.Class clazz)
           
protected  void setType(Data.Type type)
           
 void setType(java.lang.String t)
           
 void setValue(java.lang.Object value)
           
 java.lang.String toString()
           
 void validate()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

DEFAULT_TYPE

protected static final Data.Type DEFAULT_TYPE

key

private java.lang.String key

typeValue

private java.lang.String typeValue

value

private java.lang.Object value

isList

private boolean isList

target

private java.lang.Class target

converter

private org.apache.commons.beanutils.Converter converter
Constructor Detail

Data

public Data()
Method Detail

setKey

public void setKey(java.lang.String key)

setValue

public void setValue(java.lang.Object value)

setClassname

public void setClassname(java.lang.String classname)

setClass

public void setClass(java.lang.String classname)
This doesn't take a Class parameter because this class was not created for all-java configuration.


setType

protected void setType(Data.Type type)

setType

public void setType(java.lang.String t)

setTargetClass

public void setTargetClass(java.lang.Class clazz)

setConverter

public void setConverter(java.lang.Class clazz)

setConverter

public void setConverter(java.lang.String classname)

convertWith

public void convertWith(org.apache.commons.beanutils.Converter converter)
This is a convenience method for those doing configuration in java. It cannot be named setConverter(), or else it would confuse BeanUtils.


getKey

public java.lang.String getKey()

getType

public java.lang.String getType()

getValue

public java.lang.Object getValue()

getTargetClass

public java.lang.Class getTargetClass()

getConverter

public org.apache.commons.beanutils.Converter getConverter()

getConvertedValue

public java.lang.Object getConvertedValue()

validate

public void validate()

compareTo

public int compareTo(Data datum)
Specified by:
compareTo in interface java.lang.Comparable<Data>

hashCode

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

equals

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

toString

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

convert

protected java.lang.Object convert(java.lang.Object value)

convertValue

private java.lang.Object convertValue(java.lang.Object value)

convertList

private java.util.List convertList(java.lang.Object val)


Copyright (c) 2003-2007 Apache Software Foundation