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

Enum Class PortType

java.lang.Object
java.lang.Enum<PortType>
org.odpi.openmetadata.frameworks.openmetadata.enums.PortType
All Implemented Interfaces:
Serializable, Comparable<PortType>, Constable, OpenMetadataEnum
public enum PortType extends Enum<PortType> implements OpenMetadataEnum
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 Details

    • INPUT_PORT

      public static final PortType INPUT_PORT
      Input Port - Data is passed into the process.

    • OUTPUT_PORT

      public static final PortType OUTPUT_PORT
      Output Port - Data is produced by the process.

    • INOUT_PORT

      public static final PortType INOUT_PORT
      Input-Output Port - A request-response interface is provided by the process.

    • OUTIN_PORT

      public static final PortType OUTIN_PORT
      Output-Input Port - A request-response call is made by the process.

    • OTHER

      public static final PortType OTHER
      Other - None of the above.

  • Method Details

    • values

      public static PortType[] 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 PortType 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<PortType>
      Returns:
      print out of variables in a JSON-style