Package org.odpi.openmetadata.accessservices.communityprofile.properties

Enum Class StarRating

java.lang.Object

java.lang.Enum<StarRating>

org.odpi.openmetadata.accessservices.communityprofile.properties.StarRating

All Implemented Interfaces:

Serializable, Comparable<StarRating>, Constable

public enum StarRating
extends Enum<StarRating>
implements Serializable

A StarRating defines the rating that a user has placed against an element. This ranges from not recommended through to five stars (excellent).

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FIVE_STARS
FOUR_STARS
NO_RECOMMENDATION
ONE_STAR
THREE_STARS
TWO_STARS

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description for the star rating for this enum instance.
String	getName()	Return the default symbol for this enum instance.
String	getOpenTypeGUID()	Return the unique identifier for the open metadata enum type that this enum class represents.
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
String	toString()	Standard toString method.
static StarRating	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StarRating[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

public static StarRating[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static StarRating valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getOrdinal

public int getOrdinal()

Return the code for this enum instance

Returns:

int star rating code

getName

public String getName()

Return the default symbol for this enum instance.

Returns:

String default symbol

getDescription

public 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 String getOpenTypeGUID()

Return the unique identifier for the open metadata enum type that this enum class represents.

Returns:

string guid

getOpenTypeName

public String getOpenTypeName()

Return the unique name for the open metadata enum type that this enum class represents.

Returns:

string name

toString

public String toString()

Standard toString method.

Overrides:

toString in class Enum<StarRating>

Returns:

print out of variables in a JSON-style