Module org.mule.sdk.api

Package org.mule.sdk.api.metadata

Class MetadataKeyBuilder

java.lang.Object

org.mule.sdk.api.metadata.MetadataKeyBuilder

@NoExtend
@MinMuleVersion("4.5.0")
public class MetadataKeyBuilder
extends Object

An implementation of the builder design pattern to create a new MetadataKey instance.

Since:

1.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MetadataKeyBuilder(String id)

Method Summary

Modifier and Type	Method	Description
MetadataKey	build()	Builds a new instance of MetadataKey.
static MetadataKeyBuilder	newKey(String id)	Creates and returns new instance of a MetadataKeyBuilder, to help building a new MetadataKey represented by the given
protected void	setPartName(String partName)
MetadataKeyBuilder	withChild(MetadataKey metadataKey)	Adds a new MetadataKey child to the MetadataKey that is being built.
MetadataKeyBuilder	withChild(MetadataKeyBuilder metadataKeyBuilder)	Adds a new MetadataKeyBuilder child to the MetadataKey that is being built.
MetadataKeyBuilder	withDisplayName(String displayName)	Adds a display name to the MetadataKey that is being built
MetadataKeyBuilder	withPartName(String partName)	Adds a new MetadataKeyBuilder child to the MetadataKey that is being built.
MetadataKeyBuilder	withProperty(org.mule.runtime.api.metadata.MetadataProperty property)	Adds a custom MetadataProperty to the MetadataKey that is being built

Methods inherited from class java.lang.Object

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

Constructor Details

MetadataKeyBuilder

protected MetadataKeyBuilder(String id)

Method Details

newKey

public static MetadataKeyBuilder newKey(String id)

Creates and returns new instance of a MetadataKeyBuilder, to help building a new MetadataKey represented by the given

Parameters:

id - of the MetadataKey to be created

Returns:

an initialized instance of MetadataKeyBuilder

withDisplayName

public MetadataKeyBuilder withDisplayName(String displayName)

Adds a display name to the MetadataKey that is being built

Parameters:

displayName - of the MetadataKey to be created

Returns:

this builder with the configured display name

withProperty

public MetadataKeyBuilder withProperty(org.mule.runtime.api.metadata.MetadataProperty property)

Adds a custom MetadataProperty to the MetadataKey that is being built

Parameters:

property - The new MetadataProperty to be added into the MetadataKey

Returns:

this builder with the new property

withChild

public MetadataKeyBuilder withChild(MetadataKeyBuilder metadataKeyBuilder)

Adds a new MetadataKeyBuilder child to the MetadataKey that is being built.

Parameters:

metadataKeyBuilder - the MetadataKeyBuilder that is used to create the instance of the new child.

Returns:

this builder with a new child.

withChild

public MetadataKeyBuilder withChild(MetadataKey metadataKey)

Adds a new MetadataKey child to the MetadataKey that is being built.

Parameters:

metadataKey - the MetadataKey that is used to create the instance of the new child.

Returns:

this builder with a new child.

withPartName

public MetadataKeyBuilder withPartName(String partName)

Adds a new MetadataKeyBuilder child to the MetadataKey that is being built.

Parameters:

partName - the partName that is associated to this key part.

Returns:

this builder with a new child.

setPartName

protected void setPartName(String partName)

build

public MetadataKey build()

Builds a new instance of MetadataKey.

Returns:

an initialized MetadataKey