org.oddjob.arooa.types

Class ConvertType<T>

java.lang.Object

org.oddjob.arooa.types.ConvertType<T>

Type Parameters:

T -

All Implemented Interfaces:

ArooaValue, ArooaSessionAware

public class ConvertType<T>
extends java.lang.Object
implements ArooaValue, ArooaSessionAware

Description

Convert a value to the given Java Class. Most of the time Oddjob's own automatic conversions are fine for setting job properties but occasionally it can be useful to force a conversion to a different type.

This type uses Oddjob's internal converters itself to perform the conversion.

The is property can provide direct access to the converted value. This can be useful for gaining access to a Java type from Oddjob's wrapper types.

Example

Convert a delimited list to an array of Strings.

<oddjob id="this">
    <job>
        <foreach>
            <values>
                <convert>
                    <to>
                        <class name="[Ljava.lang.String;"/>
                    </to>
                    <value>
                        <value value="&quot;grapes, red&quot;, &quot;grapes, white&quot;, gratefruit"/>
                    </value>
                </convert>
            </values>
            <configuration>
                <xml>
                    <foreach id="loop">
                        <job>
                            <echo>${loop.current}</echo>
                        </job>
                    </foreach>
                </xml>
            </configuration>
        </foreach>
    </job>
</oddjob>

The output is:

grapes, red
grapes, white
gratefruit

Example

Demonstrate the use of the is property.

<oddjob id="this">
    <job>
        <sequential>
            <jobs>
                <variables id="vars">
                    <aNumber>
                        <convert>
                            <to>
                                <class name="java.lang.Integer"/>
                            </to>
                            <value>
                                <value value="42"/>
                            </value>
                        </convert>
                    </aNumber>
                </variables>
                <echo>${vars.aNumber}
${vars.aNumber.class}
${vars.aNumber.value}
${vars.aNumber.value.class}
${vars.aNumber.is}
${vars.aNumber.is.class}</echo>
            </jobs>
        </sequential>
    </job>
</oddjob>

The output is:

42
class org.oddjob.arooa.types.ConvertType
42
class org.oddjob.arooa.types.ValueType
42
class java.lang.Integer

Author:

rob

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConvertType.Conversions

Field Summary

Fields

Modifier and Type	Field and Description
static ArooaElement	ELEMENT

Constructor Summary

Constructors

Constructor and Description
ConvertType()

Method Summary

Modifier and Type	Method and Description
void	configured()
T	convert() Proivde the conversion.
java.lang.Object	getIs()
java.lang.Class<T>	getTo()
ArooaValue	getValue()
void	setArooaSession(ArooaSession session) Accept the current Arooa Session.
void	setTo(java.lang.Class<T> to)
void	setValue(ArooaValue from)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT

public static final ArooaElement ELEMENT

Constructor Detail

ConvertType

public ConvertType()

Method Detail

setArooaSession

public void setArooaSession(ArooaSession session)

Description copied from interface: ArooaSessionAware

Accept the current Arooa Session.

Specified by:

setArooaSession in interface ArooaSessionAware

Parameters:

session - The Arooa Session. Never null.

configured

public void configured()
                throws NoConversionAvailableException,
                       ConversionFailedException

Throws:

NoConversionAvailableException

ConversionFailedException

convert

public T convert()
          throws NoConversionAvailableException,
                 ConversionFailedException

Proivde the conversion.

Returns:

Throws:

ConversionFailedException

NoConversionAvailableException

getTo

public java.lang.Class<T> getTo()

setTo

public void setTo(java.lang.Class<T> to)

getValue

public ArooaValue getValue()

setValue

public void setValue(ArooaValue from)

getIs

public java.lang.Object getIs()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object