Modifier and Type	Class and Description
public class	Tstamp.CustomFormat This nested element that allows a property to be set to the current date and time in a given format.
public static class	Tstamp.Unit set of valid units to use for time offsets.

Modifier and Type	Field and Description
private List<Tstamp.CustomFormat>	customFormats
private static final String	ENV_SOURCE_DATE_EPOCH
private String	prefix

Access	Constructor and Description
public	Tstamp()

Method Summary

Modifier and Type	Method and Description
public Tstamp.CustomFormat	Returns: a ready to fill-in format createFormat() create a custom format with the current prefix.
public void	execute() Overrides org.apache.tools.ant.Task.execute. create the timestamps.
protected Date	Returns: Date getNow() Return the `Date` instance to use as base for DSTAMP, TSTAMP and TODAY.
protected Optional<Date>	Returns: Optional containing the Date or null getNow(String name of the property to check propertyName, Function<String, Date> conversion of the property value as string to Date map, BiFunction<String, String, String> supplier of the log message containing the property name and value if the conversion fails log) Checks and returns a Date if the specified property is set.
public void	setPrefix(String the prefix to use. prefix) Set a prefix for the properties.
private void	setProperty(String name, String value) helper that encapsulates prefix logic and property setting policy (i.e. we use setNewProperty instead of setProperty).

customFormats	back to summary
private List<Tstamp.CustomFormat> customFormats

ENV_SOURCE_DATE_EPOCH	back to summary
private static final String ENV_SOURCE_DATE_EPOCH

prefix	back to summary
private String prefix

Constructor Detail

Tstamp	back to summary
public Tstamp()

Method Detail

createFormat	back to summary
public Tstamp.CustomFormat createFormat() create a custom format with the current prefix. Returns:Tstamp.CustomFormat a ready to fill-in format

createFormat

back to summary

public Tstamp.CustomFormat createFormat()

create a custom format with the current prefix.

Returns:Tstamp.CustomFormat: a ready to fill-in format

execute	back to summary
public void execute() throws BuildException Overrides org.apache.tools.ant.Task.execute. create the timestamps. Custom ones are done before the standard ones, to get their retaliation in early. Annotations @Override Exceptions BuildException: on error.

execute

back to summary

public void execute() throws BuildException

Overrides org.apache.tools.ant.Task.execute.

create the timestamps. Custom ones are done before the standard ones, to get their retaliation in early.

Annotations

@Override

Exceptions

BuildException:: on error.

getNow back to summary

getNow	back to summary
protected Date getNow() Return the `Date` instance to use as base for DSTAMP, TSTAMP and TODAY. Returns:Date Date

protected Date getNow()

Return the Date instance to use as base for DSTAMP, TSTAMP and TODAY.

Returns:Date: Date

getNow	back to summary
protected Optional<Date> getNow(String propertyName, Function<String, Date> map, BiFunction<String, String, String> log) Checks and returns a Date if the specified property is set. Parameters propertyName:String name of the property to check map:Function<String, Date> conversion of the property value as string to Date log:BiFunction<String, String, String> supplier of the log message containing the property name and value if the conversion fails Returns:Optional<Date> Optional containing the Date or null

getNow

back to summary

protected Optional<Date> getNow(String propertyName, Function<String, Date> map, BiFunction<String, String, String> log)

Checks and returns a Date if the specified property is set.

Parameters

propertyName:String: name of the property to check
map:Function<String, Date>: conversion of the property value as string to Date
log:BiFunction<String, String, String>: supplier of the log message containing the property name and value if the conversion fails

Returns:Optional<Date>

Optional containing the Date or null

setPrefix	back to summary
public void setPrefix(String prefix) Set a prefix for the properties. If the prefix does not end with a "." one is automatically added. Parameters prefix:String the prefix to use. Since Ant 1.5

setPrefix

back to summary

public void setPrefix(String prefix)

Set a prefix for the properties. If the prefix does not end with a "." one is automatically added.

Parameters

prefix:String: the prefix to use.

Since

Ant 1.5

setProperty	back to summary
private void setProperty(String name, String value) helper that encapsulates prefix logic and property setting policy (i.e. we use setNewProperty instead of setProperty).

org.apache.tools.ant.taskdefs back to summary

public Class Tstamp.CustomFormat

Class Inheritance

extends Object

java.lang.Object
org.apache.tools.ant.taskdefs.Tstamp.CustomFormat

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.

Field Summary

Modifier and Type	Field and Description
private String	country
private int	field
private String	language
private int	offset
private String	pattern
private String	propertyName
private TimeZone	timeZone
private String	variant

Constructor Summary

Access	Constructor and Description
public	CustomFormat()

Method Summary

Modifier and Type	Method and Description
public void	execute(Project project to set property in. project, Date date to use as a starting point. date, Location line in file (for errors) location) validate parameter and execute the format.
public void	setLocale(String the locale to use. locale) The locale used to create date/time string.
public void	setOffset(int the offset to use. offset) The numeric offset to the current time.
public void	setPattern(String the pattern to use. pattern) The date/time pattern to be used.
public void	setProperty(String the name of the property. propertyName) The property to receive the date/time string in the given pattern
public void	setTimezone(String the timezone value. id) The timezone to use for displaying time.
public void	setUnit(String the unit to use. unit) Deprecated since 1.5.x. Set the unit type (using String).
public void	setUnit(Tstamp.Unit the unit to use. unit) The unit of the offset to be applied to the current time.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

country	back to summary
private String country

field	back to summary
private int field

language	back to summary
private String language

offset	back to summary
private int offset

pattern	back to summary
private String pattern

propertyName	back to summary
private String propertyName

timeZone	back to summary
private TimeZone timeZone

variant	back to summary
private String variant

Constructor Detail

CustomFormat	back to summary
public CustomFormat()

Method Detail

execute	back to summary
public void execute(Project project, Date date, Location location) validate parameter and execute the format. Parameters project:Project project to set property in. date:Date date to use as a starting point. location:Location line in file (for errors)

execute

back to summary

public void execute(Project project, Date date, Location location)

validate parameter and execute the format.

Parameters

project:Project: project to set property in.
date:Date: date to use as a starting point.
location:Location: line in file (for errors)

setLocale back to summary

setLocale	back to summary
public void setLocale(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:String the locale to use. See Also `java.util.Locale`

public void setLocale(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:String: the locale to use.

See Also

java.util.Locale

setOffset	back to summary
public void setOffset(int offset) The numeric offset to the current time. Parameters offset:int the offset to use.

setOffset

back to summary

public void setOffset(int offset)

The numeric offset to the current time.

Parameters

offset:int: the offset to use.

setPattern back to summary

setPattern	back to summary
public void setPattern(String pattern) The date/time pattern to be used. The values are as defined by the Java SimpleDateFormat class. Parameters pattern:String the pattern to use. See Also `java.text.SimpleDateFormat`

public void setPattern(String pattern)

The date/time pattern to be used. The values are as defined by the Java SimpleDateFormat class.

Parameters

pattern:String: the pattern to use.

See Also

java.text.SimpleDateFormat

setProperty	back to summary
public void setProperty(String propertyName) The property to receive the date/time string in the given pattern Parameters propertyName:String the name of the property.

setProperty

back to summary

public void setProperty(String propertyName)

The property to receive the date/time string in the given pattern

Parameters

propertyName:String: the name of the property.

setTimezone back to summary

setTimezone	back to summary
public void setTimezone(String id) The timezone to use for displaying time. The values are as defined by the Java TimeZone class. Parameters id:String the timezone value. See Also `java.util.TimeZone`

public void setTimezone(String id)

The timezone to use for displaying time. The values are as defined by the Java TimeZone class.

Parameters

id:String: the timezone value.

See Also

java.util.TimeZone

setUnit	back to summary
public void setUnit(String unit) Deprecated 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:String the unit to use. Annotations @Deprecated

setUnit

back to summary

public void setUnit(String unit)

Deprecated

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:String: the unit to use.

Annotations

@Deprecated

setUnit	back to summary
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 The default unit is day. Parameters unit:Tstamp.Unit the unit to use.

setUnit

back to summary

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

The default unit is day.

Parameters

unit:Tstamp.Unit: the unit to use.

org.apache.tools.ant.taskdefs back to summary

public Class Tstamp.Unit

Class Inheritance

extends EnumeratedAttribute

java.lang.Object
org.apache.tools.ant.types.EnumeratedAttribute
org.apache.tools.ant.taskdefs.Tstamp.Unit

set of valid units to use for time offsets.

Field Summary

Modifier and Type	Field and Description
private Map<String, Integer>	calendarFields
private static final String	DAY
private static final String	HOUR
private static final String	MILLISECOND
private static final String	MINUTE
private static final String	MONTH
private static final String	SECOND
private static final String[]	UNITS
private static final String	WEEK
private static final String	YEAR

Inherited from org.apache.tools.ant.types.EnumeratedAttribute:: value

Constructor Summary

Access	Constructor and Description
public	Unit() Constructor for Unit enumerated type.

Method Summary

Modifier and Type	Method and Description
public int	Returns: an int value. getCalendarField() Convert the value to int unit value.
public String[]	Returns: the value values. getValues() Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues. Get the valid values.

Inherited from org.apache.tools.ant.types.EnumeratedAttribute:: containsValue getIndex getInstance getValue indexOfValue setValue toString

Field Detail

calendarFields	back to summary
private Map<String, Integer> calendarFields

DAY	back to summary
private static final String DAY

HOUR	back to summary
private static final String HOUR

MILLISECOND	back to summary
private static final String MILLISECOND

MINUTE	back to summary
private static final String MINUTE

MONTH	back to summary
private static final String MONTH

SECOND	back to summary
private static final String SECOND

UNITS	back to summary
private static final String[] UNITS

WEEK	back to summary
private static final String WEEK

YEAR	back to summary
private static final String YEAR

Constructor Detail

Unit	back to summary
public Unit() Constructor for Unit enumerated type.

Method Detail

getCalendarField	back to summary
public int getCalendarField() Convert the value to int unit value. Returns:int an int value.

getCalendarField

back to summary

public int getCalendarField()

Convert the value to int unit value.

Returns:int: an int value.

getValues	back to summary
public String[] getValues() Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues. Get the valid values. Returns:String[] the value values. Annotations @Override

getValues

back to summary

public String[] getValues()

Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues.

Get the valid values.

Returns:String[]

the value values.

Annotations

@Override

public Class Tstamp

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Tstamp.CustomFormat

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Tstamp.Unit

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail