Package org.apache.rat.config.exclusion

Enum StandardCollection

java.lang.Object
java.lang.Enum<StandardCollection>
org.apache.rat.config.exclusion.StandardCollection
All Implemented Interfaces:
Serializable, Comparable<StandardCollection>
public enum StandardCollection extends Enum<StandardCollection>
Collection of standard excludes. HINT: In order to work recursively each entry is prefixed with "**\/".

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ALL
    All the standard excludes combined.
    ARCH
    The files and directories created by an ARCH source code control based tool.
    BAZAAR
    The files and directories created by a Bazaar source code control based tool.
    BITKEEPER
    The files and directories created by a Bitkeeper source code control based tool.
    CVS
    The files and directories created by a CVS source code control based tool.
    DARCS
    The files and directories created by a DARCS source code control based tool.
    ECLIPSE
    The files and directories created by an Eclipse IDE based tool.
    GIT
    The files and directories created by GIT source code control to support GIT, also processes files listed in '.gitignore'.
    HIDDEN_DIR
    The hidden directories.
    HIDDEN_FILE
    The hidden files.
    IDEA
    The files and directories created by an IDEA IDE based tool.
    MAC
    The .DS_Store files on Mac computers.
    MAVEN
    The files and directories created by Maven build system based project.
    MERCURIAL
    The files and directories created by a Mercurial source code control based tool.
    MISC
    The set of miscellaneous files generally left by editors and the like.
    MKS
    The files and directories created by an MKS source code control based tool.
    RCS
    The files and directories created by an RCS source code control based tool.
    SCCS
    The files and directories created by a SCCS source code control based tool.
    SERENA_DIMENSIONS_10
    The files and directories created by a Serena Dimensions V10 change control system based tool.
    STANDARD_PATTERNS
    A standard collection of generally accepted patterns to ignore.
    STANDARD_SCMS
    A standard collection of SCMs.
    SUBVERSION
    The files and directories created by a Subversion source code control based tool.
    SURROUND_SCM
    The files and directories created by a Surround SCM source code control based tool.
    VSS
    The files and directories created by a Visual Source Safe source code control based tool.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    desc()
     
    ExtendedIterator<AbstractFileProcessorBuilder>
    fileProcessorBuilder()
    Returns the fileProcessor if it exists.
    boolean
    hasStaticDocumentNameMatcher()
    Returns true if the collections has a document name match supplier.
    Set<String>
    patterns()
    Returns combined and deduped collection of patterns.
    DocumentNameMatcher
    staticDocumentNameMatcher()
    Returns the documentNameMatchSupplier if it exists.
    static StandardCollection
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static StandardCollection[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ALL

      public static final StandardCollection ALL
      All the standard excludes combined.

    • ARCH

      public static final StandardCollection ARCH
      The files and directories created by an ARCH source code control based tool.

    • BAZAAR

      public static final StandardCollection BAZAAR
      The files and directories created by a Bazaar source code control based tool.

    • BITKEEPER

      public static final StandardCollection BITKEEPER
      The files and directories created by a Bitkeeper source code control based tool.

    • CVS

      public static final StandardCollection CVS
      The files and directories created by a CVS source code control based tool.
      See Also:

    • DARCS

      public static final StandardCollection DARCS
      The files and directories created by a DARCS source code control based tool.

    • ECLIPSE

      public static final StandardCollection ECLIPSE
      The files and directories created by an Eclipse IDE based tool.

    • GIT

      public static final StandardCollection GIT
      The files and directories created by GIT source code control to support GIT, also processes files listed in '.gitignore'.

    • HIDDEN_DIR

      public static final StandardCollection HIDDEN_DIR
      The hidden directories. Directories with names that start with .

    • HIDDEN_FILE

      public static final StandardCollection HIDDEN_FILE
      The hidden files. Directories with names that start with .

    • IDEA

      public static final StandardCollection IDEA
      The files and directories created by an IDEA IDE based tool.

    • MAC

      public static final StandardCollection MAC
      The .DS_Store files on Mac computers.

    • MAVEN

      public static final StandardCollection MAVEN
      The files and directories created by Maven build system based project.

    • MERCURIAL

      public static final StandardCollection MERCURIAL
      The files and directories created by a Mercurial source code control based tool.

    • MISC

      public static final StandardCollection MISC
      The set of miscellaneous files generally left by editors and the like.

    • MKS

      public static final StandardCollection MKS
      The files and directories created by an MKS source code control based tool.

    • RCS

      public static final StandardCollection RCS
      The files and directories created by an RCS source code control based tool.

    • SCCS

      public static final StandardCollection SCCS
      The files and directories created by a SCCS source code control based tool.

    • SERENA_DIMENSIONS_10

      public static final StandardCollection SERENA_DIMENSIONS_10
      The files and directories created by a Serena Dimensions V10 change control system based tool.

    • STANDARD_PATTERNS

      public static final StandardCollection STANDARD_PATTERNS
      A standard collection of generally accepted patterns to ignore.

    • STANDARD_SCMS

      public static final StandardCollection STANDARD_SCMS
      A standard collection of SCMs.

    • SUBVERSION

      public static final StandardCollection SUBVERSION
      The files and directories created by a Subversion source code control based tool.

    • SURROUND_SCM

      public static final StandardCollection SURROUND_SCM
      The files and directories created by a Surround SCM source code control based tool.

    • VSS

      public static final StandardCollection VSS
      The files and directories created by a Visual Source Safe source code control based tool.

  • Method Details

    • values

      public static StandardCollection[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static StandardCollection valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • desc

      public String desc()
      Returns:
      the description of the given collection.

    • patterns

      public Set<String> patterns()
      Returns combined and deduped collection of patterns.
      Returns:
      the combined and deduped collection of patterns in the given collection.

    • fileProcessorBuilder

      public ExtendedIterator<AbstractFileProcessorBuilder> fileProcessorBuilder()
      Returns the fileProcessor if it exists.
      Returns:
      the fileProcessor if it exists, null otherwise.

    • staticDocumentNameMatcher

      public DocumentNameMatcher staticDocumentNameMatcher()
      Returns the documentNameMatchSupplier if it exists.
      Returns:
      the documentNameMatchSupplier if it exists, null otherwise.

    • hasStaticDocumentNameMatcher

      public boolean hasStaticDocumentNameMatcher()
      Returns true if the collections has a document name match supplier.
      Returns:
      true if the collections has a document name match supplier.