Package com.perforce.p4java.impl.mapbased.server.cmd

Class StreamDelegator

    • Constructor Detail

      • StreamDelegator

        public StreamDelegator​(IOptionsServer server)
        Instantiate a new StreamDelegator, 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

      • createStream

        public java.lang.String createStream​(@Nonnull
                                     IStream stream)
                              throws P4JavaException
        Description copied from interface: IStreamDelegator
        Create a new stream in the repository.
        Specified by:
        createStream in interface IStreamDelegator
        Parameters:
        stream - non-null IStream object representing the stream to be created.
        Returns:
        possibly-null operation result message string from the Perforce server.
        Throws:
        P4JavaException - if any error occurs in the processing of this method.

      • getStream

        public IStream getStream​(@Nonnull
                         java.lang.String streamPath)
                  throws P4JavaException
        Description copied from interface: IStreamDelegator
        Get an individual stream by stream path. Note that this method will return a fake stream if you ask it for a non-existent stream, so it's not the most useful of operations.
        Specified by:
        getStream in interface IStreamDelegator
        Parameters:
        streamPath - non-null stream's path in a stream depot, of the form //depotname/streamname
        Returns:
        IStream non-null object corresponding to the named stream if it exists and is retrievable; otherwise an IStream object that looks real but does not, in fact, correspond to any known stream in the repository.
        Throws:
        P4JavaException - if any error occurs in the processing of this method.

      • getStream

        public IStream getStream​(@Nonnull
                         java.lang.String streamPath,
                         GetStreamOptions opts)
                  throws P4JavaException
        Description copied from interface: IStreamDelegator
        Get an individual stream by stream path. Note that this method will return a fake stream if you ask it for a non-existent stream, so it's not the most useful of operations.
        Specified by:
        getStream in interface IStreamDelegator
        Parameters:
        streamPath - non-null stream's path in a stream depot, of the form //depotname/streamname
        opts - GetStreamOptions object describing optional parameters; if null, no options are set.
        Returns:
        IStream non-null object corresponding to the named stream if it exists and is retrievable; otherwise an IStream object that looks real but does not, in fact, correspond to any known stream in the repository.
        Throws:
        P4JavaException - if any error occurs in the processing of this method.

      • updateStream

        public java.lang.String updateStream​(@Nonnull
                                     IStream stream,
                                     StreamOptions opts)
                              throws P4JavaException
        Description copied from interface: IStreamDelegator
        Update a Perforce stream spec on the Perforce server.
        Specified by:
        updateStream in interface IStreamDelegator
        Parameters:
        stream - non-null stream spec to be updated.
        opts - StreamOptions object describing optional parameters; if null, no options are set.
        Returns:
        non-null result message string from the Perforce server; this may include form trigger output pre-pended and / or appended to the "normal" message.
        Throws:
        P4JavaException - if any error occurs in the processing of this method.

      • deleteStream

        public java.lang.String deleteStream​(@Nonnull
                                     java.lang.String streamPath,
                                     StreamOptions opts)
                              throws P4JavaException
        Description copied from interface: IStreamDelegator
        Delete a Perforce stream spec from the Perforce server.
        Specified by:
        deleteStream in interface IStreamDelegator
        Parameters:
        streamPath - non-null stream's path in a stream depot, of the form //depotname/streamname
        opts - StreamOptions object describing optional parameters; if null, no options are set.
        Returns:
        non-null result message string from the Perforce server; this may include form trigger output pre-pended and / or appended to the "normal" message
        Throws:
        P4JavaException - if any error occurs in the processing of this method.