Package com.helger.base.location

Class SimpleLocation

java.lang.Object

com.helger.base.location.SimpleLocation

All Implemented Interfaces:

ILocation

@Immutable
public class SimpleLocation
extends Object
implements ILocation

Default implementation of the ILocation interface. The implementation is immutable.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static final SimpleLocation	NO_LOCATION	A constant representing no location

Fields inherited from interface com.helger.base.location.ILocation

ILLEGAL_NUMBER

Constructor Summary

Constructors

Constructor	Description
SimpleLocation(@Nullable String sResourceID)	Constructor with resource ID only.
SimpleLocation(@Nullable String sResourceID, int nLineNumber, int nColumnNumber)	Constructor with resource ID, line number and column number.

Method Summary

Modifier and Type	Method	Description
static @Nullable SimpleLocation	create(@Nullable Location aLocator)	Create a SimpleLocation from a StAX Location.
static @Nullable SimpleLocation	create(@Nullable SourceLocator aLocator)	Create a SimpleLocation from a JAXP SourceLocator.
static @Nullable SimpleLocation	create(@Nullable Locator aLocator)	Create a SimpleLocation from a SAX Locator.
static @Nullable SimpleLocation	create(@Nullable SAXParseException aLocator)	Create a SimpleLocation from a SAXParseException.
boolean	equals(Object o)
int	getColumnNumber()
int	getLineNumber()
@Nullable String	getResourceID()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.base.location.ILocation

getAsString, hasColumnNumber, hasLineNumber, hasResourceID, isAnyInformationPresent

Field Details

NO_LOCATION

public static final SimpleLocation NO_LOCATION

A constant representing no location

Constructor Details

SimpleLocation

public SimpleLocation(@Nullable String sResourceID)

Constructor with resource ID only.

Parameters:

sResourceID - The resource ID. May be null.

SimpleLocation

public SimpleLocation(@Nullable String sResourceID,
 int nLineNumber,
 int nColumnNumber)

Constructor with resource ID, line number and column number.

Parameters:

sResourceID - The resource ID. May be null.

nLineNumber - The line number. Use ILocation.ILLEGAL_NUMBER if not available.

nColumnNumber - The column number. Use ILocation.ILLEGAL_NUMBER if not available.

Method Details

getResourceID

public @Nullable String getResourceID()

Specified by:

getResourceID in interface ILocation

Returns:

The ID of the resource where the error occurred. May be null.

getLineNumber

public int getLineNumber()

Specified by:

getLineNumber in interface ILocation

Returns:

The 1-based line number ILocation.ILLEGAL_NUMBER if no line number is present.

getColumnNumber

public int getColumnNumber()

Specified by:

getColumnNumber in interface ILocation

Returns:

The 1-based column number ILocation.ILLEGAL_NUMBER if no column number is present.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

create

public static @Nullable SimpleLocation create(@Nullable Locator aLocator)

Create a SimpleLocation from a SAX Locator.

Parameters:

aLocator - The SAX locator. May be null.

Returns:

null if the passed locator is null.

create

public static @Nullable SimpleLocation create(@Nullable SourceLocator aLocator)

Create a SimpleLocation from a JAXP SourceLocator.

Parameters:

aLocator - The source locator. May be null.

Returns:

null if the passed locator is null.

create

public static @Nullable SimpleLocation create(@Nullable SAXParseException aLocator)

Create a SimpleLocation from a SAXParseException.

Parameters:

aLocator - The SAX parse exception. May be null.

Returns:

null if the passed exception is null.

create

public static @Nullable SimpleLocation create(@Nullable Location aLocator)

Create a SimpleLocation from a StAX Location.

Parameters:

aLocator - The StAX location. May be null.

Returns:

null if the passed location is null.