Package com.perforce.p4java.option.server

Class ReposOptions

  • public class ReposOptions
extends Options
    Options required by the repos command

    -e|-E filter -m max -u user -O owner --from=origin

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected int maxResults
      If greater than zero, limit output to the first maxResults number of repos.
      protected java.lang.String nameFilter
      If non-null, limits output to repos whose name matches the nameFilter pattern.
      static java.lang.String OPTIONS_SPECS  
      protected java.lang.String owner
      If non-null, limit qualifying repos to those owned by the named owner.
      protected java.lang.String user
      If non-null, limit qualifying repos to those owned by the named user.

    • Constructor Summary

      Constructors 
      Constructor Description
      ReposOptions()
      Default constructor; sets all fields to null, zero, or false.
      ReposOptions​(java.lang.String... options)
      Strings-based constructor; see 'p4 help [command]' for possible options.

    • Field Detail

      • nameFilter

        protected java.lang.String nameFilter
        If non-null, limits output to repos whose name matches the nameFilter pattern. Corresponds to -enameFilter flag

      • maxResults

        protected int maxResults
        If greater than zero, limit output to the first maxResults number of repos. Corresponds to -m flag.

      • user

        protected java.lang.String user
        If non-null, limit qualifying repos to those owned by the named user. Corresponds to -u name flag.

      • owner

        protected java.lang.String owner
        If non-null, limit qualifying repos to those owned by the named owner. Corresponds to -O name flag.

    • Constructor Detail

      • ReposOptions

        public ReposOptions()
        Default constructor; sets all fields to null, zero, or false.

      • ReposOptions

        public ReposOptions​(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...)

    • 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)

      • getNameFilter

        public java.lang.String getNameFilter()

      • setNameFilter

        public ReposOptions setNameFilter​(java.lang.String nameFilter)

      • getMaxResults

        public int getMaxResults()

      • setMaxResults

        public ReposOptions setMaxResults​(int maxResults)

      • getUser

        public java.lang.String getUser()

      • setUser

        public ReposOptions setUser​(java.lang.String user)

      • getOwner

        public java.lang.String getOwner()

      • setOwner

        public ReposOptions setOwner​(java.lang.String owner)