Package org.snakeyaml.engine.v2.exceptions

Class Mark

java.lang.Object

org.snakeyaml.engine.v2.exceptions.Mark

All Implemented Interfaces:

Serializable

public final class Mark
extends Object
implements Serializable

Location of a problem in the YAML document. Its only use is producing nice error messages. Parser does not use it for any other purposes.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Mark(String name, int index, int line, int column, char[] str, int pointer)	This constructor is only for test
Mark(String name, int index, int line, int column, int[] buffer, int pointer)	Creates Mark

Method Summary

Modifier and Type	Method	Description
String	createSnippet()	Create readable YAML with indent 4 and n ot longer that 75 characters long
String	createSnippet(int indent, int maxLength)	Create readable snippet
int[]	getBuffer()	getter
int	getColumn()	starts with 0
int	getIndex()	starts with 0
int	getLine()	starts with 0
String	getName()	getter
int	getPointer()	getter
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Mark

public Mark(String name,
            int index,
            int line,
            int column,
            int[] buffer,
            int pointer)

Creates Mark

Parameters:

name - - the name to be used as identifier

index - - the index from the beginning of the stream

line - - line of the mark from beginning of the stream

column - - column of the mark from beginning of the line

buffer - - the data

pointer - - the position of the mark from the beginning of the data

Mark

public Mark(String name,
            int index,
            int line,
            int column,
            char[] str,
            int pointer)

This constructor is only for test

Parameters:

name - - the name to be used as identifier

index - - the index from the beginning of the stream

line - - line of the mark from beginning of the stream

column - - column of the mark from beginning of the line

str - - the data

pointer - - the position of the mark from the beginning of the data

Method Detail

createSnippet

public String createSnippet(int indent,
                            int maxLength)

Create readable snippet

Parameters:

indent - - the indent

maxLength - - cut data after this length

Returns:

readable piece of YAML where a problem detected

createSnippet

public String createSnippet()

Create readable YAML with indent 4 and n ot longer that 75 characters long

Returns:

readable piece of YAML where a problem detected

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

getter

Returns:

name of the data stream

getLine

public int getLine()

starts with 0

Returns:

line number

getColumn

public int getColumn()

starts with 0

Returns:

column number

getIndex

public int getIndex()

starts with 0

Returns:

character number

getBuffer

public int[] getBuffer()

getter

Returns:

data with the error

getPointer

public int getPointer()

getter

Returns:

pointer in the data to the error