de.weltraumschaf.commons.token

Class Position

java.lang.Object

de.weltraumschaf.commons.token.Position

public final class Position
extends Object

Represents a token position in the source string.

The position contains the line, column and filename where the token occurred. The file name is optional.

Since:

1.0.0

Author:

Sven Strittmatter

Field Summary

Fields

Modifier and Type	Field and Description
private int	column Column of occurrence.
private String	file File of the source string.
private int	line Line of occurrence.
static Position	NULL A position for line 0 and column 0.

Constructor Summary

Constructors

Constructor and Description
Position(int line, int column) Initializes without file.
Position(int line, int column, String file) Dedicated constructor initializes immutable object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getColumn() Returns column of occurrence in source.
String	getFile() Returns the file name of the source.
int	getLine() Returns line of occurrence in source.
int	hashCode()
String	toString() Returns human readable string representation.

Methods inherited from class java.lang.Object

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

Field Detail

NULL

public static final Position NULL

A position for line 0 and column 0.

file

private final String file

File of the source string.

line

private final int line

Line of occurrence.

column

private final int column

Column of occurrence.

Constructor Detail

Position

public Position(int line,
        int column)

Initializes without file.

Parameters:

line - Line of occurrence.

column - Column of occurrence.

Position

public Position(int line,
        int column,
        String file)

Dedicated constructor initializes immutable object. File is optional e.g. if string is parsed directly without any file.

Parameters:

line - must be greater than -1

column - must be greater than -1

file - must not be null, may be empty

Method Detail

getFile

public String getFile()

Returns the file name of the source. May be null.

Returns:

Filename as string.

getLine

public int getLine()

Returns line of occurrence in source.

Returns:

Line position.

getColumn

public int getColumn()

Returns column of occurrence in source.

Returns:

Column position.

toString

public String toString()

Returns human readable string representation.

Overrides:

toString in class Object

Returns:

String representation.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object