|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
org.apache.tools.ant.taskdefs
Class Tstamp.CustomFormat
java.lang.Object | +--org.apache.tools.ant.taskdefs.Tstamp.CustomFormat
- Enclosing class:
- Tstamp
- public class Tstamp.CustomFormat
- extends java.lang.Object
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 Summary | |
Tstamp.CustomFormat()
Create a format |
|
| Method Summary | |
void |
execute(Project project,
java.util.Date date,
Location location)
validate parameter and execute the format |
void |
setLocale(java.lang.String locale)
The locale used to create date/time string. |
void |
setOffset(int offset)
The numeric offset to the current time. |
void |
setPattern(java.lang.String pattern)
The date/time pattern to be used. |
void |
setProperty(java.lang.String propertyName)
The property to receive the date/time string in the given pattern |
void |
setTimezone(java.lang.String id)
The timezone to use for displaying time. |
void |
setUnit(java.lang.String unit)
Deprecated. 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. |
void |
setUnit(Tstamp.Unit unit)
The unit of the offset to be applied to the current time. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
Tstamp.CustomFormat
public Tstamp.CustomFormat()
- Create a format
| Method Detail |
setProperty
public void setProperty(java.lang.String propertyName)
- The property to receive the date/time string in the given pattern
- Parameters:
propertyName-
setPattern
public void setPattern(java.lang.String pattern)
- The date/time pattern to be used. The values are as
defined by the Java SimpleDateFormat class.
- Parameters:
pattern-- See Also:
SimpleDateFormat
setLocale
public void setLocale(java.lang.String locale)
- The 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-- See Also:
Locale
setTimezone
public void setTimezone(java.lang.String id)
- The timezone to use for displaying time.
The values are as defined by the Java TimeZone class.
- Parameters:
id-- See Also:
TimeZone
setOffset
public void setOffset(int offset)
- The numeric offset to the current time.
- Parameters:
offset-
setUnit
public void setUnit(java.lang.String unit)
- Deprecated. 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.
setUnit
public void setUnit(Tstamp.Unit unit)
- The unit of the offset to be applied to the current time.
Valid Values are
- millisecond
- second
- minute
- hour
- day
- week
- month
- year
- Parameters:
unit-
execute
public void execute(Project project, java.util.Date date, Location location)
- validate parameter and execute the format
- Parameters:
project- project to set property indate- date to use as a starting pointlocation- line in file (for errors)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright © 2000-2002 Apache Software Foundation. All Rights Reserved.