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

Class CountersDelegator

java.lang.Object

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

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

All Implemented Interfaces:

ICountersDelegator

public class CountersDelegator
extends BaseDelegator
implements ICountersDelegator

Since:

26/09/2016

Author:

Sean Shou

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
CountersDelegator(IOptionsServer server) Create a new delegator with a concrete server implementation.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getCounters() This is here to allow access via both IOptionsServer and IServer, the underlying delegator implementation provides the concrete method.
Map<String,String>	getCounters(CounterOptions opts) Get a map of the Perforce server's counters.
Map<String,String>	getCounters(GetCountersOptions opts) Get a map of the Perforce server's counters.

Methods inherited from class java.lang.Object

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

Constructor Detail

CountersDelegator

public CountersDelegator(IOptionsServer server)

Create a new delegator with a concrete server implementation.

Parameters:

server - the real server implementation

Method Detail

getCounters

public Map<String,String> getCounters()
                               throws ConnectionException,
                                      RequestException,
                                      AccessException

Description copied from interface: ICountersDelegator

This is here to allow access via both IOptionsServer and IServer, the underlying delegator implementation provides the concrete method.

Specified by:

getCounters in interface ICountersDelegator

Returns:

a non-null (but possibly empty) map of counters. key and value semantics and format are not specified here.

Throws:

ConnectionException - if the Perforce server is unreachable or is not connected.

RequestException - if the Perforce server encounters an error during its processing of the request

AccessException - if the Perforce server denies access to the caller

See Also:

IServer

getCounters

public Map<String,String> getCounters(CounterOptions opts)
                               throws P4JavaException

Description copied from interface: ICountersDelegator

Get a map of the Perforce server's counters.

Specified by:

getCounters in interface ICountersDelegator

Parameters:

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

Returns:

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

Throws:

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

getCounters

public Map<String,String> getCounters(GetCountersOptions opts)
                               throws P4JavaException

Description copied from interface: ICountersDelegator

Get a map of the Perforce server's counters.

Specified by:

getCounters in interface ICountersDelegator

Parameters:

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

Returns:

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

Throws:

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