Class GetFileAnnotationsOptions

    • Field Detail

      • OPTIONS_SPECS

        public static final java.lang.String OPTIONS_SPECS
        Options: -a, -c, -i, -db, -dw, -dl, -I, -q, -t
        See Also:
        Constant Field Values
      • allResults

        protected boolean allResults
        If true, include both deleted files and lines no longer present at the head revision; corresponds to the -a flag.
      • useChangeNumbers

        protected boolean useChangeNumbers
        If true, annotate with change numbers rather than revision numbers with each line; correspond to the -c flag.
      • followBranches

        protected boolean followBranches
        If true, follow branches; corresponds to the -f flag.
      • wsOpts

        protected DiffType wsOpts
        If non-null, use the DiffType value to determine whitespace options.
      • ignoreWhitespaceChanges

        protected boolean ignoreWhitespaceChanges
        If true, ignore whitespace changes; corresponds to -db.
      • ignoreWhitespace

        protected boolean ignoreWhitespace
        If true, ignore whitespace; corresponds to -dw.
      • ignoreLineEndings

        protected boolean ignoreLineEndings
        If true, ignore line endisngs; corresponds to -dl.
      • followAllIntegrations

        protected boolean followAllIntegrations
        If true, follows all integrations into the file; corresponds to -I.
      • suppressHeader

        protected boolean suppressHeader
        If true, suppresses the one-line header that is displayed by default for each file; corresponds to -q.
      • showBinaryContent

        protected boolean showBinaryContent
        If true, forces 'p4 annotate' to display binary files; corresponds to -t.
    • Constructor Detail

      • GetFileAnnotationsOptions

        public GetFileAnnotationsOptions()
        Default constructor.
      • GetFileAnnotationsOptions

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

        public GetFileAnnotationsOptions​(boolean allResults,
                                         boolean useChangeNumbers,
                                         boolean followBranches,
                                         DiffType wsOpts)
        Explicit value constructor.
        Parameters:
        allResults - allResults
        useChangeNumbers - useChangeNumbers
        followBranches - followBranches
        wsOpts - wsOpts
      • GetFileAnnotationsOptions

        public GetFileAnnotationsOptions​(boolean allResults,
                                         boolean useChangeNumbers,
                                         boolean followBranches,
                                         boolean ignoreWhitespaceChanges,
                                         boolean ignoreWhitespace,
                                         boolean ignoreLineEndings)
        Explicit value constructor.
        Parameters:
        allResults - allResults
        useChangeNumbers - useChangeNumbers
        followBranches - followBranches
        ignoreWhitespaceChanges - ignoreWhitespaceChanges
        ignoreWhitespace - ignoreWhitespace
        ignoreLineEndings - ignoreLineEndings
      • GetFileAnnotationsOptions

        public GetFileAnnotationsOptions​(boolean allResults,
                                         boolean useChangeNumbers,
                                         boolean followBranches,
                                         boolean ignoreWhitespaceChanges,
                                         boolean ignoreWhitespace,
                                         boolean ignoreLineEndings,
                                         boolean followAllIntegrations)
        Explicit value constructor.
        Parameters:
        allResults - allResults
        useChangeNumbers - useChangeNumbers
        followBranches - followBranches
        ignoreWhitespaceChanges - ignoreWhitespaceChanges
        ignoreWhitespace - ignoreWhitespace
        ignoreLineEndings - ignoreLineEndings
        followAllIntegrations - followAllIntegrations
    • Method Detail

      • processOptions

        public java.util.List<java.lang.String> processOptions​(IServer server)
                                                        throws OptionsException
        If the wsOpts field is non-null, those values will override the corresponding explicit boolean fields.
        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)
      • isAllResults

        public boolean isAllResults()
      • isUseChangeNumbers

        public boolean isUseChangeNumbers()
      • isFollowBranches

        public boolean isFollowBranches()
      • getWsOpts

        public DiffType getWsOpts()
      • isIgnoreWhitespaceChanges

        public boolean isIgnoreWhitespaceChanges()
      • setIgnoreWhitespaceChanges

        public GetFileAnnotationsOptions setIgnoreWhitespaceChanges​(boolean ignoreWhitespaceChanges)
      • isIgnoreWhitespace

        public boolean isIgnoreWhitespace()
      • isIgnoreLineEndings

        public boolean isIgnoreLineEndings()
      • isFollowAllIntegrations

        public boolean isFollowAllIntegrations()
      • isSuppressHeader

        public boolean isSuppressHeader()
      • isShowBinaryContent

        public boolean isShowBinaryContent()