org.apache.velocity.tools.view
Class DataInfo

java.lang.Object
  org.apache.velocity.tools.view.DataInfo

All Implemented Interfaces:

ToolInfo

public class DataInfo
extends java.lang.Object
implements ToolInfo

ToolInfo implementation to handle "primitive" data types. It currently supports String, Number, and Boolean data.

An example of data elements specified in your toolbox.xml might be:

  <data type="string">
    <key>app_name</key>
    <value>FooWeb Deluxe</value>
  </data>
  <data type="number">
    <key>app_version</key>
    <value>4.2</value>
  </data>
  <data type="boolean">
    <key>debug</key>
    <value>true</value>
  </data>
  <data type="number">
    <key>screen_width</key>
    <value>400</value>
  </data>
 

Version:

$Id: DataInfo.java 479724 2006-11-27 18:49:37Z nbubna $

Author:

Nathan Bubna

Field Summary

private java.lang.Object	data
private java.lang.String	key
static java.lang.String	TYPE_BOOLEAN
private int	type_id
private static int	TYPE_ID_BOOLEAN
private static int	TYPE_ID_NUMBER
private static int	TYPE_ID_STRING
static java.lang.String	TYPE_NUMBER
static java.lang.String	TYPE_STRING

Constructor Summary

DataInfo()

Method Summary

java.lang.String	getClassname()
java.lang.Object	getInstance(java.lang.Object initData) Returns the data.
java.lang.String	getKey() Accessors
void	setKey(java.lang.String key) Mutators
void	setType(java.lang.String type)
void	setValue(java.lang.String value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_STRING

public static final java.lang.String TYPE_STRING

See Also:

Constant Field Values

TYPE_NUMBER

public static final java.lang.String TYPE_NUMBER

See Also:

Constant Field Values

TYPE_BOOLEAN

public static final java.lang.String TYPE_BOOLEAN

See Also:

Constant Field Values

TYPE_ID_STRING

private static final int TYPE_ID_STRING

See Also:

Constant Field Values

TYPE_ID_NUMBER

private static final int TYPE_ID_NUMBER

See Also:

Constant Field Values

TYPE_ID_BOOLEAN

private static final int TYPE_ID_BOOLEAN

See Also:

Constant Field Values

key

private java.lang.String key

type_id

private int type_id

data

private java.lang.Object data

Constructor Detail

DataInfo

public DataInfo()

Method Detail

setKey

public void setKey(java.lang.String key)

Mutators

setType

public void setType(java.lang.String type)

setValue

public void setValue(java.lang.String value)

getKey

public java.lang.String getKey()

Accessors

Specified by:

getKey in interface ToolInfo

Returns:

the context key for the tool

getClassname

public java.lang.String getClassname()

Specified by:

getClassname in interface ToolInfo

Returns:

the fully qualified classname for the tool

getInstance

public java.lang.Object getInstance(java.lang.Object initData)

Returns the data. Always returns the same object since the data is a constant. Initialization data is ignored.

Specified by:

getInstance in interface ToolInfo

Parameters:

initData - an object that may be used to initialize the instance

Returns:

an instance of the tool