|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.oddjob.framework.BaseComponent
org.oddjob.framework.BasePrimary
org.oddjob.framework.SimpleJob
org.oddjob.values.VariablesJob
public class VariablesJob
The variables job is like a bean where any property can be set with any value.
Because names are properties, they can only be valid simple property
names. 'java.version' is not valid simple property because it is
interpreted as a value 'java' that has a property 'version'. To allow
these type of properties to be referenced in Oddjob use
PropertiesJob
.
<oddjob> <job> <sequential> <jobs> <variables id="vars"> <greeting> <value value="Hello World"/> </greeting> </variables> <echo name="Echo a Greeting">${vars.greeting}</echo> </jobs> </sequential> </job> </oddjob>
Field Summary |
---|
Fields inherited from class org.oddjob.framework.SimpleJob |
---|
stateHandler, stop |
Fields inherited from class org.oddjob.framework.BaseComponent |
---|
iconHelper |
Constructor Summary | |
---|---|
VariablesJob()
|
Method Summary | |
---|---|
boolean |
contains(String name,
String key)
Does the specified mapped property contain a value for the specified key value? |
protected int |
execute()
Execute this job. |
Object |
get(String name)
Return the value of a simple property with the specified name. |
Object |
get(String name,
int index)
Return the value of an indexed property with the specified name. |
Object |
get(String name,
String key)
Return the value of a mapped property with the specified name, or null if there is no value for the specified key. |
org.apache.commons.beanutils.DynaClass |
getDynaClass()
Return the DynaClass instance that describes the set of
properties available for this DynaBean. |
protected void |
onReset()
Allow sub classes to do something on reset. |
void |
remove(String name,
String key)
Remove any existing value for the specified key on the specified mapped property. |
void |
set(String name,
int index,
Object value)
Set the value of an indexed property with the specified name. |
void |
set(String name,
Object value)
Set the value of a simple property with the specified name. |
void |
set(String name,
String key,
Object value)
Set the value of a mapped property with the specified name. |
void |
setValue(String name,
ArooaValue value)
Add a name value pair. |
String |
toString()
Override toString. |
Methods inherited from class org.oddjob.framework.SimpleJob |
---|
fireDestroyedState, force, getStateChanger, hardReset, onDestroy, onStop, run, sleep, softReset, stateHandler, stop |
Methods inherited from class org.oddjob.framework.BasePrimary |
---|
configure, getName, logger, logger, loggerName, save, setName |
Methods inherited from class org.oddjob.framework.BaseComponent |
---|
addIconListener, addPropertyChangeListener, addStateListener, configure, destroy, firePropertyChange, getArooaSession, iconForId, initialise, lastStateEvent, onConfigured, onInitialised, removeIconListener, removePropertyChangeListener, removeStateListener, save, setArooaContext, setArooaSession |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.oddjob.Stateful |
---|
addStateListener, lastStateEvent, removeStateListener |
Constructor Detail |
---|
public VariablesJob()
Method Detail |
---|
public void setValue(String name, ArooaValue value)
name
- The name of the variable.value
- The runtime configurable for the value.protected int execute() throws Exception
SimpleJob
execute
in class SimpleJob
Exception
- If the unexpected occurs.protected void onReset()
SimpleJob
onReset
in class SimpleJob
public boolean contains(String name, String key)
contains
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property to checkkey
- Name of the key to check
IllegalArgumentException
- if there is no property
of the specified namepublic Object get(String name)
get
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property whose value is to be retrieved
IllegalArgumentException
- if there is no property
of the specified namepublic Object get(String name, int index)
get
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property whose value is to be retrievedindex
- Index of the value to be retrieved
IllegalArgumentException
- if there is no property
of the specified name
IllegalArgumentException
- if the specified property
exists, but is not indexed
IndexOutOfBoundsException
- if the specified index
is outside the range of the underlying property
NullPointerException
- if no array or List has been
initialized for this propertypublic Object get(String name, String key)
null
if there is no value for the specified key.
get
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property whose value is to be retrievedkey
- Key of the value to be retrieved
IllegalArgumentException
- if there is no property
of the specified name
IllegalArgumentException
- if the specified property
exists, but is not mappedpublic org.apache.commons.beanutils.DynaClass getDynaClass()
DynaClass
instance that describes the set of
properties available for this DynaBean.
getDynaClass
in interface org.apache.commons.beanutils.DynaBean
public void remove(String name, String key)
remove
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property for which a value is to
be removedkey
- Key of the value to be removed
IllegalArgumentException
- if there is no property
of the specified namepublic void set(String name, Object value)
set
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property whose value is to be setvalue
- Value to which this property is to be set
org.apache.commons.beanutils.ConversionException
- if the specified value cannot be
converted to the type required for this property
IllegalArgumentException
- if there is no property
of the specified name
NullPointerException
- if an attempt is made to set a
primitive property to nullpublic void set(String name, int index, Object value)
set
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property whose value is to be setindex
- Index of the property to be setvalue
- Value to which this property is to be set
org.apache.commons.beanutils.ConversionException
- if the specified value cannot be
converted to the type required for this property
IllegalArgumentException
- if there is no property
of the specified name
IllegalArgumentException
- if the specified property
exists, but is not indexed
IndexOutOfBoundsException
- if the specified index
is outside the range of the underlying propertypublic void set(String name, String key, Object value)
set
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property whose value is to be setkey
- Key of the property to be setvalue
- Value to which this property is to be set
org.apache.commons.beanutils.ConversionException
- if the specified value cannot be
converted to the type required for this property
IllegalArgumentException
- if there is no property
of the specified name
IllegalArgumentException
- if the specified property
exists, but is not mappedpublic String toString()
BasePrimary
toString
in class BasePrimary
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |