org.mule.runtime.api.component.location

Class Location.LocationBuilder

java.lang.Object

org.mule.runtime.api.component.location.Location.LocationBuilder

All Implemented Interfaces:

Location.Builder

Enclosing interface:

Location

public static class Location.LocationBuilder
extends Object
implements Location.Builder

Constructor Summary

Constructors

Constructor and Description
LocationBuilder()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocationBuilder

public LocationBuilder()

Method Detail

globalName

public Location.Builder globalName(String globalName)

Description copied from interface: Location.Builder

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

Specified by:

globalName in interface Location.Builder

Parameters:

globalName - the name of the global component

Returns:

a new builder with the provided configuration.

addPart

public Location.Builder addPart(String part)

Description copied from interface: Location.Builder

Adds a new part at the end of the location.

Specified by:

addPart in interface Location.Builder

Parameters:

part - the name of the part

Returns:

a new builder with the provided configuration.

addConnectionPart

public Location.Builder addConnectionPart()

Description copied from interface: Location.Builder

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.

Specified by:

addConnectionPart in interface Location.Builder

Returns:

a new builder with the provided configuration.

addSourcePart

public Location.Builder addSourcePart()

Description copied from interface: Location.Builder

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.

Specified by:

addSourcePart in interface Location.Builder

Returns:

a new builder with the provided configuration.

addProcessorsPart

public Location.Builder addProcessorsPart()

Description copied from interface: Location.Builder

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.

Specified by:

addProcessorsPart in interface Location.Builder

Returns:

a new builder with the provided configuration.

addErrorHandlerPart

public Location.Builder addErrorHandlerPart()

Description copied from interface: Location.Builder

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.

Specified by:

addErrorHandlerPart in interface Location.Builder

Returns:

a new builder with the provided configuration.

addParameterPart

public Location.Builder addParameterPart()

Description copied from interface: Location.Builder

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.

Specified by:

addParameterPart in interface Location.Builder

Returns:

a new builder with the provided configuration.

addIndexPart

public Location.Builder addIndexPart(int index)

Description copied from interface: Location.Builder

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

There cannot be two index parts consecutively.

Specified by:

addIndexPart in interface Location.Builder

Parameters:

index - the index of the component.

Returns:

a new builder with the provided configuration.

parts

public Location.Builder parts(List<String> parts)

Description copied from interface: Location.Builder

Adds the parts of this location.

Specified by:

parts in interface Location.Builder

Parameters:

parts - the parts of the location

Returns:

a new builder with the provided configuration.

build

public Location build()

Specified by:

build in interface Location.Builder

Returns:

a location built with the provided configuration.