Package org.odpi.openmetadata.frameworks.openmetadata.enums

Enum Class CommentType

java.lang.Object

java.lang.Enum<CommentType>

org.odpi.openmetadata.frameworks.openmetadata.enums.CommentType

All Implemented Interfaces:

Serializable, Comparable<CommentType>, Constable, OpenMetadataEnum

public enum CommentType
extends Enum<CommentType>
implements OpenMetadataEnum

The CommentType allows comments to be used to ask and answer questions as well as make suggestions and provide useful information to other users.

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
ANSWER	Answer - Answers a question (posted as a reply to the question).
OTHER	Other - Unknown comment type.
QUESTION	Question - Asks a question to the people owning, managing or using the element.
STANDARD_COMMENT	Comment - General comment about the element.
SUGGESTION	Suggestion - Provides a suggestion on how to improve the element or its properties and description.
USAGE_EXPERIENCE	Experience - Describes situations where this asset has been used and related hints and tips.

Method Summary

Modifier and Type	Method	Description
String	getCategory()	Return the category for this value.
String	getDescription()	Return the default description of the enumeration.
String	getDescriptionGUID()	Return the unique identifier for the valid value that represents the enum value.
String	getName()	Return the default name of the enumeration.
static String	getOpenTypeDescription()	Return the description for the open metadata enum type that this enum class represents.
static String	getOpenTypeDescriptionGUID()	Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.
static String	getOpenTypeDescriptionWiki()	Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.
static String	getOpenTypeGUID()	Return the unique identifier for the open metadata enum type that this enum class represents.
static String	getOpenTypeName()	Return the unique name for the open metadata enum type that this enum class represents.
int	getOrdinal()	Return the numeric representation of the enumeration.
String	getQualifiedName()	Return the qualified name for this value.
boolean	isDefault()	Return whether the enum is the default value or not.
String	toString()	Standard toString method.
static CommentType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CommentType[]	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

STANDARD_COMMENT

public static final CommentType STANDARD_COMMENT

Comment - General comment about the element.

QUESTION

public static final CommentType QUESTION

Question - Asks a question to the people owning, managing or using the element.

ANSWER

public static final CommentType ANSWER

Answer - Answers a question (posted as a reply to the question).

SUGGESTION

public static final CommentType SUGGESTION

Suggestion - Provides a suggestion on how to improve the element or its properties and description.

USAGE_EXPERIENCE

public static final CommentType USAGE_EXPERIENCE

Experience - Describes situations where this asset has been used and related hints and tips.

OTHER

public static final CommentType OTHER

Other - Unknown comment type.

Method Details

values

public static CommentType[] 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 CommentType 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 numeric representation of the enumeration.

Specified by:

getOrdinal in interface OpenMetadataEnum

Returns:

int ordinal

getName

public String getName()

Return the default name of the enumeration.

Specified by:

getName in interface OpenMetadataEnum

Returns:

String name

getDescription

public String getDescription()

Return the default description of the enumeration.

Specified by:

getDescription in interface OpenMetadataEnum

Returns:

String description

getDescriptionGUID

public String getDescriptionGUID()

Return the unique identifier for the valid value that represents the enum value.

Specified by:

getDescriptionGUID in interface OpenMetadataEnum

Returns:

guid

isDefault

public boolean isDefault()

Return whether the enum is the default value or not.

Specified by:

isDefault in interface OpenMetadataEnum

Returns:

boolean

getOpenTypeGUID

public static String getOpenTypeGUID()

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

Returns:

string guid

getOpenTypeName

public static String getOpenTypeName()

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

Returns:

string name

getOpenTypeDescription

public static String getOpenTypeDescription()

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

Returns:

string description

getOpenTypeDescriptionGUID

public static String getOpenTypeDescriptionGUID()

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

Returns:

string guid

getOpenTypeDescriptionWiki

public static String getOpenTypeDescriptionWiki()

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

Returns:

string guid

getQualifiedName

public String getQualifiedName()

Return the qualified name for this value.

Returns:

string

getCategory

public String getCategory()

Return the category for this value.

Returns:

string

toString

public String toString()

Standard toString method.

Overrides:

toString in class Enum<CommentType>

Returns:

print out of variables in a JSON-style