org.odpi.openmetadata.accessservices.subjectarea.properties.enums

Enum StarRating

java.lang.Object

java.lang.Enum<StarRating>

org.odpi.openmetadata.accessservices.subjectarea.properties.enums.StarRating

All Implemented Interfaces:

Serializable, Comparable<StarRating>

public enum StarRating
extends Enum<StarRating>
implements Serializable

Level of support or appreciation for an item.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FiveStar Five star rating.
FourStar Four star rating.
NotRecommended This content is not recommended.
OneStar One star rating.
ThreeStar Three star rating.
TwoStar Two star rating.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Return the description for the enum.
String	getName() Return the descriptive name for the StarRating enum instance
int	getOrdinal() Return the numerical value for the enum.
static StarRating	valueOf(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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NotRecommended

public static final StarRating NotRecommended

This content is not recommended.

OneStar

public static final StarRating OneStar

One star rating.

TwoStar

public static final StarRating TwoStar

Two star rating.

ThreeStar

public static final StarRating ThreeStar

Three star rating.

FourStar

public static final StarRating FourStar

Four star rating.

FiveStar

public static final StarRating FiveStar

Five star rating.

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(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getOrdinal

public int getOrdinal()

Return the numerical value for the enum.

Returns:

int enum value ordinal

getDescription

public String getDescription()

Return the description for the enum.

Returns:

String description

getName

public String getName()

Return the descriptive name for the StarRating enum instance

Returns:

String name