Package org.apache.maven.api.settings

Class InputLocation

java.lang.Object

org.apache.maven.api.settings.InputLocation

All Implemented Interfaces:

Serializable, InputLocationTracker

public class InputLocation
extends Object
implements Serializable, InputLocationTracker

Class InputLocation.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InputLocation.StringFormatter	Class StringFormatter.

Constructor Summary

Constructors

Constructor	Description
InputLocation(int lineNumber, int columnNumber)
InputLocation(int lineNumber, int columnNumber, InputSource source)
InputLocation(int lineNumber, int columnNumber, InputSource source, Object selfLocationKey)
InputLocation(int lineNumber, int columnNumber, InputSource source, Map<Object,InputLocation> locations)
InputLocation(InputSource source)

Method Summary

Modifier and Type	Method	Description
int	getColumnNumber()
int	getLineNumber()
InputLocation	getLocation(Object key)	Gets the location of the specified field in the input source.
Map<Object,InputLocation>	getLocations()
InputSource	getSource()
static InputLocation	merge(InputLocation target, InputLocation source, boolean sourceDominant)	Merges the source location into the target location.
static InputLocation	merge(InputLocation target, InputLocation source, Collection<Integer> indices)	Merges the source location into the target location.

Methods inherited from class java.lang.Object

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

Constructor Details

InputLocation

public InputLocation(InputSource source)

InputLocation

public InputLocation(int lineNumber,
 int columnNumber)

InputLocation

public InputLocation(int lineNumber,
 int columnNumber,
 InputSource source)

InputLocation

public InputLocation(int lineNumber,
 int columnNumber,
 InputSource source,
 Object selfLocationKey)

InputLocation

public InputLocation(int lineNumber,
 int columnNumber,
 InputSource source,
 Map<Object,InputLocation> locations)

Method Details

getLineNumber

public int getLineNumber()

getColumnNumber

public int getColumnNumber()

getSource

public InputSource getSource()

getLocation

public InputLocation getLocation(Object key)

Description copied from interface: InputLocationTracker

Gets the location of the specified field in the input source.

Specified by:

getLocation in interface InputLocationTracker

Parameters:

key - the key of the field, must not be null

Returns:

the location of the field in the input source or null if unknown

getLocations

public Map<Object,InputLocation> getLocations()

merge

public static InputLocation merge(InputLocation target,
 InputLocation source,
 boolean sourceDominant)

Merges the source location into the target location.

Parameters:

target - the target location

source - the source location

sourceDominant - the boolean indicating of source is dominant compared to target

Returns:

the merged location

merge

public static InputLocation merge(InputLocation target,
 InputLocation source,
 Collection<Integer> indices)

Merges the source location into the target location. This method is used when the locations refer to lists and also merges the indices.

Parameters:

target - the target location

source - the source location

indices - the list of integers for the indices

Returns:

the merged location