Class Tstamp

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.Tstamp

All Implemented Interfaces:

Cloneable

public class Tstamp
extends Task

Sets properties to the current time, or offsets from the current time. The default properties are TSTAMP, DSTAMP and TODAY;

Since:

Ant 1.1

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class Task

target, taskName, taskType, wrapper

Modifier and Type	Field	Description
protected Target	target	Deprecated. since 1.6.x.
protected String	taskName	Deprecated. since 1.6.x.
protected String	taskType	Deprecated. since 1.6.x.
protected RuntimeConfigurable	wrapper	Deprecated. since 1.6.x.

Fields inherited from class ProjectComponent

description, location, project

Modifier and Type	Field	Description
protected String	description	Deprecated. since 1.6.x.
protected Location	location	Deprecated. since 1.6.x.
protected Project	project	Deprecated. since 1.6.x.

Constructor Summary

Constructors

Constructor	Description
Tstamp()

Method Summary

Modifier and Type	Method	Description
Tstamp.CustomFormat	createFormat()	create a custom format with the current prefix.
void	execute()	create the timestamps.
protected Date	getNow()	Return the Date instance to use as base for DSTAMP, TSTAMP and TODAY.
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.
void	setPrefix(String prefix)	Set a prefix for the properties.

Methods inherited from class Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Modifier and Type	Method	Description
final void	bindToOwner(Task owner)	Bind a task to another; use this when configuring a newly created task to do work on behalf of another.
Target	getOwningTarget()	Returns the container target of this task.
RuntimeConfigurable	getRuntimeConfigurableWrapper()	Returns the wrapper used for runtime configuration.
String	getTaskName()	Returns the name to use in logging messages.
String	getTaskType()	Return the type of task.
protected RuntimeConfigurable	getWrapper()	Return the runtime configurable structure for this task.
protected void	handleErrorFlush(String output)	Handles an error line by logging it with the WARN priority.
protected void	handleErrorOutput(String output)	Handles an error output by logging it with the WARN priority.
protected void	handleFlush(String output)	Handles output by logging it with the INFO priority.
protected int	handleInput(byte[] buffer, int offset, int length)	Handle an input request by this task.
protected void	handleOutput(String output)	Handles output by logging it with the INFO priority.
void	init()	Called by the project to let the task initialize properly.
protected final boolean	isInvalid()	Has this task been marked invalid?
void	log(String msg)	Logs a message with the default (INFO) priority.
void	log(String msg, int msgLevel)	Logs a message with the given priority.
void	log(String msg, Throwable t, int msgLevel)	Logs a message with the given priority.
void	log(Throwable t, int msgLevel)	Logs a message with the given priority.
void	maybeConfigure()	Configures this task - if it hasn't been done already.
final void	perform()	Performs this task if it's still valid, or gets a replacement version and performs that otherwise.
void	reconfigure()	Force the task to be reconfigured from its RuntimeConfigurable.
void	setOwningTarget(Target target)	Sets the target container of this task.
void	setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)	Sets the wrapper to be used for runtime configuration.
void	setTaskName(String name)	Sets the name to use in logging messages.
void	setTaskType(String type)	Sets the name with which the task has been invoked.

Methods inherited from class ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Modifier and Type	Method	Description
Object	clone()
String	getDescription()	Returns the description of the current action.
Location	getLocation()	Returns the file/location where this task was defined.
Project	getProject()	Returns the project to which this component belongs.
void	setDescription(String desc)	Sets a description of the current action.
void	setLocation(Location location)	Sets the file/location where this task was defined.
void	setProject(Project project)	Sets the project object of this component.

Methods inherited from class Object

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

Constructor Details

Tstamp

public Tstamp()

Method Details

setPrefix

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 - the prefix to use.

Since:

Ant 1.5

execute

public void execute()
             throws BuildException

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

Overrides:

execute in class Task

Throws:

BuildException - on error.

createFormat

public Tstamp.CustomFormat createFormat()

create a custom format with the current prefix.

Returns:

a ready to fill-in format

getNow

protected Date getNow()

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

Returns:

Date

getNow

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 - name of the property to check

map - conversion of the property value as string to Date

log - supplier of the log message containing the property name and value if the conversion fails

Returns:

Optional containing the Date or null