Package org.odpi.openmetadata.frameworks.governanceaction.search

Enum Class MatchCriteria

java.lang.Object

java.lang.Enum<MatchCriteria>

org.odpi.openmetadata.frameworks.governanceaction.search.MatchCriteria

All Implemented Interfaces:

Serializable, Comparable<MatchCriteria>, Constable

public enum MatchCriteria
extends Enum<MatchCriteria>

The MatchCriteria enum defines how the metadata instances in the metadata store should be matched against the properties supplied on the search request.

• ALL means all properties must match.
• ANY means a match on any of properties is good enough.
• NONE means return instances where none of the supplied properties match.

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
ALL	All properties must match.
ANY	A match on any of the properties in the instance is good enough.
NONE	Return instances where none of the supplied properties match.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description of the match criteria.
String	getName()	Return the default name of the match criteria.
int	getOrdinal()	Return the numeric representation of the match criteria.
String	toString()	toString() JSON-style
static MatchCriteria	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MatchCriteria[]	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

ALL

public static final MatchCriteria ALL

All properties must match.

ANY

public static final MatchCriteria ANY

A match on any of the properties in the instance is good enough.

NONE

public static final MatchCriteria NONE

Return instances where none of the supplied properties match.

Method Details

values

public static MatchCriteria[] 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 MatchCriteria 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 match criteria.

Returns:

int ordinal

getName

public String getName()

Return the default name of the match criteria.

Returns:

String name

getDescription

public String getDescription()

Return the default description of the match criteria.

Returns:

String description

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<MatchCriteria>

Returns:

string description