org.apache.tools.ant.taskdefs.optional.perforce

Class P4Counter

public class P4Counter extends P4Base

Obtains or sets the value of a counter.

When used in its base form (where only the counter name is provided), the counter value will be printed to the output stream. When the value is provided, the counter will be set to the value provided. When a property name is provided, the property will be filled with the value of the counter. You may not specify to both get and set the value of the counter in the same Task.

The user performing this task must have Perforce "review" permissions as defined by Perforce protections in order for this task to succeed.

Example Usage:
<p4counter name="${p4.counter}" property=${p4.change}"/>

UNKNOWN: category="scm"

Field Summary
Stringcounter
name of the counter
Stringproperty
name of an optional property
booleanshouldSetProperty
flag telling whether a property should be set
booleanshouldSetValue
flag telling whether the value of the counter should be set
intvalue
new value for the counter
Method Summary
voidexecute()
again, properties are mutable in this tsk
voidsetName(String counter)
The name of the counter; required
voidsetProperty(String property)
A property to be set with the value of the counter
voidsetValue(int value)
The new value for the counter; optional.

Field Detail

counter

public String counter
name of the counter

property

public String property
name of an optional property

shouldSetProperty

public boolean shouldSetProperty
flag telling whether a property should be set

shouldSetValue

public boolean shouldSetValue
flag telling whether the value of the counter should be set

value

public int value
new value for the counter

Method Detail

execute

public void execute()
again, properties are mutable in this tsk

Throws: BuildException if the required parameters are not supplied.

setName

public void setName(String counter)
The name of the counter; required

Parameters: counter name of the counter

setProperty

public void setProperty(String property)
A property to be set with the value of the counter

Parameters: property the name of a property to set with the value of the counter

setValue

public void setValue(int value)
The new value for the counter; optional.

Parameters: value new value for the counter