ServerStatus (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.server
Enum ServerStatus

java.lang.Object
  java.lang.Enum<ServerStatus>
      com.perforce.p4java.server.ServerStatus

All Implemented Interfaces:: Serializable, Comparable<ServerStatus>

public enum ServerStatus
extends Enum<ServerStatus>
extends Enum<ServerStatus>

Used to describe the protocol-independent status of an IServer object.

Enum Constant Summary
`DISCONNECTED` Server object has been properly disconnected from the associated Perforce server, either by the user or by the server (usually as the result of a timeout).
`ERROR` Server is in an error state; this may be a connection problem or a problem with the Perforce server itself.
`READY` Server object is ready for use and error-free.
`UNKNOWN` State is unknown.

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

State is unknown. Don't use this server!

ERROR

public static final ServerStatus ERROR

Server is in an error state; this may be a connection problem or a problem with the Perforce server itself.

READY

public static final ServerStatus READY

Server object is ready for use and error-free.

DISCONNECTED

public static final ServerStatus DISCONNECTED

Server object has been properly disconnected from the associated Perforce server, either by the user or by the server (usually as the result of a timeout). Not considered an error state.

Method Detail

values

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

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

valueOf

public static ServerStatus 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