Package com.perforce.p4java.option.server

Class StreamIntegrationStatusOptions

java.lang.Object
com.perforce.p4java.option.Options
com.perforce.p4java.option.server.StreamIntegrationStatusOptions
public class StreamIntegrationStatusOptions extends Options
Combined Options subclass for the server getStreamCachedIntegrationStatus methods.

  • Field Details

    • OPTIONS_SPECS

      public static final String OPTIONS_SPECS
      Options: -r, -a, -c, -s
      See Also:

    • parentToStream

      public boolean parentToStream
      If true, shows the status of integration to the stream from its parent. By default, status of integration in the other direction is shown, from the stream to its parent. Corresponds to the -r flag.

    • bidirectional

      public boolean bidirectional
      If true, shows status of integration in both directions. Corresponds to the -a flag.

    • forceUpdate

      public boolean forceUpdate
      If true, forces 'istat' to assume the cache is stale; it causes a search for pending integrations. Use of this flag can impact server performance. Corresponds to the -c flag.

    • noRefresh

      public boolean noRefresh
      If true, shows the cached state without refreshing stale data. Corresponds to the -s flag.

  • Constructor Details

    • StreamIntegrationStatusOptions

      public StreamIntegrationStatusOptions()
      Default constructor.

    • StreamIntegrationStatusOptions

      public StreamIntegrationStatusOptions(String... options)
      Strings-based constructor; see 'p4 help [command]' for possible options.

      WARNING: you should not pass more than one option or argument in each string parameter. Each option or argument should be passed-in as its own separate string parameter, without any spaces between the option and the option value (if any).

      NOTE: setting options this way always bypasses the internal options values, and getter methods against the individual values corresponding to the strings passed in to this constructor will not normally reflect the string's setting. Do not use this constructor unless you know what you're doing and / or you do not also use the field getters and setters.

      Parameters:
      options - options
      See Also:

    • StreamIntegrationStatusOptions

      public StreamIntegrationStatusOptions(boolean parentToStream, boolean bidirectional, boolean forceUpdate, boolean noRefresh)
      Explicit-value constructor.
      Parameters:
      parentToStream - parentToStream
      bidirectional - bidirectional
      forceUpdate - forceUpdate
      noRefresh - noRefresh

  • 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.
      See Also:

    • isParentToStream

      public boolean isParentToStream()

    • setParentToStream

      public StreamIntegrationStatusOptions setParentToStream(boolean parentToStream)

    • isBidirectional

      public boolean isBidirectional()

    • setBidirectional

      public StreamIntegrationStatusOptions setBidirectional(boolean bidirectional)

    • isForceUpdate

      public boolean isForceUpdate()

    • setForceUpdate

      public StreamIntegrationStatusOptions setForceUpdate(boolean forceUpdate)

    • isNoRefresh

      public boolean isNoRefresh()

    • setNoRefresh

      public StreamIntegrationStatusOptions setNoRefresh(boolean noRefresh)