Package com.perforce.p4java.option.server

Class StreamlogOptions

java.lang.Object
com.perforce.p4java.option.Options
com.perforce.p4java.option.server.StreamlogOptions
public class StreamlogOptions extends Options

  • Field Details

    • OPTIONS_SPECS

      public static final String OPTIONS_SPECS
      Options: -c changelist# -h -i -l -L -t -m max
      See Also:

    • changelistId

      protected int changelistId
      If non-negative, displays the stream submitted at the specified changelist number

    • includeInherited

      protected boolean includeInherited
      Includes inherited stream history. For a stream created by branching (using 'p4 integrate'), streamlog lists the revisions of the stream's ancestors up to the branch points that led to the specified revision. Stream history inherited by renaming (using 'p4 move') is always displayed regardless of whether -i is specified.

    • includeHistory

      protected boolean includeHistory
      Displays the stream content history instead of stream name history. The list includes revisions of other streams that were branched or copied (using 'p4 integrate' and 'p4 resolve -at') to the specified revision. Revisions that were replaced by copying or branching are omitted, even if they are part of the history of the specified revision.

    • fullText

      protected boolean fullText
      Lists the full text of the changelist descriptions.

    • fullTextTruncated

      protected boolean fullTextTruncated
      Lists the full text of the changelist descriptions, truncated to 250 characters if longer.

    • maxResults

      protected int maxResults
      Displays at most 'max' revisions per stream argument specified.

  • Constructor Details

    • StreamlogOptions

      public StreamlogOptions()
      Default constructor.

    • StreamlogOptions

      public StreamlogOptions(String... options)

  • Method Details

    • processOptions

      public List<String> processOptions(IServer server) throws OptionsException
      Description copied from class: Options
      Turn this (specific) options object into a list of strings to be sent to the Perforce server as options for a specific command. As a side effect, set the option list associated with this Option to the result.

      The method is used by the server object to generate the string-based arguments expected by the Perforce server corresponding to the state of this method-specific options object. Will return an empty list if there are no "interesting" options set or available. May simply return the superclass options string list if is non-null, but that behaviour is neither guaranteed nor required.

      Note that this method is not intended to be called directly by users but by the underlying P4Java plumbing; odd results may occur if this method is called in other contexts.

      Specified by:
      processOptions in class Options
      Parameters:
      server - possibly-null IServer representing the Perforce server the options are to be used against. If this parameter is null, it is acceptable to throw an OptionsException, but it is also possible to ignore it and do the best you can with what you've got...
      Returns:
      non-null (but possibly empty) string list representing the normalized Perforce server arguments corresponding to the state of this specific options object.
      Throws:
      OptionsException - if an error occurs in options processing that is not some species of ConnectionException, RequestException, AccessException, etc.

    • setChangelistId

      public void setChangelistId(int changelistId)

    • getChangelistId

      public int getChangelistId()

    • setIncludeInherited

      public void setIncludeInherited(boolean includeInherited)

    • isIncludeInherited

      public boolean isIncludeInherited()

    • setIncludeHistory

      public void setIncludeHistory(boolean includeHistory)

    • isIncludeHistory

      public boolean isIncludeHistory()

    • setFullText

      public void setFullText(boolean fullText)

    • isFullText

      public boolean isFullText()

    • setFullTextTruncated

      public void setFullTextTruncated(boolean fullTextTruncated)

    • isFullTextTruncated

      public boolean isFullTextTruncated()

    • setMaxResults

      public void setMaxResults(int maxResults)

    • getMaxResults

      public int getMaxResults()