org.oddjob.values.types

Class FormatType

java.lang.Object

org.oddjob.values.types.FormatType

All Implemented Interfaces:

java.io.Serializable, ArooaValue

public class FormatType
extends java.lang.Object
implements ArooaValue, java.io.Serializable

Description

A type which can either format a number or a date into the given text format.

Form more information on the number format see DecimalFormat

For more information on the date format see SimpleDateFormat

Example

Formatting a date and number to create a file name.

<oddjob>
    <job>
        <sequential>
            <jobs>
                <variables id="vars">
                    <businessDate>
                        <format format="yyyyMMdd" date="2005-12-25"/>
                    </businessDate>
                    <sequence>
                        <format format="000000" number="123"/>
                    </sequence>
                </variables>
                <exists id="file-check" file="Data-${vars.businessDate}-${vars.sequence}.dat"/>
            </jobs>
        </sequential>
    </job>
</oddjob>

Example

Format the current time as a property.

<oddjob>
    <job>
        <sequential>
            <jobs>
                <properties>
                    <values>
                        <date date="NOW" key="date-time.now">
                            <clock>
                                <value value="${our-clock}"/>
                            </clock>
                        </date>
                        <format date="${date-time.now}" format="h:mm a" key="time.now.formatted"/>
                    </values>
                </properties>
                <echo>The time is ${time.now.formatted}.</echo>
            </jobs>
        </sequential>
    </job>
</oddjob>

Note that the our-clock reference is provided for the tests but when not provided (if this is run as is) the current time is used.

An example of the output is:

The time is 8:17 AM.

See Also:

Serialized Form

Author:

Rob Gordon.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FormatType.Conversions

Constructor Summary

Constructors

Constructor and Description
FormatType()

Method Summary

Modifier and Type	Method and Description
void	setDate(java.util.Date date)
void	setFormat(java.lang.String format)
void	setNumber(java.lang.Number number)
void	setTimeZone(java.lang.String timeZoneId)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatType

public FormatType()

Method Detail

setDate

public void setDate(java.util.Date date)

setFormat

public void setFormat(java.lang.String format)

setTimeZone

public void setTimeZone(java.lang.String timeZoneId)

setNumber

public void setNumber(java.lang.Number number)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object