Module org.mule.sdk.api

Package org.mule.sdk.api.metadata.resolving

Enum Class MetadataComponent

java.lang.Object

java.lang.Enum<MetadataComponent>

org.mule.sdk.api.metadata.resolving.MetadataComponent

All Implemented Interfaces:

Serializable, Comparable<MetadataComponent>, Constable

@MinMuleVersion("4.5.0")
public enum MetadataComponent
extends Enum<MetadataComponent>

Enumerates all the components that can be retrieved in a MetadataResult.

Since:

1.0

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
COMPONENT	Component that retrieves metadata for an Operation or a Source.
ENTITY	Component that retrieves metadata about DSQL entities.
INPUT	Component that retrieves metadata for an Operation or Source parameter.
KEYS	Component that retrieves metadata about the keys.
OUTPUT_ATTRIBUTES	Component that retrieves metadata for an Operation or Source output attributes type.
OUTPUT_PAYLOAD	Component that retrieves metadata for an Operation or Source output type.

Method Summary

Modifier and Type	Method	Description
static MetadataComponent	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MetadataComponent[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OUTPUT_ATTRIBUTES

public static final MetadataComponent OUTPUT_ATTRIBUTES

Component that retrieves metadata for an Operation or Source output attributes type.

OUTPUT_PAYLOAD

public static final MetadataComponent OUTPUT_PAYLOAD

Component that retrieves metadata for an Operation or Source output type.

INPUT

public static final MetadataComponent INPUT

Component that retrieves metadata for an Operation or Source parameter.

COMPONENT

public static final MetadataComponent COMPONENT

Component that retrieves metadata for an Operation or a Source.

ENTITY

public static final MetadataComponent ENTITY

Component that retrieves metadata about DSQL entities.

KEYS

public static final MetadataComponent KEYS

Component that retrieves metadata about the keys.

Method Details

values

public static MetadataComponent[] 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 MetadataComponent 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