com.perforce.p4java.impl.mapbased.server.cmd

Class KeyDelegator

java.lang.Object

com.perforce.p4java.impl.mapbased.server.cmd.BaseDelegator

com.perforce.p4java.impl.mapbased.server.cmd.KeyDelegator

All Implemented Interfaces:

IKeyDelegator

public class KeyDelegator
extends BaseDelegator
implements IKeyDelegator

Implementation to handle the Key command.

Field Summary

Fields inherited from class com.perforce.p4java.impl.mapbased.server.cmd.BaseDelegator

MAX_LIMIT_SUPPORTED_MIN_VERSION, QUERY_EXPRESSIONS_SUPPORTED_MIN_VERSION, USER_RESTRICTIONS_SUPPORTED_MIN_VERSION

Constructor Summary

Constructors

Constructor and Description
KeyDelegator(IOptionsServer server) Instantiate a new KeyDelegator, providing the server object that will be used to execute Perforce Helix attribute commands.

Method Summary

Modifier and Type	Method and Description
String	deleteKey(String keyName) Delete a key on a Perforce server.
String	getKey(String keyName) Get the value of a named Perforce key from the Perforce server.
String	setKey(String keyName, String value, KeyOptions opts) Create, set or delete a key on a Perforce server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyDelegator

public KeyDelegator(IOptionsServer server)

Instantiate a new KeyDelegator, providing the server object that will be used to execute Perforce Helix attribute commands.

Parameters:

server - a concrete implementation of a Perforce Helix Server

Method Detail

deleteKey

public String deleteKey(String keyName)
                 throws P4JavaException

Description copied from interface: IKeyDelegator

Delete a key on a Perforce server.

Specified by:

deleteKey in interface IKeyDelegator

Parameters:

keyName - non-null key name.

Returns:

non-null result message string (empty) from the delete operation.

Throws:

P4JavaException - if an error occurs processing this method and its parameters.

setKey

public String setKey(String keyName,
                     String value,
                     KeyOptions opts)
              throws P4JavaException

Description copied from interface: IKeyDelegator

Create, set or delete a key on a Perforce server. This method can be used to create, set, increment, or delete a key according to the specific options set in the associated options object.

Specified by:

setKey in interface IKeyDelegator

Parameters:

keyName - non-null key name.

value - value the key should be set to; can be null if the set operation is an increment.

opts - KeyOptions object describing optional parameters; if null, no options are set.

Returns:

possibly-null current (post-set, post-increment) value; may be empty if the operation was a delete.

Throws:

P4JavaException - if an error occurs processing this method and its parameters.

getKey

public String getKey(String keyName)
              throws P4JavaException

Description copied from interface: IKeyDelegator

Get the value of a named Perforce key from the Perforce server. Note that this method will return a zero string (i.e. "0") if the named key doesn't exist (rather than throw an exception); use getKeys to see if a key actually exists before you use it.

Specified by:

getKey in interface IKeyDelegator

Parameters:

keyName - non-null key name.

Returns:

non-null (but possibly zero, if non-existing) key value associated with keyName.

Throws:

P4JavaException - if an error occurs processing this method and its parameters.