org.mule.runtime.api.component.location

Interface Location.Builder

All Known Implementing Classes:

Location.LocationBuilder

Enclosing interface:

Location

public static interface Location.Builder

A builder to create a Location object.

All Location instances must be created using this builder. The builder implementation may not be thread safe but it is immutable so each method call in the builder returns a new instance so it can be reused.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
Location.Builder	addConnectionPart() Adds a new Location.CONNECTION part at the end of the location.
Location.Builder	addErrorHandlerPart() Adds a new Location.ERROR_HANDLER part at the end of the location.
Location.Builder	addIndexPart(int index) Adds a new index part.
Location.Builder	addParameterPart() Adds a new Location.PARAMETERS part at the end of the location.
Location.Builder	addPart(String part) Adds a new part at the end of the location.
Location.Builder	addProcessorsPart() Adds a new Location.PROCESSORS part at the end of the location.
Location.Builder	addSourcePart() Adds a new Location.SOURCE part at the end of the location.
Location	build()
Location.Builder	globalName(String globalName) Sets the name of the global component.
Location.Builder	parts(List<String> parts) Adds the parts of this location.

Method Detail

globalName

Location.Builder globalName(String globalName)

Sets the name of the global component. This method must only be called once.

Parameters:

globalName - the name of the global component

Returns:

a new builder with the provided configuration.

addPart

Location.Builder addPart(String part)

Adds a new part at the end of the location.

Parameters:

part - the name of the part

Returns:

a new builder with the provided configuration.

addConnectionPart

Location.Builder addConnectionPart()

Adds a new Location.CONNECTION part at the end of the location.

Connection elements within a configuration component must be addressed using a Location.CONNECTION part.

Returns:

a new builder with the provided configuration.

addSourcePart

Location.Builder addSourcePart()

Adds a new Location.SOURCE part at the end of the location.

Message sources within other component must be addressed using a Location.SOURCE part.

Returns:

a new builder with the provided configuration.

addProcessorsPart

Location.Builder addProcessorsPart()

Adds a new Location.PROCESSORS part at the end of the location.

Components that allow nested processors must have Location.PROCESSORS as part before the nested processors indexes.

Returns:

a new builder with the provided configuration.

addErrorHandlerPart

Location.Builder addErrorHandlerPart()

Adds a new Location.ERROR_HANDLER part at the end of the location.

Components that allow nested on-error components must have Location.ERROR_HANDLER as part before the on-error indexes.

Returns:

a new builder with the provided configuration.

addParameterPart

Location.Builder addParameterPart()

Adds a new Location.PARAMETERS part at the end of the location.

Components that allow nested parameters must have Location.PARAMETERS as part before the parameter name.

Returns:

a new builder with the provided configuration.

addIndexPart

Location.Builder addIndexPart(int index)

Adds a new index part. The index part is used to reference a component within a collection.

There cannot be two index parts consecutively.

Parameters:

index - the index of the component.

Returns:

a new builder with the provided configuration.

parts

Location.Builder parts(List<String> parts)

Adds the parts of this location.

Parameters:

parts - the parts of the location

Returns:

a new builder with the provided configuration.

build

Location build()

Returns:

a location built with the provided configuration.