Top Description Fields Constructors Methods
org.yaml.snakeyaml.events

public final Class ScalarEvent

extends NodeEvent
Class Inheritance
Imports
org.yaml.snakeyaml.DumperOptions, org.yaml.snakeyaml.error.Mark
Marks a scalar value.

Field Summary

Modifier and TypeField and Description
private final ImplicitTuple
implicit

private final DumperOptions.ScalarStyle
style

private final String
tag

private final String
value

Constructor Summary

AccessConstructor and Description
public
ScalarEvent(String anchor, String tag, ImplicitTuple implicit, String value, Mark startMark, Mark endMark, DumperOptions.ScalarStyle style)

Method Summary

Modifier and TypeMethod and Description
protected String
getArguments()

Overrides org.yaml.snakeyaml.events.NodeEvent.getArguments.

Generate human readable representation of the Event
public Event.ID
getEventId()

Implements abstract org.yaml.snakeyaml.events.Event.getEventId.

Get the type (kind) if this Event
public ImplicitTuple
getImplicit()

public DumperOptions.ScalarStyle

Returns:

Style of the scalar.
getScalarStyle()

Style of the scalar.

public String

Returns:

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

Tag of this scalar.

public String

Returns:

Value as Unicode string.
getValue()

String representation of the value.

public boolean
isPlain()

Inherited from org.yaml.snakeyaml.events.NodeEvent:
getAnchor

Field Detail

implicitback to summary
private final ImplicitTuple implicit
styleback to summary
private final DumperOptions.ScalarStyle style
tagback to summary
private final String tag
valueback to summary
private final String value

Constructor Detail

ScalarEventback to summary
public ScalarEvent(String anchor, String tag, ImplicitTuple implicit, String value, Mark startMark, Mark endMark, DumperOptions.ScalarStyle style)

Method Detail

getArgumentsback to summary
protected String getArguments()

Overrides org.yaml.snakeyaml.events.NodeEvent.getArguments.

Doc from org.yaml.snakeyaml.events.Event.getArguments.

Generate human readable representation of the Event

Returns:String

representation fore humans

Annotations
@Override
getEventIdback to summary
public Event.ID getEventId()

Implements abstract org.yaml.snakeyaml.events.Event.getEventId.

Doc from org.yaml.snakeyaml.events.Event.getEventId.

Get the type (kind) if this Event

Returns:Event.ID

the ID of this Event

Annotations
@Override
getImplicitback to summary
public ImplicitTuple getImplicit()
getScalarStyleback to summary
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:DumperOptions.ScalarStyle

Style of the scalar.

See Also
Kind/Style Combinations
getTagback to summary
public String getTag()

Tag of this scalar.

Returns:String

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

getValueback to summary
public String getValue()

String representation of the value.

Without quotes and escaping.

Returns:String

Value as Unicode string.

isPlainback to summary
public boolean isPlain()