org.raml.yagi.framework.nodes

Interface Position

All Known Implementing Classes:

AbstractPosition, DefaultPosition, SYPosition

public interface Position

The position of a given node in a specific resource

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNKNOWN

Method Summary

Modifier and Type	Method and Description
int	getColumn() Column number
String	getIncludedResourceUri() Returns the resource URI of the current position
int	getIndex() The offset from the begining of the file
int	getLine() The line line number
String	getPath() Returns the absolute path of the resource where this position is relative to
ResourceLoader	getResourceLoader()
Position	leftShift(int offset)
Position	rightShift(int offset)
void	setIncludedResourceUri(String includedResourceURI) Sets the URI of the resource in the current position

Field Detail

UNKNOWN

static final int UNKNOWN

See Also:

Constant Field Values

Method Detail

getIndex

int getIndex()

The offset from the begining of the file

Returns:

The offset

getLine

int getLine()

The line line number

Returns:

line number

getColumn

int getColumn()

Column number

Returns:

The column number

getPath

@Nonnull
String getPath()

Returns the absolute path of the resource where this position is relative to

Returns:

The absolute path

getIncludedResourceUri

@Nullable
String getIncludedResourceUri()

Returns the resource URI of the current position

Returns:

The resource URI if it is included, null if not

setIncludedResourceUri

void setIncludedResourceUri(String includedResourceURI)

Sets the URI of the resource in the current position

Parameters:

includedResourceURI - The resource URI

rightShift

@Nonnull
Position rightShift(int offset)

leftShift

@Nonnull
Position leftShift(int offset)

getResourceLoader

@Nonnull
ResourceLoader getResourceLoader()