Package org.yaml.snakeyaml.events

Class ScalarEvent

java.lang.Object

org.yaml.snakeyaml.events.Event

org.yaml.snakeyaml.events.NodeEvent

org.yaml.snakeyaml.events.ScalarEvent

public final class ScalarEvent
extends NodeEvent

Marks a scalar value.

Nested Class Summary

Nested classes/interfaces inherited from class org.yaml.snakeyaml.events.Event

Event.ID

Field Summary

Fields

Modifier and Type	Field	Description
private ImplicitTuple	implicit
private DumperOptions.ScalarStyle	style
private java.lang.String	tag
private java.lang.String	value

Constructor Summary

Constructors

Constructor	Description
ScalarEvent(java.lang.String anchor, java.lang.String tag, ImplicitTuple implicit, java.lang.String value, Mark startMark, Mark endMark, DumperOptions.ScalarStyle style)

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	getArguments()	Generate human readable representation of the Event
Event.ID	getEventId()	Get the type (kind) if this Event
ImplicitTuple	getImplicit()
DumperOptions.ScalarStyle	getScalarStyle()	Style of the scalar.
java.lang.String	getTag()	Tag of this scalar.
java.lang.String	getValue()	String representation of the value.
boolean	isDQuoted()
boolean	isFolded()
boolean	isJson()
boolean	isLiteral()
boolean	isPlain()
boolean	isSQuoted()

Methods inherited from class org.yaml.snakeyaml.events.NodeEvent

getAnchor

Methods inherited from class org.yaml.snakeyaml.events.Event

equals, getEndMark, getStartMark, hashCode, is, toString

Methods inherited from class java.lang.Object

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

Field Detail

tag

private final java.lang.String tag

style

private final DumperOptions.ScalarStyle style

value

private final java.lang.String value

implicit

private final ImplicitTuple implicit

Constructor Detail

ScalarEvent

public ScalarEvent(java.lang.String anchor,
                   java.lang.String tag,
                   ImplicitTuple implicit,
                   java.lang.String value,
                   Mark startMark,
                   Mark endMark,
                   DumperOptions.ScalarStyle style)

Method Detail

getTag

public java.lang.String getTag()

Tag of this scalar.

Returns:

The tag of this scalar, or null if no explicit tag is available.

getScalarStyle

public DumperOptions.ScalarStyle getScalarStyle()

Style of the scalar.

null

Flow Style - Plain

'\''

Flow Style - Single-Quoted

'"'

Flow Style - Double-Quoted

'|'

Block Style - Literal

'>'

Block Style - Folded

Returns:

Style of the scalar.

See Also:

Kind/Style Combinations

getValue

public java.lang.String getValue()

String representation of the value.

Without quotes and escaping.

Returns:

Value as Unicode string.

getImplicit

public ImplicitTuple getImplicit()

getArguments

protected java.lang.String getArguments()

Description copied from class: Event

Generate human readable representation of the Event

Overrides:

getArguments in class NodeEvent

Returns:

representation fore humans

See Also:

"__repr__ for Event in PyYAML"

getEventId

public Event.ID getEventId()

Description copied from class: Event

Get the type (kind) if this Event

Specified by:

getEventId in class Event

Returns:

the ID of this Event

isPlain

public boolean isPlain()

isLiteral

public boolean isLiteral()

isSQuoted

public boolean isSQuoted()

isDQuoted

public boolean isDQuoted()

isFolded

public boolean isFolded()

isJson

public boolean isJson()