hazelcast-master/hazelcast/src/main/java/com/hazelcast/internal/yaml/YamlSequence.java
/*
 * Copyright (c) 2008-2023, Hazelcast, Inc. All Rights Reserved.
 *
 * 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.internal.yaml;

/**
 * Interface for YAML sequence nodes
 */
public interface YamlSequence extends YamlCollection {

    /**
     * Gets a child node by its index
     *
     * @param index the index of the child node
     * @return the child node with the given index if exists,
     * {@code null} otherwise
     */
    YamlNode child(int index);

    /**
     * Gets a child mapping node by its index
     *
     * @param index the index of the child node
     * @return the child mapping node with the given index if exists,
     * {@code null} otherwise
     */
    YamlMapping childAsMapping(int index);

    /**
     * Gets a child sequence node by its index
     *
     * @param index the index of the child node
     * @return the child sequence node with the given index if exists,
     * {@code null} otherwise
     */
    YamlSequence childAsSequence(int index);

    /**
     * Gets a child scalar node by its index
     *
     * @param index the index of the child node
     * @return the child scalar node with the given index if exists,
     * {@code null} otherwise
     */
    YamlScalar childAsScalar(int index);

    /**
     * Gets a child scalar node's value by its index
     * <p>
     * See {@link YamlScalar} for the possible types
     * <p>
     * Please note that if the scalar's type is not the expected type T,
     * a {@link ClassCastException} is thrown <strong>at the call site</strong>.
     *
     * @param index the index of the child node
     * @return the child scalar node's value with the given index if exists,
     * {@code null} otherwise
     * @see YamlScalar
     */
    <T> T childAsScalarValue(int index);

    /**
     * Gets a child scalar node's value by its name with type hinting
     * <p>
     * See {@link YamlScalar} for the possible types
     *
     * @param index the index of the child node
     * @param type  the type that the scalar's value type to be validated
     *              against
     * @return the child scalar node's value with the given name if exists,
     * {@code null} otherwise
     * @throws YamlException if the scalar's value is not a type of T
     * @see YamlScalar
     */
    <T> T childAsScalarValue(int index, Class<T> type);

}
