org.odpi.openmetadata.frameworks.governanceaction.properties

Enum PortType

java.lang.Object

java.lang.Enum<PortType>

org.odpi.openmetadata.frameworks.governanceaction.properties.PortType

All Implemented Interfaces:

Serializable, Comparable<PortType>

public enum PortType
extends Enum<PortType>
implements Serializable

PortType defines the different port types used for open metadata. It is used in a port definition.

• INPUT_PORT - Data is passed into the process.
• OUTPUT_PORT - Data is produced by the process.
• INOUT_PORT - A request response interface is provided by the process.
• OUTIN_PORT - A request response call is made by the process.
• OTHER - None of the above.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INOUT_PORT
INPUT_PORT
OTHER
OUTIN_PORT
OUTPUT_PORT

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENUM_TYPE_GUID
static String	ENUM_TYPE_NAME

Method Summary

Modifier and Type	Method and Description
String	getDescription() Return the default description for this enum.
String	getName() Return the default name for this enum type.
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.
String	getOpenTypeSymbolicName() Return the symbolic name for this enum that comes from the Open Metadata Type that this enum represents.
int	getOrdinal() Return the code for this enum used for indexing based on the enum value.
String	toString() Standard toString method.
static PortType	valueOf(String name) Returns the enum constant of this type with the specified name.
static PortType[]	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

INPUT_PORT

public static final PortType INPUT_PORT

OUTPUT_PORT

public static final PortType OUTPUT_PORT

INOUT_PORT

public static final PortType INOUT_PORT

OUTIN_PORT

public static final PortType OUTIN_PORT

OTHER

public static final PortType OTHER

Field Detail

ENUM_TYPE_GUID

public static final String ENUM_TYPE_GUID

See Also:

Constant Field Values

ENUM_TYPE_NAME

public static final String ENUM_TYPE_NAME

See Also:

Constant Field Values

Method Detail

values

public static PortType[] 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 (PortType c : PortType.values())
    System.out.println(c);

Returns:

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

valueOf

public static PortType 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 code for this enum used for indexing based on the enum value.

Returns:

int code number

getName

public String getName()

Return the default name for this enum type.

Returns:

String name

getDescription

public String getDescription()

Return the default description for this enum.

Returns:

String description

getOpenTypeSymbolicName

public String getOpenTypeSymbolicName()

Return the symbolic name for this enum that comes from the Open Metadata Type that this enum represents.

Returns:

int symbolic name

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<PortType>

Returns:

print out of variables in a JSON-style