StreamSummary (p4java 2023.2.2581742 API)

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
```
Default implementation class for the IStreamSummary interface.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class StreamSummary.Options
Simple default generic IOptions implementation class.
- Nested classes/interfaces inherited from interface com.perforce.p4java.core.IStreamSummary
  IStreamSummary.IOptions, IStreamSummary.ParentView, IStreamSummary.Type

Nested Classes
Modifier and Type	Class and Description
`static class`	`StreamSummary.Options` Simple default generic IOptions implementation class.

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

Constructor Summary

Constructors
Constructor and Description
`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, java.lang.String stream, java.util.Date accessed, java.util.Date updated, java.lang.String name, java.lang.String ownerName, java.lang.String description, java.lang.String parent, IStreamSummary.Type type, StreamSummary.Options options)` Explicit-value constructor.
`StreamSummary(java.util.Map<java.lang.String,java.lang.Object> map, boolean summaryOnly)` Construct a StreamSummary from a map returned by the Perforce server.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.util.Date`	`getAccessed()` Get the date of the last 'integrate' using this stream.
`java.lang.String`	`getBaseParent()` Deprecated.
`java.lang.String`	`getDescription()` Get the stream's description (if any).
`java.lang.String`	`getName()` Get the alternate name of the stream.
`IStreamSummary.IOptions`	`getOptions()` Get the stream options
`java.lang.String`	`getOwnerName()` Get the name of the user who created this stream.
`java.lang.String`	`getParent()` Get the stream's parent.
`IStreamSummary.ParentView`	`getParentView()` Get the stream parentView
`java.lang.String`	`getStream()` Get the stream's path in a stream depot.
`IStreamSummary.Type`	`getType()` Get the stream type
`java.util.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(java.util.Date accessed)` Set the last-accessed date.
`void`	`setBaseParent(java.lang.String baseParent)` Deprecated.
`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(java.lang.String description)` Set the stream spec description.
`void`	`setFirmerThanParent(boolean firmerThanParent)` Set (true/false) the stream is firmer than parent.
`void`	`setName(java.lang.String name)` Set the name of this stream.
`void`	`setOptions(IStreamSummary.IOptions options)` Set the stream options.
`void`	`setOwnerName(java.lang.String ownerName)` Set the owner's name for this stream.
`void`	`setParent(java.lang.String parent)` Set the stream parent.
`void`	`setParentView(IStreamSummary.ParentView parentView)` Set the stream parentView.
`void`	`setStream(java.lang.String stream)` Set the stream's path.
`void`	`setType(IStreamSummary.Type type)` Set the stream type.
`void`	`setUpdated(java.util.Date updated)` Set the last-updated date.

Methods inherited from class com.perforce.p4java.impl.generic.core.ServerResource
canRefresh, canUpdate, clearRawFields, complete, getRawField, getRawFields, hasRawField, parseDate, refresh, setRawField, setRawFields, setRefreshable, setServer, toDateString, 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, clearRawFields, complete, getRawField, getRawFields, hasRawField, refresh, setRawField, setRawFields, setServer, update, update, update

- 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).
    
    Parameters:
    
    summaryOnly - if true
  - StreamSummary
```
public StreamSummary(boolean summaryOnly,
                     java.lang.String stream,
                     java.util.Date accessed,
                     java.util.Date updated,
                     java.lang.String name,
                     java.lang.String ownerName,
                     java.lang.String description,
                     java.lang.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.
    
    Parameters:
    
    summaryOnly - summaryOnly
    
    stream - stream
    
    accessed - accessed
    
    updated - updated
    
    name - name
    
    ownerName - ownerName
    
    description - description
    
    parent - parent
    
    type - type
    
    options - options
  - StreamSummary
```
public StreamSummary(java.util.Map<java.lang.String,java.lang.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 getStreamSummaryList 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.
    
    Parameters:
    
    map - spec map
    
    summaryOnly - if true
- Method Detail
  - getStream
```
public java.lang.String getStream()
```
    Description copied from interface: IStreamSummary
    
    Get the stream's path in a stream depot.
    
    Specified by:
    
    getStream in interface IStreamSummary
    
    Returns:
    
    stream path
    
    See Also:
    
    IStreamSummary.getStream()
  - setStream
```
public void setStream(java.lang.String stream)
```
    Description copied from interface: IStreamSummary
    
    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.
    
    Specified by:
    
    setStream in interface IStreamSummary
    
    Parameters:
    
    stream - new stream's path
    
    See Also:
    
    IStreamSummary.setStream(String)
  - getAccessed
```
public java.util.Date getAccessed()
```
    Description copied from interface: IStreamSummary
    
    Get the date of the last 'integrate' using this stream.
    
    Specified by:
    
    getAccessed in interface IStreamSummary
    
    Returns:
    
    date
    
    See Also:
    
    IStreamSummary.getAccessed()
  - setAccessed
```
public void setAccessed(java.util.Date accessed)
```
    Description copied from interface: IStreamSummary
    
    Set the last-accessed date. This generally has no effect on the associated Perforce server version of this spec.
    
    Specified by:
    
    setAccessed in interface IStreamSummary
    
    Parameters:
    
    accessed - new accessed date.
    
    See Also:
    
    IStreamSummary.setAccessed(java.util.Date)
  - getUpdated
```
public java.util.Date getUpdated()
```
    Description copied from interface: IStreamSummary
    
    Get the date specification was last modified.
    
    Specified by:
    
    getUpdated in interface IStreamSummary
    
    Returns:
    
    date
    
    See Also:
    
    IStreamSummary.getUpdated()
  - setUpdated
```
public void setUpdated(java.util.Date updated)
```
    Description copied from interface: IStreamSummary
    
    Set the last-updated date. This generally has no effect on the associated Perforce server version of this spec.
    
    Specified by:
    
    setUpdated in interface IStreamSummary
    
    Parameters:
    
    updated - new updated date.
    
    See Also:
    
    IStreamSummary.setUpdated(java.util.Date)
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: IStreamSummary
    
    Get the alternate name of the stream.
    
    Specified by:
    
    getName in interface IStreamSummary
    
    Returns:
    
    name
    
    See Also:
    
    IStreamSummary.getName()
  - setName
```
public void setName(java.lang.String name)
```
    Description copied from interface: IStreamSummary
    
    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.
    
    Specified by:
    
    setName in interface IStreamSummary
    
    Parameters:
    
    name - new stream spec name
    
    See Also:
    
    IStreamSummary.setName(java.lang.String)
  - getOwnerName
```
public java.lang.String getOwnerName()
```
    Description copied from interface: IStreamSummary
    
    Get the name of the user who created this stream.
    
    Specified by:
    
    getOwnerName in interface IStreamSummary
    
    Returns:
    
    owner
    
    See Also:
    
    IStreamSummary.getOwnerName()
  - setOwnerName
```
public void setOwnerName(java.lang.String ownerName)
```
    Description copied from interface: IStreamSummary
    
    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.
    
    Specified by:
    
    setOwnerName in interface IStreamSummary
    
    Parameters:
    
    ownerName - new owner's name
    
    See Also:
    
    IStreamSummary.setOwnerName(java.lang.String)
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: IStreamSummary
    
    Get the stream's description (if any).
    
    Specified by:
    
    getDescription in interface IStreamSummary
    
    Returns:
    
    description
    
    See Also:
    
    IStreamSummary.getDescription()
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Description copied from interface: IStreamSummary
    
    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.
    
    Specified by:
    
    setDescription in interface IStreamSummary
    
    Parameters:
    
    description - new description string.
    
    See Also:
    
    IStreamSummary.setDescription(java.lang.String)
  - getParent
```
public java.lang.String getParent()
```
    Description copied from interface: IStreamSummary
    
    Get the stream's parent.
    
    Specified by:
    
    getParent in interface IStreamSummary
    
    Returns:
    
    parent
    
    See Also:
    
    IStreamSummary.getParent()
  - setParent
```
public void setParent(java.lang.String parent)
```
    Description copied from interface: IStreamSummary
    
    Set the stream parent. This will not change the associated stream spec on the Perforce server unless you arrange for the update to server.
    
    Specified by:
    
    setParent in interface IStreamSummary
    
    Parameters:
    
    parent - new stream parent.
    
    See Also:
    
    IStreamSummary.setParent(java.lang.String)
  - getType
```
public IStreamSummary.Type getType()
```
    Description copied from interface: IStreamSummary
    
    Get the stream type
    
    Specified by:
    
    getType in interface IStreamSummary
    
    Returns:
    
    type
    
    See Also:
    
    IStreamSummary.getType()
  - getParentView
```
public IStreamSummary.ParentView getParentView()
```
    Description copied from interface: IStreamSummary
    
    Get the stream parentView
    
    Specified by:
    
    getParentView in interface IStreamSummary
    
    Returns:
    
    parent view
    
    See Also:
    
    IStreamSummary.getParentView()
  - setType
```
public void setType(IStreamSummary.Type type)
```
    Description copied from interface: IStreamSummary
    
    Set the stream type. This will not change the associated stream spec on the Perforce server unless you arrange for the update to server.
    
    Specified by:
    
    setType in interface IStreamSummary
    
    Parameters:
    
    type - new stream type.
    
    See Also:
    
    IStreamSummary.setType(com.perforce.p4java.core.IStreamSummary.Type)
  - setParentView
```
public void setParentView(IStreamSummary.ParentView parentView)
```
    Description copied from interface: IStreamSummary
    
    Set the stream parentView. This will not change the associated stream spec on the Perforce server unless you arrange for the update to server.
    
    Specified by:
    
    setParentView in interface IStreamSummary
    
    Parameters:
    
    parentView - new stream parentView.
    
    See Also:
    
    IStreamSummary.setParentView(com.perforce.p4java.core.IStreamSummary.ParentView)
  - getOptions
```
public IStreamSummary.IOptions getOptions()
```
    Description copied from interface: IStreamSummary
    
    Get the stream options
    
    Specified by:
    
    getOptions in interface IStreamSummary
    
    Returns:
    
    options
    
    See Also:
    
    IStreamSummary.getOptions()
  - setOptions
```
public void setOptions(IStreamSummary.IOptions options)
```
    Description copied from interface: IStreamSummary
    
    Set the stream options. This will not change the associated stream spec on the Perforce server unless you arrange for the update to server.
    
    Specified by:
    
    setOptions in interface IStreamSummary
    
    Parameters:
    
    options - new stream options.
    
    See Also:
    
    IStreamSummary.setOptions(com.perforce.p4java.core.IStreamSummary.IOptions)
  - isFirmerThanParent
```
public boolean isFirmerThanParent()
```
    Description copied from interface: IStreamSummary
    
    Is firmer than parent.
    
    Specified by:
    
    isFirmerThanParent in interface IStreamSummary
    
    Returns:
    
    if true
    
    See Also:
    
    IStreamSummary.isFirmerThanParent()
  - setFirmerThanParent
```
public void setFirmerThanParent(boolean firmerThanParent)
```
    Description copied from interface: IStreamSummary
    
    Set (true/false) the stream is firmer than parent.
    
    Specified by:
    
    setFirmerThanParent in interface IStreamSummary
    
    Parameters:
    
    firmerThanParent - if true
    
    See Also:
    
    IStreamSummary.setFirmerThanParent(boolean)
  - isChangeFlowsToParent
```
public boolean isChangeFlowsToParent()
```
    Description copied from interface: IStreamSummary
    
    Is change flows to parent.
    
    Specified by:
    
    isChangeFlowsToParent in interface IStreamSummary
    
    Returns:
    
    if true
    
    See Also:
    
    IStreamSummary.isChangeFlowsToParent()
  - setChangeFlowsToParent
```
public void setChangeFlowsToParent(boolean changeFlowsToParent)
```
    Description copied from interface: IStreamSummary
    
    Set (true/false) the stream's change flows to parent.
    
    Specified by:
    
    setChangeFlowsToParent in interface IStreamSummary
    
    Parameters:
    
    changeFlowsToParent - if true
    
    See Also:
    
    IStreamSummary.setChangeFlowsToParent(boolean)
  - isChangeFlowsFromParent
```
public boolean isChangeFlowsFromParent()
```
    Description copied from interface: IStreamSummary
    
    Is change flows from parent.
    
    Specified by:
    
    isChangeFlowsFromParent in interface IStreamSummary
    
    Returns:
    
    if true
    
    See Also:
    
    IStreamSummary.isChangeFlowsFromParent()
  - setChangeFlowsFromParent
```
public void setChangeFlowsFromParent(boolean changeFlowsFromParent)
```
    Description copied from interface: IStreamSummary
    
    Set (true/false) the stream's change flows from parent.
    
    Specified by:
    
    setChangeFlowsFromParent in interface IStreamSummary
    
    Parameters:
    
    changeFlowsFromParent - if true
    
    See Also:
    
    IStreamSummary.setChangeFlowsFromParent(boolean)
  - getBaseParent
```
@Deprecated
public java.lang.String getBaseParent()
```
    Deprecated.
    
    Description copied from interface: IStreamSummary
    
    Get the stream's base parent.
    
    Specified by:
    
    getBaseParent in interface IStreamSummary
    
    Returns:
    
    parent base
    
    See Also:
    
    IStreamSummary.getBaseParent()
  - setBaseParent
```
@Deprecated
public void setBaseParent(java.lang.String baseParent)
```
    Deprecated.
    
    Description copied from interface: IStreamSummary
    
    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.
    
    Specified by:
    
    setBaseParent in interface IStreamSummary
    
    Parameters:
    
    baseParent - new stream base parent.
    
    See Also:
    
    IStreamSummary.setBaseParent(java.lang.String)
  - isUnloaded
```
public boolean isUnloaded()
```
    Description copied from interface: IStreamSummary
    
    Return the "unloaded" status for this stream.
    
    Specified by:
    
    isUnloaded in interface IStreamSummary
    
    Returns:
    
    true iff the stream is unloaded.
    
    See Also:
    
    IStreamSummary.isUnloaded()

Class StreamSummary

Nested Class Summary

Nested classes/interfaces inherited from interface com.perforce.p4java.core.IStreamSummary

Field Summary

Fields inherited from class com.perforce.p4java.impl.generic.core.ServerResource

Constructor Summary

Method Summary

Methods inherited from class com.perforce.p4java.impl.generic.core.ServerResource

Methods inherited from class java.lang.Object

Methods inherited from interface com.perforce.p4java.core.IServerResource

Constructor Detail

StreamSummary

StreamSummary

StreamSummary

StreamSummary

Method Detail

getStream

setStream

getAccessed

setAccessed

getUpdated

setUpdated

getName

setName

getOwnerName

setOwnerName

getDescription

setDescription

getParent

setParent

getType

getParentView

setType

setParentView

getOptions

setOptions

isFirmerThanParent

setFirmerThanParent

isChangeFlowsToParent

setChangeFlowsToParent

isChangeFlowsFromParent

setChangeFlowsFromParent

getBaseParent

setBaseParent

isUnloaded