Package org.apache.tools.ant.taskdefs
Class Tstamp.CustomFormat
java.lang.Object
org.apache.tools.ant.taskdefs.Tstamp.CustomFormat
- Enclosing class:
- Tstamp
This nested element that allows a property to be set
 to the current date and time in a given format.
 The date/time patterns are as defined in the
 Java SimpleDateFormat class.
 The format element also allows offsets to be applied to
 the time to generate different time values.
- To do:
- consider refactoring out into a re-usable element.
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidvalidate parameter and execute the format.voidThe locale used to create date/time string.voidsetOffset(int offset) The numeric offset to the current time.voidsetPattern(String pattern) The date/time pattern to be used.voidsetProperty(String propertyName) The property to receive the date/time string in the given patternvoidsetTimezone(String id) The timezone to use for displaying time.voidDeprecated.since 1.5.x.voidsetUnit(Tstamp.Unit unit) The unit of the offset to be applied to the current time.
- 
Constructor Details- 
CustomFormatpublic CustomFormat()
 
- 
- 
Method Details- 
setPropertyThe property to receive the date/time string in the given pattern- Parameters:
- propertyName- the name of the property.
 
- 
setPatternThe date/time pattern to be used. The values are as defined by the Java SimpleDateFormat class.- Parameters:
- pattern- the pattern to use.
- See Also:
 
- 
setLocaleThe locale used to create date/time string. The general form is "language, country, variant" but either variant or variant and country may be omitted. For more information please refer to documentation for the java.util.Locale class.- Parameters:
- locale- the locale to use.
- See Also:
 
- 
setTimezoneThe timezone to use for displaying time. The values are as defined by the Java TimeZone class.- Parameters:
- id- the timezone value.
- See Also:
 
- 
setOffsetpublic void setOffset(int offset) The numeric offset to the current time.- Parameters:
- offset- the offset to use.
 
- 
setUnitDeprecated.since 1.5.x. setUnit(String) is deprecated and is replaced with setUnit(Tstamp.Unit) to make Ant's Introspection mechanism do the work and also to encapsulate operations on the unit in its own class.Set the unit type (using String).- Parameters:
- unit- the unit to use.
 
- 
setUnitThe unit of the offset to be applied to the current time. Valid Values are- millisecond
- second
- minute
- hour
- day
- week
- month
- year
 - Parameters:
- unit- the unit to use.
 
- 
executevalidate parameter and execute the format.- Parameters:
- project- project to set property in.
- date- date to use as a starting point.
- location- line in file (for errors)
 
 
-