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

public abstract Class CollectionStartEvent

extends NodeEvent
Class Inheritance
Known Direct Subclasses
org.yaml.snakeyaml.events.MappingStartEvent, org.yaml.snakeyaml.events.SequenceStartEvent
Imports
org.yaml.snakeyaml.DumperOptions, org.yaml.snakeyaml.error.Mark
Base class for the start events of the collection nodes.

Field Summary

Modifier and TypeField and Description
private final DumperOptions.FlowStyle
flowStyle

private final boolean
implicit

private final String
tag

Constructor Summary

AccessConstructor and Description
public
CollectionStartEvent(String
- its anchor
anchor, String
- its tag
tag, boolean
- thue when the tag is implicitly resolved
implicit, Mark
- start
startMark, Mark
- end
endMark, DumperOptions.FlowStyle
- style
flowStyle)

Create

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 DumperOptions.FlowStyle

Returns:

If this collection is in flow style.
getFlowStyle()

true if this collection is in flow style, false for block style.

public boolean

Returns:

True if the tag can be omitted while this collection is emitted.
getImplicit()

true if the tag can be omitted while this collection is emitted.

public String

Returns:

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

Tag of this collection.

public boolean

Returns:

true for FLOW (exclude BLOCK and AUTO)
isFlow()

Getter

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

Field Detail

flowStyleback to summary
private final DumperOptions.FlowStyle flowStyle
implicitback to summary
private final boolean implicit
tagback to summary
private final String tag

Constructor Detail

CollectionStartEventback to summary
public CollectionStartEvent(String anchor, String tag, boolean implicit, Mark startMark, Mark endMark, DumperOptions.FlowStyle flowStyle)

Create

Parameters
anchor:String

- its anchor

tag:String

- its tag

implicit:boolean

- thue when the tag is implicitly resolved

startMark:Mark

- start

endMark:Mark

- end

flowStyle:DumperOptions.FlowStyle

- 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
getFlowStyleback to summary
public DumperOptions.FlowStyle getFlowStyle()

true if this collection is in flow style, false for block style.

Returns:DumperOptions.FlowStyle

If this collection is in flow style.

getImplicitback to summary
public boolean getImplicit()

true if the tag can be omitted while this collection is emitted.

Returns:boolean

True if the tag can be omitted while this collection is emitted.

getTagback to summary
public String getTag()

Tag of this collection.

Returns:String

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

isFlowback to summary
public boolean isFlow()

Getter

Returns:boolean

true for FLOW (exclude BLOCK and AUTO)