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

Class KeysDelegator

java.lang.Object

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

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

All Implemented Interfaces:

IKeysDelegator

public class KeysDelegator
extends BaseDelegator
implements IKeysDelegator

Implementation to handle the Keys 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	Description
KeysDelegator(IOptionsServer server)	Instantiate a new KeysDelegator, providing the server object that will be used to execute Perforce Helix attribute commands.

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.String>	getKeys(GetKeysOptions opts)	Get a map of the Perforce server's keys.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeysDelegator

public KeysDelegator(IOptionsServer server)

Instantiate a new KeysDelegator, 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

getKeys

public java.util.Map<java.lang.String,java.lang.String> getKeys(GetKeysOptions opts)
                                                               throws P4JavaException

Description copied from interface: IKeysDelegator

Get a map of the Perforce server's keys.

Specified by:

getKeys in interface IKeysDelegator

Parameters:

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

Returns:

a non-null (but possibly empty) map of keys.

Throws:

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