StreamSummary (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 StreamSummary

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

All Implemented Interfaces:: IServerResource, IStreamSummary

Direct Known Subclasses:: Stream

public class StreamSummary
extends ServerResource
implements IStreamSummary
extends ServerResource
implements IStreamSummary

Default implementation class for the IStreamSummary interface.

Nested Class Summary
`static class`	`StreamSummary.Options` Simple default generic IOptions implementation class.

Nested classes/interfaces inherited from interface com.perforce.p4java.core.IStreamSummary
`IStreamSummary.IOptions, IStreamSummary.Type`

Field Summary
`protected Date`	`accessed`
`protected String`	`baseParent`
`protected boolean`	`changeFlowsFromParent`
`protected boolean`	`changeFlowsToParent`
`protected String`	`description`
`protected boolean`	`firmerThanParent`
`protected String`	`name`
`protected IStreamSummary.IOptions`	`options`
`protected String`	`ownerName`
`protected String`	`parent`
`protected String`	`stream`
`protected IStreamSummary.Type`	`type`
`protected boolean`	`unloaded`
`protected Date`	`updated`

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

Constructor Summary
`StreamSummary()` Default constructor -- sets all fields to null or false.
`StreamSummary(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 stream spec (updateable and refreshable).
`StreamSummary(boolean summaryOnly, String stream, Date accessed, Date updated, String name, String ownerName, String description, String parent, IStreamSummary.Type type, StreamSummary.Options options)` Explicit-value constructor.
`StreamSummary(Map<String,Object> map, boolean summaryOnly)` Construct a StreamSummary from a map returned by the Perforce server.

Method Summary
`Date`	`getAccessed()` Get the date of the last 'integrate' using this stream.
`String`	`getBaseParent()` Get the stream's base parent.
`String`	`getDescription()` Get the stream's description (if any).
`String`	`getName()` Get the alternate name of the stream.
`IStreamSummary.IOptions`	`getOptions()` Get the stream options
`String`	`getOwnerName()` Get the name of the user who created this stream.
`String`	`getParent()` Get the stream's parent.
`String`	`getStream()` Get the stream's path in a stream depot.
`IStreamSummary.Type`	`getType()` Get the stream type
`Date`	`getUpdated()` Get the date specification was last modified.
`boolean`	`isChangeFlowsFromParent()` Is change flows from parent.
`boolean`	`isChangeFlowsToParent()` Is change flows to parent.
`boolean`	`isFirmerThanParent()` Is firmer than parent.
`boolean`	`isUnloaded()` Return the "unloaded" status for this stream.
`void`	`setAccessed(Date accessed)` Set the last-accessed date.
`void`	`setBaseParent(String baseParent)` Set the stream base parent.
`void`	`setChangeFlowsFromParent(boolean changeFlowsFromParent)` Set (true/false) the stream's change flows from parent.
`void`	`setChangeFlowsToParent(boolean changeFlowsToParent)` Set (true/false) the stream's change flows to parent.
`void`	`setDescription(String description)` Set the stream spec description.
`void`	`setFirmerThanParent(boolean firmerThanParent)` Set (true/false) the stream is firmer than parent.
`void`	`setName(String name)` Set the name of this stream.
`void`	`setOptions(IStreamSummary.IOptions options)` Set the stream options.
`void`	`setOwnerName(String ownerName)` Set the owner's name for this stream.
`void`	`setParent(String parent)` Set the stream parent.
`void`	`setStream(String stream)` Set the stream's path.
`void`	`setType(IStreamSummary.Type type)` Set the stream type.
`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

stream

protected String stream

accessed

protected Date accessed

updated

protected Date updated

name

protected String name

ownerName

protected String ownerName

description

protected String description

parent

protected String parent

type

protected IStreamSummary.Type type

options

protected IStreamSummary.IOptions options

baseParent

protected String baseParent

firmerThanParent

protected boolean firmerThanParent

changeFlowsToParent

protected boolean changeFlowsToParent

changeFlowsFromParent

protected boolean changeFlowsFromParent

unloaded

protected boolean unloaded

Constructor Detail

StreamSummary

public StreamSummary()

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

StreamSummary

public StreamSummary(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 stream spec (updateable and refreshable).

StreamSummary

public StreamSummary(boolean summaryOnly,
                     String stream,
                     Date accessed,
                     Date updated,
                     String name,
                     String ownerName,
                     String description,
                     String parent,
                     IStreamSummary.Type type,
                     StreamSummary.Options options)

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

StreamSummary

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

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

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

Method Detail