public class P4Counter extends P4Base
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:Modifier and Type | Field and Description |
---|---|
java.lang.String |
counter
name of the counter
|
java.lang.String |
property
name of an optional property
|
boolean |
shouldSetProperty
flag telling whether a property should be set
|
boolean |
shouldSetValue
flag telling whether the value of the counter should be set
|
int |
value
new value for the counter
|
failOnError, P4Client, P4CmdOpts, P4Opts, P4Port, P4User, P4View, shell, util
description, location, project
Constructor and Description |
---|
P4Counter() |
Modifier and Type | Method and Description |
---|---|
void |
execute()
again, properties are mutable in this tsk
|
void |
setName(java.lang.String counter)
The name of the counter; required
|
void |
setProperty(java.lang.String property)
A property to be set with the value of the counter
|
void |
setValue(int value)
The new value for the counter; optional.
|
execP4Command, execP4Command, getErrorMessage, getInError, init, setClient, setCmdopts, setErrorMessage, setFailonerror, setGlobalopts, setInError, setPort, setUser, setView
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
public java.lang.String counter
public java.lang.String property
public boolean shouldSetValue
public boolean shouldSetProperty
public int value
public void setName(java.lang.String counter)
counter
- name of the counterpublic void setValue(int value)
value
- new value for the counterpublic void setProperty(java.lang.String property)
property
- the name of a property to set with the value
of the counterpublic void execute() throws BuildException
execute
in class Task
BuildException
- if the required parameters are not supplied.