Package org.apache.velocity.tools.config
Class Data
- java.lang.Object
-
- 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
Property
s, which may added to anyConfiguration
subclass, includingToolConfiguration
,ToolboxConfiguration
, andFactoryConfiguration
. In other words, anything you can do in aData
configuration, you can do with aProperty
.Some features supported here are:
- built in
Data.Type
s for strings, booleans, numbers, fields and lists thereof - auto-conversion of numbers, booleans and fields in data with no explicit type
- support for any Commons-BeanUtils
Converter
implementation
- Version:
- $Id: Data.java 511959 2007-02-26 19:24:39Z nbubna $
- Author:
- Nathan Bubna
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description 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)
).
-
Constructor Summary
Constructors Constructor Description Data()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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(Converter converter)
This is a convenience method for those doing configuration in java.boolean
equals(java.lang.Object obj)
java.lang.Object
getConvertedValue()
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 aClass
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)
void
setType(java.lang.String t)
protected void
setType(Data.Type type)
void
setValue(java.lang.Object value)
java.lang.String
toString()
void
validate()
-
-
-
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 Converter converter
-
-
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 aClass
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(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 Converter getConverter()
-
getConvertedValue
public java.lang.Object getConvertedValue()
-
validate
public void validate()
-
compareTo
public int compareTo(Data datum)
- Specified by:
compareTo
in interfacejava.lang.Comparable<Data>
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.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)
-
-