Enum ReportType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ReportType>

    public enum ReportType
    extends java.lang.Enum<ReportType>
    Message types for use with a reporter.
    Since:
    29 Jun 2011
    Author:
    Mark Taylor
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ERROR
      Compliance error.
      FAILURE
      Unable to perform test (internal error or missing precondition).
      INFO
      Information about validator progress.
      SUMMARY
      Summary of previous reports.
      WARNING
      Questionable or non-Recommended behaviour.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ReportType forChar​(char chr)
      Returns the type instance corresponding to a given character.
      char getChar()
      Returns the single-character identifier for this type.
      java.lang.String getDescription()
      Returns the description text for this type.
      java.lang.String getName()
      Returns the human-readable name.
      java.lang.String getNames()
      Returns plural of human-readable name.
      static ReportType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ReportType[] 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 Detail

      • ERROR

        public static final ReportType ERROR
        Compliance error.
      • WARNING

        public static final ReportType WARNING
        Questionable or non-Recommended behaviour.
      • INFO

        public static final ReportType INFO
        Information about validator progress.
      • SUMMARY

        public static final ReportType SUMMARY
        Summary of previous reports.
      • FAILURE

        public static final ReportType FAILURE
        Unable to perform test (internal error or missing precondition).
    • Method Detail

      • values

        public static ReportType[] 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 (ReportType c : ReportType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ReportType 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
      • getChar

        public char getChar()
        Returns the single-character identifier for this type.
        Returns:
        identifier character
      • getName

        public java.lang.String getName()
        Returns the human-readable name.
        Returns:
        name
      • getNames

        public java.lang.String getNames()
        Returns plural of human-readable name.
        Returns:
        name plural
      • getDescription

        public java.lang.String getDescription()
        Returns the description text for this type.
        Returns:
        description
      • forChar

        public static ReportType forChar​(char chr)
        Returns the type instance corresponding to a given character.
        Parameters:
        chr - case-insensitive character
        Returns:
        type for which type.getChar()==chr