P4Change (Apache Ant API)

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


java.lang.Object

  |

  +--org.apache.tools.ant.ProjectComponent

        |

        +--org.apache.tools.ant.Task

              |

              +--org.apache.tools.ant.taskdefs.optional.perforce.P4Base

                    |

                    +--org.apache.tools.ant.taskdefs.optional.perforce.P4Change


public class P4Change
extends P4Base

Requests a new changelist from the Perforce server. P4Change creates a new changelist in perforce. P4Change sets the property ${p4.change} with the new changelist number. This should then be passed into p4edit and p4submit.

Author:
Les Hughes
See Also:
P4Edit, P4Submit

Field Summary
protected  java.lang.String description
           
protected  java.lang.String emptyChangeList
           
 
Fields inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
failOnError, P4Client, P4CmdOpts, P4Opts, P4Port, P4User, P4View, shell, util
 
Fields inherited from class org.apache.tools.ant.Task
location, target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
project
 
Constructor Summary
P4Change()
           
 
Method Summary
static java.lang.String backslash(java.lang.String value)
          Ensure that a string is backslashing slashes so that it does not confuse them with Perl substitution delimiter in Oro.
 void execute()
          throw all immutability rules to the wind
 java.lang.String getEmptyChangeList()
           
 void setDescription(java.lang.String desc)
          Description for ChangeList;optional.
 
Methods inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
execP4Command, execP4Command, init, setClient, setCmdopts, setFailonerror, setPort, setUser, setView
 
Methods inherited from class org.apache.tools.ant.Task
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorOutput, handleOutput, isInvalid, log, log, maybeConfigure, perform, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
getProject, setProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

emptyChangeList


protected java.lang.String emptyChangeList

description


protected java.lang.String description
Constructor Detail

P4Change


public P4Change()
Method Detail

execute


public void execute()
             throws BuildException
throw all immutability rules to the wind

Overrides:
execute in class Task
Throws:
BuildException - if something goes wrong with the build

getEmptyChangeList


public java.lang.String getEmptyChangeList()
                                    throws BuildException
BuildException

backslash


public static final java.lang.String backslash(java.lang.String value)
Ensure that a string is backslashing slashes so that it does not confuse them with Perl substitution delimiter in Oro. Backslashes are always backslashes in a string unless they escape the delimiter.

Parameters:
value - the string to backslash for slashes
Returns:
the backslashed string
See Also:
< a href="http://jakarta.apache.org/oro/api/org/apache/oro/text/perl/Perl5Util.html#substitute(java.lang.String,%20java.lang.String)">Oro

setDescription


public void setDescription(java.lang.String desc)
Description for ChangeList;optional. If none is specified, it will default to "AutoSubmit By Ant"

Overrides:
setDescription in class Task
Parameters:
desc - Description of the current action. May be null, indicating that no description is available.


Copyright 2000-2002 Apache Software Foundation. All Rights Reserved.