FileSpecOpStatus (Perforce Java API 2015.1.1210280 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 FileSpecOpStatus

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

All Implemented Interfaces:: Serializable, Comparable<FileSpecOpStatus>

public enum FileSpecOpStatus
extends Enum<FileSpecOpStatus>
extends Enum<FileSpecOpStatus>

Statuses representing the result of a particular Perforce file-based operation.

The intention here is that this enum flags the associated Perforce filespec as either a valid (normal) file operation result (i.e. a file stat, etc.), or an error. The enums represent statuses that are usually, but not always, generated by the server; CLIENT_ERROR statuses are generated in the P4Java API itself and represent problems it had on the Perforce client under the command of the Perforce server. These errors are typically such things as being unable to open a client-side file, etc.

Enum Constant Summary
`CLIENT_ERROR` The Perforce client API detected a client-side error; the associated filespec contains the relevant error message.
`ERROR` The Perforce server has detected an error; the associated filespec contains the error message.
`INFO` The Perforce server or API client has generated a non-error message; the associated filespec contains the message.
`UNKNOWN` Error / validity status is unknown; do not use the associated filespec.
`VALID` Operation completed normally; the associated filespec contains a valid Perforce filespec.

Method Summary
`static FileSpecOpStatus`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static FileSpecOpStatus[]`	`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, toString, valueOf`

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

Enum Constant Detail

UNKNOWN

public static final FileSpecOpStatus UNKNOWN

Error / validity status is unknown; do not use the associated filespec.

VALID

public static final FileSpecOpStatus VALID

Operation completed normally; the associated filespec contains a valid Perforce filespec.

INFO

public static final FileSpecOpStatus INFO

The Perforce server or API client has generated a non-error message; the associated filespec contains the message.

CLIENT_ERROR

public static final FileSpecOpStatus CLIENT_ERROR

The Perforce client API detected a client-side error; the associated filespec contains the relevant error message.

ERROR

public static final FileSpecOpStatus ERROR

The Perforce server has detected an error; the associated filespec contains the error message.

Method Detail

values

public static FileSpecOpStatus[] 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 (FileSpecOpStatus c : FileSpecOpStatus.values())
    System.out.println(c);

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

valueOf

public static FileSpecOpStatus valueOf(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:: IllegalArgumentException - if this enum type has no constant with the specified name; NullPointerException - if the argument is null