de.vandermeer.skb.interfaces.antlr

Interface IsAntlrRuntimeObject

All Superinterfaces:

CategoryHas, CategoryIs, HasText

public interface IsAntlrRuntimeObject
extends CategoryIs, HasText

Interface for objects that represent ANTLR runtime objects (which have source, line, column, and other characteristics).

Since:

v0.0.1

Version:

v0.0.1 build 170404 (04-Apr-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Method Summary

Modifier and Type	Method and Description
static IsAntlrRuntimeObject	create(Object obj) Creates a new object from an object.
Object	getAntlrObject() Returns the ANTLR runtime object.
default int	getColumn() Returns the column (character position in line) for the ANTLR object.
default String	getFilename() Returns the source file of the ANTLR object.
default int	getLine() Returns the line for the ANTLR object.
default String	getText() Returns text representation of an object.

Methods inherited from interface HasText

create

Method Detail

getAntlrObject

Object getAntlrObject()

Returns the ANTLR runtime object.

Returns:

ANTLR runtime object

getColumn

default int getColumn()

Returns the column (character position in line) for the ANTLR object.

Returns:

column, -1 if none found or the object wasn’t an ANTLR object with a column

getLine

default int getLine()

Returns the line for the ANTLR object.

Returns:

line, -1 if none found or the object wasn’t an ANTLR object with a line

getFilename

default String getFilename()

Returns the source file of the ANTLR object.

Returns:

source file

getText

default String getText()

Description copied from interface: HasText

Returns text representation of an object.

Specified by:

getText in interface HasText

Returns:

text, should not be blank

create

static IsAntlrRuntimeObject create(Object obj)

Creates a new object from an object.

Parameters:

obj - the object for creation

Returns:

new object

Throws:

NullPointerException - if the obj was null

IllegalArgumentException - if obj was not an accepted ANTRL runtime object