com.helger.commons.location

Interface ILocation

All Superinterfaces:

Serializable

All Known Implementing Classes:

SimpleLocation

@MustImplementEqualsAndHashcode
public interface ILocation
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
default String	getAsString()
int	getColumnNumber()
int	getLineNumber()
String	getResourceID()
default boolean	hasColumnNumber()
default boolean	hasLineNumber()
default boolean	hasResourceID()
default boolean	isAnyInformationPresent() Simple method to check if resource ID, line number, column number or field name is present.

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.

hasResourceID

default boolean hasResourceID()

getLineNumber

int getLineNumber()

Returns:

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

hasLineNumber

default boolean hasLineNumber()

getColumnNumber

int getColumnNumber()

Returns:

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

hasColumnNumber

default boolean hasColumnNumber()

isAnyInformationPresent

default boolean isAnyInformationPresent()

Simple method to check if resource ID, line number, column number or field name is present.

Returns:

true if at least one field is set, false otherwise.

getAsString

@Nonnull
default String getAsString()

Returns:

The display text of the resource location.