<BODY BGCOLOR="white" onload="asd();">

P4Edit (Apache Ant API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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


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.P4Edit

public class P4Edit
extends P4Base

Open file(s) for edit. P4Change should be used to obtain a new changelist for P4Edit as, although P4Edit can open files to the default change, P4Submit cannot yet submit to it. Example Usage:
<p4edit change="${p4.change}" view="//depot/project/foo.txt" />

Author:: Les Hughes
To do:: Should call reopen if file is already open in one of our changelists perhaps?

Field Summary

java.lang.String change


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

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

P4Edit()


Method Summary

void execute()
          Called by the project to let the task do its work.

void setChange(java.lang.String change)
          An existing changelist number to assign files to; optional but strongly recommended.

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, setDescription, 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

change


public java.lang.String change

Constructor Detail

P4Edit


public P4Edit()

Method Detail

setChange


public void setChange(java.lang.String change)

An existing changelist number to assign files to; optional but strongly recommended.

execute


public void execute()
             throws BuildException

Description copied from class: Task

Called by the project to let the task do its work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running "ant target1 target2" will run all tasks in target3 twice.

Overrides:: execute in class Task

Throws:: BuildException - if something goes wrong with the build