com.hazelcast.org.snakeyaml.engine.v1.events.CollectionStartEvent Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hazelcast Show documentation
Core Hazelcast Module
There is a newer version: 5.4.0
/**
 * Copyright (c) 2018, http://www.snakeyaml.org
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 

 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.hazelcast.org.snakeyaml.engine.v1.events;

import java.util.Objects;
import java.util.Optional;

import com.hazelcast.org.snakeyaml.engine.v1.common.Anchor;
import com.hazelcast.org.snakeyaml.engine.v1.common.FlowStyle;
import com.hazelcast.org.snakeyaml.engine.v1.exceptions.Mark;

/**
 * Base class for the start events of the collection nodes.
 */
public abstract class CollectionStartEvent extends NodeEvent {
    private final Optional tag;
    // The implicit flag of a collection start event indicates if the tag may be
    // omitted when the collection is emitted
    private final boolean implicit;
    // flag indicates if a collection is block or flow
    private final FlowStyle flowStyle;

    public CollectionStartEvent(Optional anchor, Optional tag, boolean implicit, FlowStyle flowStyle, Optional startMark,
                                Optional endMark) {
        super(anchor, startMark, endMark);
        Objects.requireNonNull(tag, "Tag must be provided.");
        this.tag = tag;
        this.implicit = implicit;
        Objects.requireNonNull(flowStyle, "Flow style must be provided.");
        this.flowStyle = flowStyle;
    }

    /**
     * Tag of this collection.
     *
     * @return The tag of this collection, or null if no explicit
     * tag is available.
     */
    public Optional getTag() {
        return this.tag;
    }

    /**
     * true if the tag can be omitted while this collection is
     * emitted.
     *
     * @return True if the tag can be omitted while this collection is emitted.
     */
    public boolean isImplicit() {
        return this.implicit;
    }

    /**
     * true if this collection is in flow style, false
     * for block style.
     *
     * @return If this collection is in flow style.
     */
    public FlowStyle getFlowStyle() {
        return this.flowStyle;
    }

    public boolean isFlow() {
        return FlowStyle.FLOW == flowStyle;
    }

    @Override
    public String toString() {
        StringBuilder builder = new StringBuilder("");
        getAnchor().ifPresent(a -> builder.append(" &" + a));
        if (!implicit) getTag().ifPresent(tag -> builder.append(" <" + tag + ">"));
        return builder.toString();
    }
}