com.perforce.p4java.impl.generic.core
Class Label

java.lang.Object
  com.perforce.p4java.impl.generic.core.ServerResource
      com.perforce.p4java.impl.generic.core.LabelSummary
          com.perforce.p4java.impl.generic.core.Label

All Implemented Interfaces:

ILabel, ILabelSummary, IServerResource

public class Label
extends LabelSummary
implements ILabel

Default implementation class for the ILabel interface.

viewMapping

protected ViewMap<ILabelMapping> viewMapping

DEFAULT_DESCRIPTION

public static final String DEFAULT_DESCRIPTION

The description string used if no description field is passed to Label.newLabel().

See Also:

Constant Field Values

DEFAULT_MAPPING

public static final String DEFAULT_MAPPING

The default mapping used if a null mapping parameter is passed to Label.newLabel().

See Also:

Constant Field Values

Label

public Label()

Default constructor; sets all inherited and local fields to null or false; calls super(false).

Label

public Label(String name,
             String ownerName,
             Date lastAccess,
             Date lastUpdate,
             String description,
             String revisionSpec,
             boolean locked,
             ViewMap<ILabelMapping> viewMapping)

Explicit-value constructor. Generally useful for constructing new label implementations.

Label

public Label(Map<String,Object> map,
             IServer server)

Construct a new Label from the map passed back from the IServer's getLabel method or from a similar map, and the current server object (if any). Will not work properly with the map returned from the server getLabelSummaryList method.

If the map is null, this is equivalent to calling the default constructor.

Label

public Label(ILabelSummary labelSummary)
      throws ConnectionException,
             RequestException,
             AccessException

Given an ILabelSummary object, construct a new Label object from it. This implementation simply gets the label on the Perforce server with the same name as the labelSummary's name by using the Label.refresh() object.

If labelSummary is null this is equivalent to calling the default constructor; otherwise all LabelSummary fields are copied, and if labelSummary.getName() is not null, the refresh() is performed.

Parameters:

labelSummary - possibly-null ILabelSummary object.

Throws:

ConnectionException

RequestException

AccessException

newLabel

public static Label newLabel(IServer server,
                             String name,
                             String description,
                             String[] mapping)

Create a new local Label object with the given name, description, and view mapping. The new object is local only (i.e. it does not exist as a "real" Perforce label on the server) and is not locked, has no revision spec, and has its owner name field set to the current user. Other defaults are as given for the Label and LabelSummary default constructors.

Parameters:

server - non-null server to be associated with this label.

name - non-null label name.

description - if not null, the new label's description field; if null, Label.DEFAULT_DESCRIPTION is used instead.

mapping - if not null, defines the left hand sides of the label's view map; if null, defaults to a single mapping as defined in Label.DEFAULT_MAPPING.

Returns:

new local Label object.

refresh

public void refresh()
             throws ConnectionException,
                    RequestException,
                    AccessException

This method will refresh by getting the complete label model. If this refresh is successful then this label will be marked as complete.

Specified by:

refresh in interface IServerResource

Overrides:

refresh in class ServerResource

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:

ServerResource.refresh()

updateOnServer

public String updateOnServer()
                      throws ConnectionException,
                             RequestException,
                             AccessException

Description copied from interface: ILabel

Update (or even create) this label on the associated Perforce server, if that server has been set for this label. Will throw a suitable RequestException if the label is not associated with a server, either as the result of being returned from a server earlier, or as the result of an explicit call on the underlying implementation object.

Note that you should only call this method on "full" labels, i.e. those returned from an explicit single call to IServer.getLabel() or those created by hand; calling this on a label returned from the getLabelList() method may cause the associated in-server label to lose its view mapping.

Specified by:

updateOnServer in interface ILabel

Returns:

the string message resulting from the update

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:

ILabel.updateOnServer()

update

public void update()
            throws ConnectionException,
                   RequestException,
                   AccessException

Description copied from interface: IServerResource

Update the Perforce server object associated with the underlying P4Java object, if possible. The semantics of server updates are generally object-specific and will be spelled out for each participating object.

The results of calling this method on objects whose canUpdate method returns false are undefined (but will generally result in a UnimplementedError being thrown).

Specified by:

update in interface ILabel

Specified by:

update in interface IServerResource

Overrides:

update in class ServerResource

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:

ServerResource.update()

setViewMapping

public void setViewMapping(ViewMap<ILabelMapping> viewMapping)

Description copied from interface: ILabel

Set the view mapping for this label. Note that only the left hand side (the depot path) of a mapping is used for labels and will be valid here.

Specified by:

setViewMapping in interface ILabel

Parameters:

viewMapping - list of IClientViewMapping mappings for this label.

See Also:

ILabel.setViewMapping(com.perforce.p4java.core.ViewMap)

getViewMapping

public ViewMap<ILabelMapping> getViewMapping()

Description copied from interface: ILabel

Get the view mapping for this label. Note that only the left hand side (the depot path) of a mapping is used for labels and will be valid here.

Note also that this method will only return the actual view mapping a label if the label object was returned from the IServer's getLabel() method (this is due to limitations in the underlying implementation).

Specified by:

getViewMapping in interface ILabel

Returns:

non-null but possibly empty list of IClientViewMapping mappings for this label.

See Also:

ILabel.getViewMapping()

getServer

public IServer getServer()

Description copied from interface: ILabel

Get the Perforce server object associated with this label.

Specified by:

getServer in interface ILabel

Returns:

possibly-null IServer object associated with this label.

See Also:

ILabel.getServer()

setServer

public void setServer(IServer server)

Description copied from interface: IServerResource

Set the server associated with this resource. Setting this null can have bad effects down the line...

Specified by:

setServer in interface ILabel

Specified by:

setServer in interface IServerResource

Overrides:

setServer in class ServerResource

Parameters:

server - IServer to be used for refresh, update, etc.

See Also:

ILabel.setServer(com.perforce.p4java.server.IServer)