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

Class BranchesDelegator

java.lang.Object

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

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

All Implemented Interfaces:

IBranchesDelegator

public class BranchesDelegator
extends BaseDelegator
implements IBranchesDelegator

Since:

21/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
BranchesDelegator(IOptionsServer server) Build a new VerifyDelegtor object and keep the server object for

Method Summary

Modifier and Type	Method and Description
java.util.List<IBranchSpecSummary>	getBranchSpecs(GetBranchSpecsOptions opts) Get a list of all summary Perforce branch specs known to the Perforce server.
java.util.List<IBranchSpecSummary>	getBranchSpecs(java.lang.String userName, java.lang.String nameFilter, int maxReturns) Old style getBranchSpecs api call.

Methods inherited from class java.lang.Object

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

Constructor Detail

BranchesDelegator

public BranchesDelegator(IOptionsServer server)

Build a new VerifyDelegtor object and keep the server object for

using in the command processing.

Parameters:

server - - the currently effective server implementation

Method Detail

getBranchSpecs

public java.util.List<IBranchSpecSummary> getBranchSpecs(GetBranchSpecsOptions opts)
                                                  throws P4JavaException

Description copied from interface: IBranchesDelegator

Get a list of all summary Perforce branch specs known to the Perforce server.

Note that the IBranchSpecSummary objects returned here do not have branch view specs; you must call the getBranchSpec method on a specific branch to get valid view specs for a branch.

Specified by:

getBranchSpecs in interface IBranchesDelegator

Parameters:

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

Returns:

non-null (but possibly-empty) list of IBranchSpecSummary objects.

Throws:

P4JavaException - if any error occurs in the processing of this method.

getBranchSpecs

public java.util.List<IBranchSpecSummary> getBranchSpecs(java.lang.String userName,
                                                         java.lang.String nameFilter,
                                                         int maxReturns)
                                                  throws ConnectionException,
                                                         RequestException,
                                                         AccessException

Description copied from interface: IBranchesDelegator

Old style getBranchSpecs api call. deprecated use getBranchSpecs(final GetBranchSpecsOptions opts) instead

Specified by:

getBranchSpecs in interface IBranchesDelegator

Parameters:

userName - user name

nameFilter - name filter

maxReturns - maximum results

Returns:

list of Branch spec summaries

Throws:

ConnectionException - connection errors

RequestException - server request errors

AccessException - access restrictions