IStream (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.core
Interface IStream

All Superinterfaces:: IServerResource, IStreamSummary

All Known Implementing Classes:: Stream

public interface IStream
extends IStreamSummary
extends IStreamSummary

Defines a full Perforce stream specification. A stream specification ('spec') names a path in a stream depot to be treated as a stream. (See 'p4 help streamintro'.) The spec also defines the stream's lineage, its view, and its expected flow of change.

Full stream specs in the current implementation are always complete.

Nested Class Summary
`static interface`	`IStream.IExtraTag` Defines an "extraTag*" field

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

Method Summary
`ViewMap<IClientViewMapping>`	`getClientView()` Return the automatically generated client view map associated with this stream.
`List<IStream.IExtraTag>`	`getExtraTags()` Return a list of extra tags associated with this stream.
`ViewMap<IStreamIgnoredMapping>`	`getIgnoredView()` Return the ignored view map associated with this stream.
`ViewMap<IStreamRemappedMapping>`	`getRemappedView()` Return the remapped view map associated with this stream.
`ViewMap<IStreamViewMapping>`	`getStreamView()` Return the view map associated with this stream.
`void`	`setClientView(ViewMap<IClientViewMapping> clientView)` Set the automatically generated client view map associated with this stream spec.
`void`	`setExtraTags(List<IStream.IExtraTag> extraTags)` Set the extra tags associated with this stream.
`void`	`setIgnoredView(ViewMap<IStreamIgnoredMapping> ignoredView)` Set the ignored view map associated with this stream spec.
`void`	`setRemappedView(ViewMap<IStreamRemappedMapping> remappedView)` Set the remapped view map associated with this stream spec.
`void`	`setServer(IOptionsServer server)` Set the server to type of IOptionsServer, overriding the default IServer.
`void`	`setStreamView(ViewMap<IStreamViewMapping> streamView)` Set the view map associated with this stream spec.

Methods inherited from interface com.perforce.p4java.core.IStreamSummary
`getAccessed, getBaseParent, getDescription, getName, getOptions, getOwnerName, getParent, getStream, getType, getUpdated, isChangeFlowsFromParent, isChangeFlowsToParent, isFirmerThanParent, isUnloaded, setAccessed, setBaseParent, setChangeFlowsFromParent, setChangeFlowsToParent, setDescription, setFirmerThanParent, setName, setOptions, setOwnerName, setParent, setStream, setType, setUpdated`

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

Method Detail

getStreamView

ViewMap<IStreamViewMapping> getStreamView()

Return the view map associated with this stream. One or more mappings that define file paths in the stream view. Each line is of the form: []

Returns:: non-null list of IStreamViewMapping mappings for this stream.

setStreamView

void setStreamView(ViewMap<IStreamViewMapping> streamView)

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

Parameters:: streamView - new view mappings for the stream.

getRemappedView

ViewMap<IStreamRemappedMapping> getRemappedView()

Return the remapped view map associated with this stream. Optional; one or more mappings that define how stream view paths are to be remapped in client views. Each line is of the form:

Returns:: possibly-null (optional) list of IStreamRemappedMapping mappings for this stream.

setRemappedView

void setRemappedView(ViewMap<IStreamRemappedMapping> remappedView)

Set the remapped view map associated with this stream spec. This will not change the associated stream spec on the Perforce server unless you arrange for the update to server.

Parameters:: remappedView - new remapped view mappings for the stream.

getIgnoredView

ViewMap<IStreamIgnoredMapping> getIgnoredView()

Return the ignored view map associated with this stream. Optional; a list of file or directory names to be ignored in client views. mappings in the "Ignored" field may appear in any order. Ignored names are inherited by child stream client views.

Returns:: possibly-null (optional) list of IStreamIgnoredMapping mappings to be ignored for this stream.

setIgnoredView

void setIgnoredView(ViewMap<IStreamIgnoredMapping> ignoredView)

Set the ignored view map associated with this stream spec. This will not change the associated stream spec on the Perforce server unless you arrange for the update to server.

getClientView

ViewMap<IClientViewMapping> getClientView()

Return the automatically generated client view map associated with this stream. Maps files in the depot to files in your client workspace.

Returns:: possibly-null list of automatically generated IClientViewMapping mappings associated with this stream.

setClientView

void setClientView(ViewMap<IClientViewMapping> clientView)

Set the automatically generated client view map associated with this stream spec. This will not change the associated stream spec on the Perforce server unless you arrange for the update to server.

getExtraTags

List<IStream.IExtraTag> getExtraTags()

Return a list of extra tags associated with this stream.

Returns:: possibly-null list of extra tags associated with this stream.

setExtraTags

void setExtraTags(List<IStream.IExtraTag> extraTags)

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

setServer

void setServer(IOptionsServer server)

Set the server to type of IOptionsServer, overriding the default IServer.