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
Propertys, which may added to anyConfigurationsubclass, includingToolConfiguration,ToolboxConfiguration, andFactoryConfiguration. In other words, anything you can do in aDataconfiguration, you can do with aProperty.Some features supported here are:
- built in
Data.Types 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
Converterimplementation
- 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 classData.AutoConverterprotected static classData.FieldConverterprotected static classData.NumberConverterprotected static classData.TypeDelineates the standard, known types and their associated target classes (setTargetClass(java.lang.Class)and converters (setConverter(java.lang.Class)).
-
Field Summary
Fields Modifier and Type Field Description protected static Data.TypeDEFAULT_TYPE
-
Constructor Summary
Constructors Constructor Description Data()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intcompareTo(Data datum)protected java.lang.Objectconvert(java.lang.Object value)voidconvertWith(org.apache.commons.beanutils.Converter converter)This is a convenience method for those doing configuration in java.booleanequals(java.lang.Object obj)java.lang.ObjectgetConvertedValue()org.apache.commons.beanutils.ConvertergetConverter()java.lang.StringgetKey()java.lang.ClassgetTargetClass()java.lang.StringgetType()java.lang.ObjectgetValue()inthashCode()voidsetClass(java.lang.String classname)This doesn't take aClassparameter because this class was not created for all-java configuration.voidsetClassname(java.lang.String classname)voidsetConverter(java.lang.Class clazz)voidsetConverter(java.lang.String classname)voidsetKey(java.lang.String key)voidsetTargetClass(java.lang.Class clazz)voidsetType(java.lang.String t)protected voidsetType(Data.Type type)voidsetValue(java.lang.Object value)java.lang.StringtoString()voidvalidate()
-
-
-
Field Detail
-
DEFAULT_TYPE
protected static final Data.Type DEFAULT_TYPE
-
-
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 aClassparameter because this class was not created for all-java configuration.- Parameters:
classname- class name
-
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.- Parameters:
converter- value converter
-
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:
compareToin interfacejava.lang.Comparable<Data>
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
convert
protected java.lang.Object convert(java.lang.Object value)
-
-