com.helger.commons.error

Interface IResourceLocation

All Superinterfaces:

Serializable

All Known Implementing Classes:

ResourceLocation

public interface IResourceLocation
extends Serializable

Interface indication the position of something within a single resource

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static int	ILLEGAL_NUMBER Constant for an illegal row or column number

Method Summary

Modifier and Type	Method and Description
String	getAsString()
int	getColumnNumber()
String	getField()
int	getLineNumber()
String	getResourceID()

Field Detail

ILLEGAL_NUMBER

static final int ILLEGAL_NUMBER

Constant for an illegal row or column number

See Also:

Constant Field Values

Method Detail

getResourceID

@Nullable
String getResourceID()

Returns:

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

getLineNumber

int getLineNumber()

Returns:

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

getColumnNumber

int getColumnNumber()

Returns:

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

getField

@Nullable
String getField()

Returns:

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

getAsString

@Nonnull
String getAsString()

Returns:

The display text of the resource location.