Enum StarRating

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

    public enum StarRating
    extends java.lang.Enum<StarRating>
    implements java.io.Serializable
    A StarRating defines the rating that a user has placed against an element. This ranges from not recommended through to five stars (excellent).
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Return the default description for the star rating for this enum instance.
      java.lang.String getName()
      Return the default symbol for this enum instance.
      java.lang.String getOpenTypeGUID()
      Return the unique identifier for the open metadata enum type that this enum class represents.
      java.lang.String getOpenTypeName()
      Return the unique name for the open metadata enum type that this enum class represents.
      int getOpenTypeOrdinal()
      Return the code for this enum that comes from the Open Metadata Type that this enum represents.
      int getOrdinal()
      Return the code for this enum instance
      java.lang.String toString()
      Standard toString method.
      static StarRating valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static StarRating[] 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, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • NO_RECOMMENDATION

        public static final StarRating NO_RECOMMENDATION
      • ONE_STAR

        public static final StarRating ONE_STAR
      • TWO_STARS

        public static final StarRating TWO_STARS
      • THREE_STARS

        public static final StarRating THREE_STARS
      • FOUR_STARS

        public static final StarRating FOUR_STARS
      • FIVE_STARS

        public static final StarRating FIVE_STARS
    • Method Detail

      • values

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

        public static StarRating 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
      • getOrdinal

        public int getOrdinal()
        Return the code for this enum instance
        Returns:
        int star rating code
      • getName

        public java.lang.String getName()
        Return the default symbol for this enum instance.
        Returns:
        String default symbol
      • getDescription

        public java.lang.String getDescription()
        Return the default description for the star rating for this enum instance.
        Returns:
        String default description
      • getOpenTypeOrdinal

        public int getOpenTypeOrdinal()
        Return the code for this enum that comes from the Open Metadata Type that this enum represents.
        Returns:
        int code number
      • getOpenTypeGUID

        public java.lang.String getOpenTypeGUID()
        Return the unique identifier for the open metadata enum type that this enum class represents.
        Returns:
        string guid
      • getOpenTypeName

        public java.lang.String getOpenTypeName()
        Return the unique name for the open metadata enum type that this enum class represents.
        Returns:
        string name
      • toString

        public java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class java.lang.Enum<StarRating>
        Returns:
        print out of variables in a JSON-style