Package uk.ac.starlink.ttools.taplint

Enum DatalinkCode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<DatalinkCode>, ReportCode
    public enum DatalinkCode
extends java.lang.Enum<DatalinkCode>
implements ReportCode
    Enumerates known ReportCode instances for Datalink validation.
    Since:
    27 Nov 2017
    Author:
    Mark Taylor

    • Method Detail

      • values

        public static DatalinkCode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (DatalinkCode c : DatalinkCode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static DatalinkCode valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getLabel

        public java.lang.String getLabel()
        Description copied from interface: ReportCode
        Returns the 4-character label of this code.
        Specified by:
        getLabel in interface ReportCode
        Returns:
        4-character label

      • getDescription

        public java.lang.String getDescription()
        Returns a short textual description of the use of this code. It may not be very precise; if the message put through the reporting system is available, that should be used in preference.
        Returns:
        description

      • getDocument

        public DatalinkCode.Doc getDocument()
        Returns a reference to the standards document to which this code refers, if applicable.
        Returns:
        standards document reference, or null if inapplicable or unknown

      • getSection

        public java.lang.String getSection()
        Returns an indication of the location within the standards document to which this code refers.
        Returns:
        standards document section name/number/etc, or null if inapplicable or unknown