Package com.perforce.p4java.option.server

Class LogTailOptions

  • public class LogTailOptions
extends Options
    Options class for Perforce IOptionsServer.getLogtail methods.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected long blockSize
      If greater than zero, specifies the block size in bytes (default 8192).
      protected int maxBlocks
      If greater than zero, specifies a maximum number of blocks to output.
      static java.lang.String OPTIONS_SPECS
      Options: -b[blockSize], -s[startingOffset], -m[maxBlocks]
      protected long startingOffset
      If positive, enables you to specify the offset from the beginning of the file (in bytes).

    • Constructor Summary

      Constructors 
      Constructor Description
      LogTailOptions()
      Default constructor.
      LogTailOptions​(long blockSize, long startingOffset, int maxBlocks)
      Explicit value constructor.
      LogTailOptions​(java.lang.String... options)
      Strings-based constructor; see 'p4 help [command]' for possible options.

    • Field Detail

      • OPTIONS_SPECS

        public static final java.lang.String OPTIONS_SPECS
        Options: -b[blockSize], -s[startingOffset], -m[maxBlocks]
        See Also:
        Constant Field Values

      • blockSize

        protected long blockSize
        If greater than zero, specifies the block size in bytes (default 8192). Corresponds to the -b flag.

      • startingOffset

        protected long startingOffset
        If positive, enables you to specify the offset from the beginning of the file (in bytes). Corresponds to the -s flag.

      • maxBlocks

        protected int maxBlocks
        If greater than zero, specifies a maximum number of blocks to output. This flag is ignored unless the -s flag is specified. Corresponds to the -m flag.

    • Constructor Detail

      • LogTailOptions

        public LogTailOptions()
        Default constructor.

      • LogTailOptions

        public LogTailOptions​(java.lang.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:
        Options(java.lang.String...)

      • LogTailOptions

        public LogTailOptions​(long blockSize,
                      long startingOffset,
                      int maxBlocks)
        Explicit value constructor.
        Parameters:
        blockSize - blockSize
        startingOffset - startingOffset
        maxBlocks - maxBlocks

    • Method Detail

      • processOptions

        public java.util.List<java.lang.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:
        Options.processOptions(com.perforce.p4java.server.IServer)

      • getBlockSize

        public long getBlockSize()
        Gets the block size (in bytes).
        Returns:
        the block size (in bytes)

      • setBlockSize

        public LogTailOptions setBlockSize​(long blockSize)
        Sets the block size (in bytes).
        Parameters:
        blockSize - the block size (in bytes)
        Returns:
        the log tail options

      • getStartingOffset

        public long getStartingOffset()
        Gets the offset from the beginning of the file (in bytes).
        Returns:
        the starting offset (in bytes)

      • setStartingOffset

        public LogTailOptions setStartingOffset​(long startingOffset)
        Sets the offset from the beginning of the file (in bytes).
        Parameters:
        startingOffset - the starting offset (in bytes)
        Returns:
        the log tail options

      • getMaxBlocks

        public int getMaxBlocks()
        Gets the maximum number of blocks to output.
        Returns:
        the maximum blocks

      • setMaxBlocks

        public LogTailOptions setMaxBlocks​(int maxBlocks)
        Sets the maximum number of blocks to output.
        Parameters:
        maxBlocks - the maximum blocks
        Returns:
        the log tail options