Package com.perforce.p4java.server.delegator

Interface IStreamDelegator

    • Method Detail

      • createStream

        java.lang.String createStream​(@Nonnull
                              IStream stream)
                       throws P4JavaException
        Create a new stream in the repository.
        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.
        Since:
        2011.2

      • getStream

        IStream getStream​(@Nonnull
                  java.lang.String streamPath)
           throws P4JavaException
        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.
        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.
        Since:
        2011.2

      • getStream

        IStream getStream​(java.lang.String streamPath,
                  GetStreamOptions opts)
           throws P4JavaException
        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.
        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.
        Since:
        2012.1

      • updateStream

        java.lang.String updateStream​(IStream stream,
                              StreamOptions opts)
                       throws P4JavaException
        Update a Perforce stream spec on the Perforce server.
        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.
        Since:
        2011.2

      • deleteStream

        java.lang.String deleteStream​(java.lang.String streamPath,
                              StreamOptions opts)
                       throws P4JavaException
        Delete a Perforce stream spec from the Perforce server.
        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.
        Since:
        2011.2