com.helger.commons.error

Class ResourceLocation

java.lang.Object

com.helger.commons.error.ResourceLocation

All Implemented Interfaces:

IResourceLocation, IHasStringRepresentation, Serializable

@Immutable
public class ResourceLocation
extends Object
implements IResourceLocation

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

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.helger.commons.error.IResourceLocation

ILLEGAL_NUMBER

Constructor Summary

Constructors

Constructor and Description
ResourceLocation(String sResourceID)
ResourceLocation(String sResourceID, int nLineNumber, int nColumnNumber)
ResourceLocation(String sResourceID, int nLineNumber, int nColumnNumber, String sField)
ResourceLocation(String sResourceID, String sField)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getAsString()
int	getColumnNumber()
String	getField()
int	getLineNumber()
String	getResourceID()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceLocation

public ResourceLocation(@Nullable
                String sResourceID)

ResourceLocation

public ResourceLocation(@Nullable
                String sResourceID,
                @Nullable
                String sField)

ResourceLocation

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

ResourceLocation

public ResourceLocation(@Nullable
                String sResourceID,
                int nLineNumber,
                int nColumnNumber,
                @Nullable
                String sField)

Method Detail

getResourceID

@Nullable
public String getResourceID()

Specified by:

getResourceID in interface IResourceLocation

Returns:

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

getLineNumber

public int getLineNumber()

Specified by:

getLineNumber in interface IResourceLocation

Returns:

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

getColumnNumber

public int getColumnNumber()

Specified by:

getColumnNumber in interface IResourceLocation

Returns:

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

getField

@Nullable
public String getField()

Specified by:

getField in interface IResourceLocation

Returns:

The field where the error occurred. Sometimes this field is available instead of the line- and column numbers. May be null.

getAsString

@Nonnull
public String getAsString()

Specified by:

getAsString in interface IHasStringRepresentation

Returns:

The non-null string representation of this object.

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