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

Class BranchDelegator

java.lang.Object

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

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

All Implemented Interfaces:

IBranchDelegator

public class BranchDelegator
extends BaseDelegator
implements IBranchDelegator

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

Method Summary

Modifier and Type	Method and Description
String	createBranchSpec(IBranchSpec branchSpec) TODO: This should be moved up to Server and changed to delegate to createBranchSpec with an options class.
String	deleteBranchSpec(String branchSpecName, boolean force) Delete a branch spec specifing whether it should be a forced operation.
String	deleteBranchSpec(String branchSpecName, DeleteBranchSpecOptions opts) Delete a named Perforce branch spec from the Perforce server.
IBranchSpec	getBranchSpec(String name) Get the branch spec for the given name.
IBranchSpec	getBranchSpec(String name, GetBranchSpecOptions opts) Get a specific named Perforce branch spec from the Perforce server.
String	updateBranchSpec(IBranchSpec branchSpec) Update the data fields in an existing branch spec.

Methods inherited from class java.lang.Object

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

Constructor Detail

BranchDelegator

public BranchDelegator(IOptionsServer server)

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

createBranchSpec

public String createBranchSpec(@Nonnull
                               IBranchSpec branchSpec)
                        throws ConnectionException,
                               RequestException,
                               AccessException

Description copied from interface: IBranchDelegator

TODO: This should be moved up to Server and changed to delegate to createBranchSpec with an options class. This would also allow for a force option.

Specified by:

createBranchSpec in interface IBranchDelegator

Parameters:

branchSpec - the spec object containing the branch data fields.

Returns:

The name of the newly create branch spec

Throws:

ConnectionException - when there is an error talking to the Helix server

RequestException - when there is a problem with the data provided in the request

AccessException - when access to the branch command is not authorised

getBranchSpec

public IBranchSpec getBranchSpec(String name)
                          throws ConnectionException,
                                 RequestException,
                                 AccessException

Description copied from interface: IBranchDelegator

Get the branch spec for the given name.

Specified by:

getBranchSpec in interface IBranchDelegator

Parameters:

name - the name of the branch

Returns:

a populated branch spec object

Throws:

ConnectionException - when there is an error talking to the Helix server

RequestException - when there is a problem with the data provided in the request

AccessException - when access to the branch command is not authorised

getBranchSpec

public IBranchSpec getBranchSpec(String name,
                                 GetBranchSpecOptions opts)
                          throws P4JavaException

Description copied from interface: IBranchDelegator

Get a specific named Perforce branch spec from the Perforce server.

Note that since the Perforce server usually interprets asking for a non-existent branch spec as equivalent to asking for a template for a new branch spec, you will normally always get back a result here. It is best to first use the getBranchSpecList method to see if the branch spec exists, then use this method to retrieve a specific branch spec once you know it exists.

Specified by:

getBranchSpec in interface IBranchDelegator

Parameters:

name - non-null Perforce branch name.

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

Returns:

potentially-null IBranchSpec for the named Perforce branch spec.

Throws:

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

updateBranchSpec

public String updateBranchSpec(@Nonnull
                               IBranchSpec branchSpec)
                        throws ConnectionException,
                               RequestException,
                               AccessException

Description copied from interface: IBranchDelegator

Update the data fields in an existing branch spec.

Specified by:

updateBranchSpec in interface IBranchDelegator

Parameters:

branchSpec - the branch data

Returns:

the name of the updated spec

Throws:

ConnectionException - when there is an error talking to the Helix server

RequestException - when there is a problem with the data provided in the request

AccessException - when access to the branch command is not authorised

deleteBranchSpec

public String deleteBranchSpec(String branchSpecName,
                               boolean force)
                        throws ConnectionException,
                               RequestException,
                               AccessException

Description copied from interface: IBranchDelegator

Delete a branch spec specifing whether it should be a forced operation.

Specified by:

deleteBranchSpec in interface IBranchDelegator

Parameters:

branchSpecName - the name of the spec to delete

force - whether to force the operation through

Returns:

name of the deleted spec

Throws:

ConnectionException - when there is an error talking to the Helix server

RequestException - when there is a problem with the data provided in the request

AccessException - when access to the branch command is not authorised

deleteBranchSpec

public String deleteBranchSpec(String branchSpecName,
                               DeleteBranchSpecOptions opts)
                        throws P4JavaException

Description copied from interface: IBranchDelegator

Delete a named Perforce branch spec from the Perforce server.

Specified by:

deleteBranchSpec in interface IBranchDelegator

Parameters:

branchSpecName - non-null name of the branch spec to be deleted.

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

Returns:

non-null result message string from the Perforce server; this may include form trigger output pre-pended and / or appended to the "normal" message

Throws:

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