P4JFileAction (P4Java API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

com.perforce.p4java.core.file
Enum P4JFileAction

java.lang.Object
  java.lang.Enum<P4JFileAction>
      com.perforce.p4java.core.file.P4JFileAction

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<P4JFileAction>

public enum P4JFileAction
extends java.lang.Enum<P4JFileAction>
extends java.lang.Enum<P4JFileAction>

Defines the possible Perforce actions that can be associated with a Perforce file, including synchronization actions. Also used to indicate open status for files on pending changelists, etc.

Basically self-explanatory if you have much experience with Perforce, but if not, the main Perforce documentation goes into great detail about each of these actions.

Version:: $Id$

Enum Constant Summary
`ABANDONED`
`ADD`
`ADDED`
`BRANCH`
`DELETE`
`EDIT`
`EDIT_IGNORED`
`IGNORED`
`INTEGRATE`
`MOVE`
`MOVE_ADD`
`MOVE_DELETE`
`REFRESHED`
`SYNC`
`UPDATED`

Method Summary
`static P4JFileAction`	`fromString(java.lang.String str)` A user-friendly fail-safe way to convert from strings to file actions without generating exceptions, etc.
`java.lang.String`	`toString()`
`static P4JFileAction`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static P4JFileAction[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Enum Constant Detail

ADD

public static final P4JFileAction ADD

BRANCH

public static final P4JFileAction BRANCH

EDIT

public static final P4JFileAction EDIT

INTEGRATE

public static final P4JFileAction INTEGRATE

DELETE

public static final P4JFileAction DELETE

SYNC

public static final P4JFileAction SYNC

UPDATED

public static final P4JFileAction UPDATED

ADDED

public static final P4JFileAction ADDED

REFRESHED

public static final P4JFileAction REFRESHED

IGNORED

public static final P4JFileAction IGNORED

ABANDONED

public static final P4JFileAction ABANDONED

EDIT_IGNORED

public static final P4JFileAction EDIT_IGNORED

MOVE

public static final P4JFileAction MOVE

MOVE_ADD

public static final P4JFileAction MOVE_ADD

MOVE_DELETE

public static final P4JFileAction MOVE_DELETE

Method Detail

values

public static P4JFileAction[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (P4JFileAction c : P4JFileAction.values())
    System.out.println(c);

Returns:: an array containing the constants of this enum type, in the order they are declared

valueOf

public static P4JFileAction valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:: name - the name of the enum constant to be returned.
Returns:: the enum constant with the specified name
Throws:: java.lang.IllegalArgumentException - if this enum type has no constant with the specified name; java.lang.NullPointerException - if the argument is null

fromString

public static P4JFileAction fromString(java.lang.String str)

A user-friendly fail-safe way to convert from strings to file actions without generating exceptions, etc.

Parameters:: str - upper, lower, or mixed-case candidate string, or null
Returns:: null if no match or if str was null, otherwise returns the closest matching file action

toString

public java.lang.String toString()

Overrides:: toString in class java.lang.Enum<P4JFileAction>