org.stekikun.dolmen.syntax

Class PExtent.Hole

java.lang.Object

org.stekikun.dolmen.syntax.PExtent.Hole

Enclosing class:

PExtent

public static final class PExtent.Hole
extends Object

A PExtent.Hole represents a special part of an extent which is bound to some name and can be instantiated later on.

A hole is characterized by its offset relative to its extent's starting offset. It also holds line and column information so that it is possible to report problems on a specific hole.

Author:

Stéphane Lescuyer

Field Summary

Fields

Modifier and Type	Field and Description
String	name The name to which this hole is bound, and through which the hole can be filled
int	offset The offset of this hole in the enclosing extent
int	startCol The column where the hole starts, i.e. the offset of the starting character from the beginning of the line (0-based)
int	startLine The line where the hole starts (1-based)

Constructor Summary

Constructors

Constructor and Description
Hole(int offset, String name, int startLine, int startCol) Returns a new hole from the given parameters

Method Summary

Modifier and Type	Method and Description
int	endOffset()
boolean	equals(@Nullable Object o)
int	hashCode()
int	length()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

offset

public final int offset

The offset of this hole in the enclosing extent

name

public final String name

The name to which this hole is bound, and through which the hole can be filled

startLine

public final int startLine

The line where the hole starts (1-based)

startCol

public final int startCol

The column where the hole starts, i.e. the offset of the starting character from the beginning of the line (0-based)

Constructor Detail

Hole

public Hole(int offset,
            String name,
            int startLine,
            int startCol)

Returns a new hole from the given parameters

Parameters:

offset -

name -

startLine -

startCol -

Method Detail

length

public int length()

Returns:

the length of the hole in the original extent, including the magic character introducing the hole

endOffset

public int endOffset()

Returns:

the end offset of the hole, i.e. the offset of the hole's last character in the original extent

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object