org.mule.runtime.core.api.locator

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:

4.0

Method Summary

Modifier and Type	Method and Description
Location.Builder	addIndexPart(int index) Adds a new index part.
Location.Builder	addPart(String part) Adds a new part at the end of the location.
Location.Builder	addProcessorsPart() Adds a new "processors" part at the end of the location.
Location	build()
Location.Builder	globalName(String globalName) Sets the name of the global component.

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.

addProcessorsPart

Location.Builder addProcessorsPart()

Adds a new "processors" part at the end of the location. All component that allow nested processors must have the "processors" as attribute for holding the nested processors.

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.

build

Location build()

Returns:

a location build with the provided configuration.