Module org.mule.sdk.api

Package org.mule.sdk.api.metadata

Class NullMetadataResolver

java.lang.Object

org.mule.sdk.api.metadata.NullMetadataResolver

All Implemented Interfaces:

org.mule.runtime.api.metadata.resolving.NamedTypeResolver, AttributesTypeResolver<Object>, InputTypeResolver<Object>, NamedTypeResolver, OutputTypeResolver<Object>, TypeKeysResolver

@MinMuleVersion("4.5.0")
public final class NullMetadataResolver
extends Object
implements InputTypeResolver<Object>, TypeKeysResolver, OutputTypeResolver<Object>, AttributesTypeResolver<Object>

Null implementation of InputTypeResolver, AttributesTypeResolver and TypeKeysResolver, used to represent the absence of any of them when required.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NULL_CATEGORY_NAME
static final String	NULL_RESOLVER_NAME

Constructor Summary

Constructors

Constructor	Description
NullMetadataResolver()

Method Summary

Modifier and Type	Method	Description
org.mule.metadata.api.model.MetadataType	getAttributesType(MetadataContext context, Object key)	Null implementation of AttributesTypeResolver, used when no implementation is provided by the connector developer.
String	getCategoryName()	This is the name of the TypeResolver Category, that relates a given TypeKeysResolver with the input and output type resolvers.
org.mule.metadata.api.model.MetadataType	getInputMetadata(MetadataContext context, Object key)	Null implementation of InputTypeResolver, used when no implementation is provided by the connector developer.
Set<MetadataKey>	getKeys(MetadataContext context)	Null implementation of TypeKeysResolver, used when no implementation is provided by the connector developer.
org.mule.metadata.api.model.MetadataType	getOutputType(MetadataContext context, Object key)	Null implementation of OutputTypeResolver, used when no implementation is provided by the connector developer.
String	getResolverName()	This is the name of the TypeResolver.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NULL_CATEGORY_NAME

public static final String NULL_CATEGORY_NAME

See Also:

• Constant Field Values

NULL_RESOLVER_NAME

public static final String NULL_RESOLVER_NAME

See Also:

• Constant Field Values

Constructor Details

NullMetadataResolver

public NullMetadataResolver()

Method Details

getResolverName

public String getResolverName()

This is the name of the TypeResolver. It should not be repeated among InputTypeResolver and OutputTypeResolver which are used together.

Specified by:

getResolverName in interface AttributesTypeResolver<Object>

Specified by:

getResolverName in interface InputTypeResolver<Object>

Specified by:

getResolverName in interface org.mule.runtime.api.metadata.resolving.NamedTypeResolver

Specified by:

getResolverName in interface NamedTypeResolver

Specified by:

getResolverName in interface OutputTypeResolver<Object>

Specified by:

getResolverName in interface TypeKeysResolver

Returns:

name of the resolver

getCategoryName

public String getCategoryName()

This is the name of the TypeResolver Category, that relates a given TypeKeysResolver with the input and output type resolvers. For any given component, all the input and output resolvers must belong to the same Category, that is, have the same categoryName

Specified by:

getCategoryName in interface org.mule.runtime.api.metadata.resolving.NamedTypeResolver

Specified by:

getCategoryName in interface NamedTypeResolver

Returns:

name of the category

getKeys

public Set<MetadataKey> getKeys(MetadataContext context)
                         throws org.mule.runtime.api.metadata.MetadataResolvingException

Null implementation of TypeKeysResolver, used when no implementation is provided by the connector developer. Represents the absence of a custom TypeKeysResolver, returning an empty list of MetadataKey.

Specified by:

getKeys in interface TypeKeysResolver

Parameters:

context - MetadataContext of the MetaData resolution

Returns:

Collections.emptyList()

Throws:

org.mule.runtime.api.metadata.MetadataResolvingException

getInputMetadata

public org.mule.metadata.api.model.MetadataType getInputMetadata(MetadataContext context,
 Object key)
                                                          throws org.mule.runtime.api.metadata.MetadataResolvingException

Null implementation of InputTypeResolver, used when no implementation is provided by the connector developer. Represents the absence of a custom InputTypeResolver, returning a VoidType instead of resolving a valid MetadataType

Specified by:

getInputMetadata in interface InputTypeResolver<Object>

Parameters:

context - MetadataContext of the MetaData resolution

key - MetadataKey of the type which's structure has to be resolved

Returns:

a VoidType

Throws:

org.mule.runtime.api.metadata.MetadataResolvingException

getOutputType

public org.mule.metadata.api.model.MetadataType getOutputType(MetadataContext context,
 Object key)
                                                       throws org.mule.runtime.api.metadata.MetadataResolvingException

Null implementation of OutputTypeResolver, used when no implementation is provided by the connector developer. Represents the absence of a custom OutputTypeResolver, returning a VoidType instead of resolving a dynamic MetadataType for the component's output.

Specified by:

getOutputType in interface OutputTypeResolver<Object>

Parameters:

context - MetadataContext of the MetaData resolution

key - MetadataKey of the type which's structure has to be resolved

Returns:

a VoidType

Throws:

org.mule.runtime.api.metadata.MetadataResolvingException

getAttributesType

public org.mule.metadata.api.model.MetadataType getAttributesType(MetadataContext context,
 Object key)
                                                           throws org.mule.runtime.api.metadata.MetadataResolvingException

Null implementation of AttributesTypeResolver, used when no implementation is provided by the connector developer. Represents the absence of a custom AttributesTypeResolver, returning a VoidType instead of resolving a dynamic MetadataType for the component's output attributes.

Specified by:

getAttributesType in interface AttributesTypeResolver<Object>

Parameters:

context - MetadataContext of the MetaData resolution

key - MetadataKey of the type which's structure has to be resolved

Returns:

a VoidType

Throws:

org.mule.runtime.api.metadata.MetadataResolvingException