BranchSpecSummary (Perforce Java API 2015.1.1210280 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

java.lang.Object
  com.perforce.p4java.impl.generic.core.ServerResource
      com.perforce.p4java.impl.generic.core.BranchSpecSummary

All Implemented Interfaces:: IBranchSpecSummary, IServerResource

Direct Known Subclasses:: BranchSpec

public class BranchSpecSummary
extends ServerResource
implements IBranchSpecSummary
extends ServerResource
implements IBranchSpecSummary

Default implementation class for the IBranchSpecSummary interface.

Field Summary
`protected Date`	`accessed`
`protected String`	`description`
`protected boolean`	`locked`
`protected String`	`name`
`protected String`	`ownerName`
`protected Date`	`updated`

Fields inherited from class com.perforce.p4java.impl.generic.core.ServerResource
`refreshable, server, updateable`

Constructor Summary
`BranchSpecSummary()` Default constructor -- sets all fields to null or false.
`BranchSpecSummary(boolean summaryOnly)` Default constructor; same as no-argument default constructor, except that it sets the ServerResource superclass fields appropriately for summary only (everything false) or full branch spec (updateable and refreshable).
`BranchSpecSummary(boolean summaryOnly, Date accessed, Date updated, String name, String ownerName, String description, boolean locked)` Explicit-value constructor.
`BranchSpecSummary(Map<String,Object> map, boolean summaryOnly)` Construct a BranchSpecSummary from a map returned by the Perforce server.

Method Summary
`Date`	`getAccessed()` Get the date of the last 'integrate' using this branch.
`String`	`getDescription()` Get the branch's description (if any).
`String`	`getName()` Get the name of this branch.
`String`	`getOwnerName()` Get the name of the user who created this branch.
`Date`	`getUpdated()` Get the date specification was last modified.
`boolean`	`isLocked()` Return true if the branch spec is locked.
`void`	`setAccessed(Date accessed)` Set the last-accessed date.
`void`	`setDescription(String description)` Set the branch spec description.
`void`	`setLocked(boolean locked)` Set whether the branch spec is locked or not.
`void`	`setName(String name)` Set the name of this branch.
`void`	`setOwnerName(String ownerName)` Set the owner's name for this branch.
`void`	`setUpdated(Date updated)` Set the last-updated date.

Methods inherited from class com.perforce.p4java.impl.generic.core.ServerResource
`canRefresh, canUpdate, complete, refresh, setRefreshable, setServer, update, update, update`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.perforce.p4java.core.IServerResource
`canRefresh, canUpdate, refresh, setServer, update, update, update`

Field Detail

accessed

protected Date accessed

updated

protected Date updated

name

protected String name

ownerName

protected String ownerName

description

protected String description

locked

protected boolean locked

Constructor Detail

BranchSpecSummary

public BranchSpecSummary()

Default constructor -- sets all fields to null or false.

BranchSpecSummary

public BranchSpecSummary(boolean summaryOnly)

Default constructor; same as no-argument default constructor, except that it sets the ServerResource superclass fields appropriately for summary only (everything false) or full branch spec (updateable and refreshable).

BranchSpecSummary

public BranchSpecSummary(boolean summaryOnly,
                         Date accessed,
                         Date updated,
                         String name,
                         String ownerName,
                         String description,
                         boolean locked)

Explicit-value constructor. If summaryOnly is true, refreshable and updeateable are set true in the ServerResource superclass, otherwise they're set false.

BranchSpecSummary

public BranchSpecSummary(Map<String,Object> map,
                         boolean summaryOnly)

Construct a BranchSpecSummary from a map returned by the Perforce server. If summaryOnly is true, this map was returned by the IServer getBranchSummaryList or similar summary-only method; otherwise it's assumed to be the full branch spec.

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

Method Detail