org.mule.tooling.client.api.component.location

Class Location

java.lang.Object

org.mule.tooling.client.api.component.location.Location

public class Location
extends Object

A location allows to define the position of a certain component in the configuration.

Only components contained within global components with name can be referenced using a Location instance.

The string representation of the implementation of this interface must be the serialized form of the location which consist of the global element name and the parts separated by an slash character.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Location.Builder A builder to create a Location object.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONNECTION
static String	ERROR_HANDLER
static String	PARAMETERS
protected static String	PARTS_SEPARATOR
static String	PROCESSORS
static String	SOURCE

Constructor Summary

Constructors

Constructor and Description
Location()
Location(List<String> parts)

Method Summary

Modifier and Type	Method and Description
static Location.Builder	builder()
static Location.Builder	builderFromStringRepresentation(String location) Creates a new Location.Builder with the provided location represented as string as base.
boolean	equals(Object o)
String	getGlobalName()
List<String>	getParts()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SOURCE

public static final String SOURCE

See Also:

Constant Field Values

CONNECTION

public static final String CONNECTION

See Also:

Constant Field Values

PARAMETERS

public static final String PARAMETERS

See Also:

Constant Field Values

PROCESSORS

public static final String PROCESSORS

See Also:

Constant Field Values

ERROR_HANDLER

public static final String ERROR_HANDLER

See Also:

Constant Field Values

PARTS_SEPARATOR

protected static final String PARTS_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

Location

public Location()

Location

public Location(List<String> parts)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getGlobalName

public String getGlobalName()

Returns:

the name of the global element that contains the component referenced by this Location.

getParts

public List<String> getParts()

Returns:

the parts within the global element that define the location of the component referenced by this Location.

builder

public static Location.Builder builder()

Returns:

a new builder instance.

builderFromStringRepresentation

public static Location.Builder builderFromStringRepresentation(String location)

Creates a new Location.Builder with the provided location represented as string as base.

Parameters:

location - a location to use to pre-configured the builder

Returns:

a new builder instance with the provided location as base.