Package org.apache.rat.api

Class MetaData

java.lang.Object
org.apache.rat.api.MetaData
public class MetaData extends Object
Data about the document under test..

  • Field Details

    • RAT_BASE_URL

      public static final String RAT_BASE_URL
      See Also:
      Constant Field Values

    • RAT_URL_DOCUMENT_CATEGORY

      public static final String RAT_URL_DOCUMENT_CATEGORY
      See Also:
      Constant Field Values

    • RAT_DOCUMENT_CATEGORY_VALUE_GENERATED

      public static final String RAT_DOCUMENT_CATEGORY_VALUE_GENERATED
      See Also:
      Constant Field Values

    • RAT_DOCUMENT_CATEGORY_VALUE_UNKNOWN

      public static final String RAT_DOCUMENT_CATEGORY_VALUE_UNKNOWN
      See Also:
      Constant Field Values

    • RAT_DOCUMENT_CATEGORY_VALUE_ARCHIVE

      public static final String RAT_DOCUMENT_CATEGORY_VALUE_ARCHIVE
      See Also:
      Constant Field Values

    • RAT_DOCUMENT_CATEGORY_VALUE_NOTICE

      public static final String RAT_DOCUMENT_CATEGORY_VALUE_NOTICE
      See Also:
      Constant Field Values

    • RAT_DOCUMENT_CATEGORY_VALUE_BINARY

      public static final String RAT_DOCUMENT_CATEGORY_VALUE_BINARY
      See Also:
      Constant Field Values

    • RAT_DOCUMENT_CATEGORY_VALUE_STANDARD

      public static final String RAT_DOCUMENT_CATEGORY_VALUE_STANDARD
      See Also:
      Constant Field Values

    • RAT_DOCUMENT_CATEGORY_DATUM_GENERATED

      public static final MetaData.Datum RAT_DOCUMENT_CATEGORY_DATUM_GENERATED

    • RAT_DOCUMENT_CATEGORY_DATUM_UNKNOWN

      public static final MetaData.Datum RAT_DOCUMENT_CATEGORY_DATUM_UNKNOWN

    • RAT_DOCUMENT_CATEGORY_DATUM_ARCHIVE

      public static final MetaData.Datum RAT_DOCUMENT_CATEGORY_DATUM_ARCHIVE

    • RAT_DOCUMENT_CATEGORY_DATUM_NOTICE

      public static final MetaData.Datum RAT_DOCUMENT_CATEGORY_DATUM_NOTICE

    • RAT_DOCUMENT_CATEGORY_DATUM_BINARY

      public static final MetaData.Datum RAT_DOCUMENT_CATEGORY_DATUM_BINARY

    • RAT_DOCUMENT_CATEGORY_DATUM_STANDARD

      public static final MetaData.Datum RAT_DOCUMENT_CATEGORY_DATUM_STANDARD

    • RAT_URL_HEADER_CATEGORY

      public static final String RAT_URL_HEADER_CATEGORY
      See Also:
      Constant Field Values

    • RAT_URL_LICENSE_FAMILY_CATEGORY

      public static final String RAT_URL_LICENSE_FAMILY_CATEGORY
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_CATEGORY_VALUE_GEN

      public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_GEN
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_CATEGORY_VALUE_UNKNOWN

      public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_UNKNOWN
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_CATEGORY_VALUE_ASL

      @Deprecated public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_ASL
      Deprecated.
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_CATEGORY_VALUE_OASIS

      @Deprecated public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_OASIS
      Deprecated.
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3CD

      @Deprecated public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3CD
      Deprecated.
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3C

      @Deprecated public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3C
      Deprecated.
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_CATEGORY_VALUE_DOJO

      @Deprecated public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_DOJO
      Deprecated.
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_CATEGORY_VALUE_TMF

      @Deprecated public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_TMF
      Deprecated.
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL1

      @Deprecated public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL1
      Deprecated.
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL2

      @Deprecated public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL2
      Deprecated.
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL3

      @Deprecated public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL3
      Deprecated.
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_CATEGORY_VALUE_MIT

      @Deprecated public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_MIT
      Deprecated.
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_CATEGORY_VALUE_CDDL1

      @Deprecated public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_CDDL1
      Deprecated.
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_CATEGORY_DATUM_GEN

      public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_GEN

    • RAT_LICENSE_FAMILY_CATEGORY_DATUM_UNKNOWN

      public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_UNKNOWN

    • RAT_LICENSE_FAMILY_CATEGORY_DATUM_ASL

      @Deprecated public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_ASL
      Deprecated.

    • RAT_LICENSE_FAMILY_CATEGORY_DATUM_OASIS

      @Deprecated public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_OASIS
      Deprecated.

    • RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3CD

      @Deprecated public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3CD
      Deprecated.

    • RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3C

      @Deprecated public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3C
      Deprecated.

    • RAT_LICENSE_FAMILY_CATEGORY_DATUM_DOJO

      @Deprecated public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_DOJO
      Deprecated.

    • RAT_LICENSE_FAMILY_CATEGORY_DATUM_TMF

      @Deprecated public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_TMF
      Deprecated.

    • RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL1

      @Deprecated public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL1
      Deprecated.

    • RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL2

      @Deprecated public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL2
      Deprecated.

    • RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL3

      @Deprecated public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL3
      Deprecated.

    • RAT_LICENSE_FAMILY_CATEGORY_DATUM_MIT

      @Deprecated public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_MIT
      Deprecated.

    • RAT_LICENSE_FAMILY_CATEGORY_DATUM_CDLL1

      @Deprecated public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_CDLL1
      Deprecated.

    • RAT_URL_LICENSE_FAMILY_NAME

      public static final String RAT_URL_LICENSE_FAMILY_NAME
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_NAME_VALUE_OASIS_OPEN_LICENSE

      @Deprecated public static final String RAT_LICENSE_FAMILY_NAME_VALUE_OASIS_OPEN_LICENSE
      Deprecated.
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_NAME_VALUE_MODIFIED_BSD_LICENSE

      @Deprecated public static final String RAT_LICENSE_FAMILY_NAME_VALUE_MODIFIED_BSD_LICENSE
      Deprecated.
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_NAME_VALUE_APACHE_LICENSE_VERSION_2_0

      @Deprecated public static final String RAT_LICENSE_FAMILY_NAME_VALUE_APACHE_LICENSE_VERSION_2_0
      Deprecated.
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_1

      @Deprecated public static final String RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_1
      Deprecated.
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_2

      @Deprecated public static final String RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_2
      Deprecated.
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_3

      @Deprecated public static final String RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_3
      Deprecated.
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_NAME_VALUE_MIT

      @Deprecated public static final String RAT_LICENSE_FAMILY_NAME_VALUE_MIT
      Deprecated.
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_NAME_VALUE_CDDL1

      @Deprecated public static final String RAT_LICENSE_FAMILY_NAME_VALUE_CDDL1
      Deprecated.
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_NAME_VALUE_ACADEMIC_FREE_LICENSE_VERSION_2_1

      @Deprecated public static final String RAT_LICENSE_FAMILY_NAME_VALUE_ACADEMIC_FREE_LICENSE_VERSION_2_1
      Deprecated.
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_NAME_VALUE_UNKNOWN

      public static final String RAT_LICENSE_FAMILY_NAME_VALUE_UNKNOWN
      See Also:
      Constant Field Values

    • RAT_LICENSE_FAMILY_NAME_DATUM_OASIS_OPEN_LICENSE

      @Deprecated public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_OASIS_OPEN_LICENSE
      Deprecated.

    • RAT_LICENSE_FAMILY_NAME_DATUM_MODIFIED_BSD_LICENSE

      @Deprecated public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_MODIFIED_BSD_LICENSE
      Deprecated.

    • RAT_LICENSE_FAMILY_NAME_DATUM_APACHE_LICENSE_VERSION_2_0

      @Deprecated public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_APACHE_LICENSE_VERSION_2_0
      Deprecated.

    • RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_1

      @Deprecated public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_1
      Deprecated.

    • RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_2

      @Deprecated public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_2
      Deprecated.

    • RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_3

      @Deprecated public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_3
      Deprecated.

    • RAT_LICENSE_FAMILY_NAME_DATUM_MIT

      @Deprecated public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_MIT
      Deprecated.

    • RAT_LICENSE_FAMILY_NAME_DATUM_CDDL1

      @Deprecated public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_CDDL1
      Deprecated.

    • RAT_LICENSE_FAMILY_NAME_DATUM_ACADEMIC_FREE_LICENSE_VERSION_2_1

      @Deprecated public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_ACADEMIC_FREE_LICENSE_VERSION_2_1
      Deprecated.

    • RAT_LICENSE_FAMILY_NAME_DATUM_UNKNOWN

      public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_UNKNOWN

    • RAT_URL_HEADER_SAMPLE

      public static final String RAT_URL_HEADER_SAMPLE
      See Also:
      Constant Field Values

    • RAT_URL_APPROVED_LICENSE

      public static final String RAT_URL_APPROVED_LICENSE
      See Also:
      Constant Field Values

    • RAT_APPROVED_LICENSE_VALUE_TRUE

      public static final String RAT_APPROVED_LICENSE_VALUE_TRUE

    • RAT_APPROVED_LICENSE_VALUE_FALSE

      public static final String RAT_APPROVED_LICENSE_VALUE_FALSE

    • RAT_APPROVED_LICENSE_DATUM_TRUE

      public static final MetaData.Datum RAT_APPROVED_LICENSE_DATUM_TRUE

    • RAT_APPROVED_LICENSE_DATUM_FALSE

      public static final MetaData.Datum RAT_APPROVED_LICENSE_DATUM_FALSE

    • RAT_APPROVED_LICENSE_DATIM_TRUE

      @Deprecated public static final MetaData.Datum RAT_APPROVED_LICENSE_DATIM_TRUE
      Deprecated.

    • RAT_APPROVED_LICENSE_DATIM_FALSE

      @Deprecated public static final MetaData.Datum RAT_APPROVED_LICENSE_DATIM_FALSE
      Deprecated.

  • Constructor Details

    • MetaData

      public MetaData()
      Create metadata without a content type.

  • Method Details

    • reportOnLicense

      public void reportOnLicense​(ILicense license)
      Add the license information to the metadata.
      Parameters:
      license - the license to add metadata for.

    • getData

      public Collection<MetaData.Datum> getData()
      Gets all data.
      Returns:
      unmodifiable view of the meta data.

    • add

      public void add​(MetaData.Datum datum)
      Adds a new datum. Existing data with the same name are not replaced.
      Parameters:
      datum - datum to add.
      See Also:
      set(org.apache.rat.api.MetaData.Datum)

    • set

      public void set​(MetaData.Datum datum)
      Puts in a new datum replacing any existing data. Any current data matching the name are removed.
      Parameters:
      datum - not null
      See Also:
      add(org.apache.rat.api.MetaData.Datum)

    • get

      public MetaData.Datum get​(String name)
      Gets the first datum matching the given name.
      Parameters:
      name - not null
      Returns:
      the matching datum first added when there is any matching data, null otherwise

    • value

      public String value​(String name)
      Gets the value of the first datum matching the given name.
      Parameters:
      name - not null
      Returns:
      the value of the matchin datum first added when there is any matching data, null otherwise

    • clear

      public boolean clear​(String name)
      Removes all data matching the given name.
      Parameters:
      name - not null
      Returns:
      true if any data match, false otherwise

    • clear

      public void clear()
      Clears all data.