com.perforce.p4java.core

Interface IStreamSummary

All Superinterfaces:

IServerResource

All Known Subinterfaces:

IStream

All Known Implementing Classes:

Stream, StreamSummary

public interface IStreamSummary
extends IServerResource

Defines the summary Perforce stream metadata typically returned by the getStreamSummaryList() method, corresponding to "p4 streams" and similar.

In general, stream summary information excludes the stream paths, remapped, ignored, and no server-side operations can be performed against them; for full stream functionality you should use the full IStream interface.

Stream summaries are complete and not refreshable or updateable.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IStreamSummary.IOptions Stream options are flags to configure stream behavior.
static class	IStreamSummary.Type Types of streams include 'mainline', 'release', 'development', 'virtual' and 'task'.

Method Summary

Modifier and Type	Method and Description
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 interface com.perforce.p4java.core.IServerResource

canRefresh, canUpdate, refresh, setServer, update, update, update

Method Detail

getStream

String getStream()

Get the stream's path in a stream depot.

getName

String getName()

Get the alternate name of the stream.

getOwnerName

String getOwnerName()

Get the name of the user who created this stream.

getUpdated

Date getUpdated()

Get the date specification was last modified.

getAccessed

Date getAccessed()

Get the date of the last 'integrate' using this stream.

getDescription

String getDescription()

Get the stream's description (if any).

getParent

String getParent()

Get the stream's parent.

getType

IStreamSummary.Type getType()

Get the stream type

getOptions

IStreamSummary.IOptions getOptions()

Get the stream options

isFirmerThanParent

boolean isFirmerThanParent()

Is firmer than parent.

isChangeFlowsToParent

boolean isChangeFlowsToParent()

Is change flows to parent.

isChangeFlowsFromParent

boolean isChangeFlowsFromParent()

Is change flows from parent.

getBaseParent

String getBaseParent()

Get the stream's base parent.

setStream

void setStream(String stream)

Set the stream's path. This will not change the associated stream spec on the Perforce server unless you arrange for the update to server.

Parameters:

stream - new stream's path

setName

void setName(String name)

Set the name of this stream. This will not change the associated stream spec on the Perforce server unless you arrange for the update to server.

Parameters:

name - new stream spec name

setOwnerName

void setOwnerName(String ownerName)

Set the owner's name for this stream. This will not change the associated stream spec on the Perforce server unless you arrange for the update to server.

Parameters:

ownerName - new owner's name

setUpdated

void setUpdated(Date updated)

Set the last-updated date. This generally has no effect on the associated Perforce server version of this spec.

Parameters:

updated - new updated date.

setAccessed

void setAccessed(Date accessed)

Set the last-accessed date. This generally has no effect on the associated Perforce server version of this spec.

Parameters:

accessed - new accessed date.

setDescription

void setDescription(String description)

Set the stream spec description. This will not change the associated stream spec on the Perforce server unless you arrange for the update to server.

Parameters:

description - new description string.

setParent

void setParent(String parent)

Set the stream parent. This will not change the associated stream spec on the Perforce server unless you arrange for the update to server.

Parameters:

parent - new stream parent.

setType

void setType(IStreamSummary.Type type)

Set the stream type. This will not change the associated stream spec on the Perforce server unless you arrange for the update to server.

Parameters:

type - new stream type.

setOptions

void setOptions(IStreamSummary.IOptions options)

Set the stream options. This will not change the associated stream spec on the Perforce server unless you arrange for the update to server.

Parameters:

options - new stream options.

setFirmerThanParent

void setFirmerThanParent(boolean firmerThanParent)

Set (true/false) the stream is firmer than parent.

setChangeFlowsToParent

void setChangeFlowsToParent(boolean changeFlowsToParent)

Set (true/false) the stream's change flows to parent.

setChangeFlowsFromParent

void setChangeFlowsFromParent(boolean changeFlowsFromParent)

Set (true/false) the stream's change flows from parent.

setBaseParent

void setBaseParent(String baseParent)

Set the stream base parent. This will not change the associated stream spec on the Perforce server unless you arrange for the update to server.

Parameters:

baseParent - new stream base parent.

isUnloaded

boolean isUnloaded()

Return the "unloaded" status for this stream.

Returns:

true iff the stream is unloaded.