Package com.perforce.p4java.admin

Interface ITriggerEntry

All Superinterfaces:

IMapEntry

All Known Implementing Classes:

TriggerEntry

public interface ITriggerEntry
extends IMapEntry

Describes a protection entry (line) in a Perforce triggers table. These are described in more detail in the various main Perforce admin documentation pages.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ITriggerEntry.TriggerType

Nested classes/interfaces inherited from interface com.perforce.p4java.core.IMapEntry

IMapEntry.EntryType

Field Summary

Fields inherited from interface com.perforce.p4java.core.IMapEntry

ORDER_UNKNOWN

Method Summary

Modifier and Type	Method	Description
String	getCommand()	Gets the trigger command.
String	getName()	Gets the trigger name.
String	getPath()	For change and submit triggers, a file pattern to match files in the changelist.
ITriggerEntry.TriggerType	getTriggerType()	Gets the trigger type.
void	setCommand(String command)	Sets the trigger command.
void	setName(String name)	Sets the trigger name.
void	setPath(String path)	For change and submit triggers, a file pattern to match files in the changelist.
void	setTriggerType(ITriggerEntry.TriggerType type)	Sets the trigger type.

Methods inherited from interface com.perforce.p4java.core.IMapEntry

getComment, getComment, getLeft, getLeft, getOrder, getRight, getRight, getType, setComment, setLeft, setOrder, setRight, setType, toString, toString

Method Details

getName

String getName()

Gets the trigger name.

Returns:

the trigger name

setName

void setName(String name)

Sets the trigger name.

Parameters:

name - the trigger name

getTriggerType

ITriggerEntry.TriggerType getTriggerType()

Gets the trigger type.

Returns:

the trigger type

setTriggerType

void setTriggerType(ITriggerEntry.TriggerType type)

Sets the trigger type.

Parameters:

type - the trigger type

getPath

String getPath()

For change and submit triggers, a file pattern to match files in the changelist. This file pattern can be an exclusion mapping (-pattern), to exclude files. For form triggers, the name of the form (branch, client, etc). For fix triggers 'fix' is required as the path value. For authentication triggers, 'auth' is required as the path value. For archive triggers, a file pattern to match the name of the file being accessed in the archive. Note that, due to lazy copying when branching files, the name of the file in the archive can not be the same as the name of the file in the depot. For command triggers, use the name of the command to match, e.g. 'pre-user-$cmd' or a regular expression, e.g. '(pre|post)-user-add'. *

Returns:

the depot file path pattern or form type

setPath

void setPath(String path)

For change and submit triggers, a file pattern to match files in the changelist. This file pattern can be an exclusion mapping (-pattern), to exclude files. For form triggers, the name of the form (branch, client, etc). For fix triggers 'fix' is required as the path value. For authentication triggers, 'auth' is required as the path value. For archive triggers, a file pattern to match the name of the file being accessed in the archive. Note that, due to lazy copying when branching files, the name of the file in the archive can not be the same as the name of the file in the depot. For command triggers, use the name of the command to match, e.g. 'pre-user-$cmd' or a regular expression, e.g. '(pre|post)-user-add'. *

Parameters:

path - the depot file path pattern or form type

getCommand

String getCommand()

Gets the trigger command. If the command contains spaces, enclose it in double quotes.

Returns:

the trigger comamnd

setCommand

void setCommand(String command)

Sets the trigger command. If the command contains spaces, enclose it in double quotes.

Parameters:

command - the trigger command