Package org.apache.rat.api

Class MetaData

  • public class MetaData
extends java.lang.Object
    Data about the subject.

    • Field Detail

      • RAT_URL_DOCUMENT_CATEGORY

        public static final java.lang.String RAT_URL_DOCUMENT_CATEGORY
        See Also:
        Constant Field Values

      • RAT_DOCUMENT_CATEGORY_VALUE_GENERATED

        public static final java.lang.String RAT_DOCUMENT_CATEGORY_VALUE_GENERATED
        See Also:
        Constant Field Values

      • RAT_DOCUMENT_CATEGORY_VALUE_UNKNOWN

        public static final java.lang.String RAT_DOCUMENT_CATEGORY_VALUE_UNKNOWN
        See Also:
        Constant Field Values

      • RAT_DOCUMENT_CATEGORY_VALUE_ARCHIVE

        public static final java.lang.String RAT_DOCUMENT_CATEGORY_VALUE_ARCHIVE
        See Also:
        Constant Field Values

      • RAT_DOCUMENT_CATEGORY_VALUE_NOTICE

        public static final java.lang.String RAT_DOCUMENT_CATEGORY_VALUE_NOTICE
        See Also:
        Constant Field Values

      • RAT_DOCUMENT_CATEGORY_VALUE_BINARY

        public static final java.lang.String RAT_DOCUMENT_CATEGORY_VALUE_BINARY
        See Also:
        Constant Field Values

      • RAT_DOCUMENT_CATEGORY_VALUE_STANDARD

        public static final java.lang.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 java.lang.String RAT_URL_HEADER_CATEGORY
        See Also:
        Constant Field Values

      • RAT_URL_LICENSE_FAMILY_CATEGORY

        public static final java.lang.String RAT_URL_LICENSE_FAMILY_CATEGORY
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_CATEGORY_VALUE_GEN

        public static final java.lang.String RAT_LICENSE_FAMILY_CATEGORY_VALUE_GEN
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_CATEGORY_VALUE_UNKNOWN

        public static final java.lang.String RAT_LICENSE_FAMILY_CATEGORY_VALUE_UNKNOWN
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_CATEGORY_VALUE_ASL

        public static final java.lang.String RAT_LICENSE_FAMILY_CATEGORY_VALUE_ASL
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_CATEGORY_VALUE_OASIS

        public static final java.lang.String RAT_LICENSE_FAMILY_CATEGORY_VALUE_OASIS
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3CD

        public static final java.lang.String RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3CD
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3C

        public static final java.lang.String RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3C
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_CATEGORY_VALUE_DOJO

        public static final java.lang.String RAT_LICENSE_FAMILY_CATEGORY_VALUE_DOJO
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_CATEGORY_VALUE_TMF

        public static final java.lang.String RAT_LICENSE_FAMILY_CATEGORY_VALUE_TMF
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL1

        public static final java.lang.String RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL1
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL2

        public static final java.lang.String RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL2
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL3

        public static final java.lang.String RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL3
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_CATEGORY_VALUE_MIT

        public static final java.lang.String RAT_LICENSE_FAMILY_CATEGORY_VALUE_MIT
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_CATEGORY_VALUE_CDDL1

        public static final java.lang.String RAT_LICENSE_FAMILY_CATEGORY_VALUE_CDDL1
        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

        public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_ASL

      • RAT_LICENSE_FAMILY_CATEGORY_DATUM_OASIS

        public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_OASIS

      • RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3CD

        public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3CD

      • RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3C

        public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3C

      • RAT_LICENSE_FAMILY_CATEGORY_DATUM_DOJO

        public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_DOJO

      • RAT_LICENSE_FAMILY_CATEGORY_DATUM_TMF

        public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_TMF

      • RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL1

        public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL1

      • RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL2

        public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL2

      • RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL3

        public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL3

      • RAT_LICENSE_FAMILY_CATEGORY_DATUM_MIT

        public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_MIT

      • RAT_LICENSE_FAMILY_CATEGORY_DATUM_CDLL1

        public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_CDLL1

      • RAT_URL_LICENSE_FAMILY_NAME

        public static final java.lang.String RAT_URL_LICENSE_FAMILY_NAME
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_NAME_VALUE_W3C_SOFTWARE_COPYRIGHT

        public static final java.lang.String RAT_LICENSE_FAMILY_NAME_VALUE_W3C_SOFTWARE_COPYRIGHT
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_NAME_VALUE_W3C_DOCUMENT_COPYRIGHT

        public static final java.lang.String RAT_LICENSE_FAMILY_NAME_VALUE_W3C_DOCUMENT_COPYRIGHT
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_NAME_VALUE_OASIS_OPEN_LICENSE

        public static final java.lang.String RAT_LICENSE_FAMILY_NAME_VALUE_OASIS_OPEN_LICENSE
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_NAME_VALUE_MODIFIED_BSD_LICENSE

        public static final java.lang.String RAT_LICENSE_FAMILY_NAME_VALUE_MODIFIED_BSD_LICENSE
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_NAME_VALUE_APACHE_LICENSE_VERSION_2_0

        public static final java.lang.String RAT_LICENSE_FAMILY_NAME_VALUE_APACHE_LICENSE_VERSION_2_0
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_1

        public static final java.lang.String RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_1
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_2

        public static final java.lang.String RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_2
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_3

        public static final java.lang.String RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_3
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_NAME_VALUE_MIT

        public static final java.lang.String RAT_LICENSE_FAMILY_NAME_VALUE_MIT
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_NAME_VALUE_CDDL1

        public static final java.lang.String RAT_LICENSE_FAMILY_NAME_VALUE_CDDL1
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_NAME_VALUE_ACADEMIC_FREE_LICENSE_VERSION_2_1

        public static final java.lang.String RAT_LICENSE_FAMILY_NAME_VALUE_ACADEMIC_FREE_LICENSE_VERSION_2_1
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_NAME_VALUE_UNKNOWN

        public static final java.lang.String RAT_LICENSE_FAMILY_NAME_VALUE_UNKNOWN
        See Also:
        Constant Field Values

      • RAT_LICENSE_FAMILY_NAME_DATUM_W3C_SOFTWARE_COPYRIGHT

        public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_W3C_SOFTWARE_COPYRIGHT

      • RAT_LICENSE_FAMILY_NAME_DATUM_W3C_DOCUMENT_COPYRIGHT

        public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_W3C_DOCUMENT_COPYRIGHT

      • RAT_LICENSE_FAMILY_NAME_DATUM_OASIS_OPEN_LICENSE

        public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_OASIS_OPEN_LICENSE

      • RAT_LICENSE_FAMILY_NAME_DATUM_MODIFIED_BSD_LICENSE

        public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_MODIFIED_BSD_LICENSE

      • RAT_LICENSE_FAMILY_NAME_DATUM_APACHE_LICENSE_VERSION_2_0

        public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_APACHE_LICENSE_VERSION_2_0

      • RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_1

        public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_1

      • RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_2

        public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_2

      • RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_3

        public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_3

      • RAT_LICENSE_FAMILY_NAME_DATUM_MIT

        public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_MIT

      • RAT_LICENSE_FAMILY_NAME_DATUM_CDDL1

        public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_CDDL1

      • RAT_LICENSE_FAMILY_NAME_DATUM_ACADEMIC_FREE_LICENSE_VERSION_2_1

        public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_ACADEMIC_FREE_LICENSE_VERSION_2_1

      • RAT_LICENSE_FAMILY_NAME_DATUM_UNKNOWN

        public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_UNKNOWN

      • RAT_URL_HEADER_SAMPLE

        public static final java.lang.String RAT_URL_HEADER_SAMPLE
        See Also:
        Constant Field Values

      • RAT_URL_APPROVED_LICENSE

        public static final java.lang.String RAT_URL_APPROVED_LICENSE
        See Also:
        Constant Field Values

      • RAT_APPROVED_LICENSE_VALUE_TRUE

        public static final java.lang.String RAT_APPROVED_LICENSE_VALUE_TRUE

      • RAT_APPROVED_LICENSE_VALUE_FALSE

        public static final java.lang.String RAT_APPROVED_LICENSE_VALUE_FALSE

      • RAT_APPROVED_LICENSE_DATIM_TRUE

        public static final MetaData.Datum RAT_APPROVED_LICENSE_DATIM_TRUE

      • RAT_APPROVED_LICENSE_DATIM_FALSE

        public static final MetaData.Datum RAT_APPROVED_LICENSE_DATIM_FALSE

      • data

        private final java.util.List<MetaData.Datum> data
        Only likely to be a small quantity of data so trade some performance for simplicity.

    • Constructor Detail

      • MetaData

        public MetaData()

      • MetaData

        public MetaData​(ContentType contentType)

    • Method Detail

      • getContentType

        public ContentType getContentType()
        Gets the content type for the subject.
        Returns:
        or null when the type is unknown

      • setContentType

        public void setContentType​(ContentType contentType)
        Sets the content type for this subject.
        Parameters:
        contentType - ContentType, or null when the content type is unknown

      • getData

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

      • get

        public MetaData.Datum get​(java.lang.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 java.lang.String value​(java.lang.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​(java.lang.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.