StreamsDelegator (p4java 2024.1.2674354 API)

java.lang.Object
- com.perforce.p4java.impl.mapbased.server.cmd.BaseDelegator
- - com.perforce.p4java.impl.mapbased.server.cmd.StreamsDelegator

All Implemented Interfaces:

IStreamsDelegator
```
public class StreamsDelegator
extends BaseDelegator
implements IStreamsDelegator
```
Implementation to handle the Streams command.

Field Summary
- Fields inherited from class com.perforce.p4java.impl.mapbased.server.cmd.BaseDelegator
  MAX_LIMIT_SUPPORTED_MIN_VERSION, QUERY_EXPRESSIONS_SUPPORTED_MIN_VERSION, USER_RESTRICTIONS_SUPPORTED_MIN_VERSION

Constructor Summary

Constructors
Constructor	Description
`StreamsDelegator(IOptionsServer server)`	Instantiate a new StreamsDelegator, providing the server object that will be used to execute Perforce Helix attribute commands.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.List<IStreamSummary>`	`getStreams(java.util.List<java.lang.String> streamPaths, GetStreamsOptions opts)`	Get a list of all summary Perforce streams known to the Perforce server.

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

- Constructor Detail
  - StreamsDelegator
```
public StreamsDelegator(IOptionsServer server)
```
    Instantiate a new StreamsDelegator, providing the server object that will be used to execute Perforce Helix attribute commands.
    
    Parameters:
    
    server - a concrete implementation of a Perforce Helix Server
- Method Detail
  - getStreams
```
public java.util.List<IStreamSummary> getStreams(java.util.List<java.lang.String> streamPaths,
                                                 GetStreamsOptions opts)
                                          throws P4JavaException
```
    Description copied from interface: IStreamsDelegator
    
    Get a list of all summary Perforce streams known to the Perforce server.
    Note that the IStreamSummary objects returned here do not have stream paths. You must call the getStream method on a specific stream to get valid paths for a stream.
    
    Specified by:
    
    getStreams in interface IStreamsDelegator
    
    Parameters:
    
    streamPaths - if specified, the list of streams is limited to those matching the supplied list of stream paths, of the form //depotname/streamname
    
    opts - object describing optional parameters; if null, no options are set.
    
    Returns:
    
    non-null (but possibly-empty) list of IStreamSummary objects.
    
    Throws:
    
    P4JavaException - if any error occurs in the processing of this method.