com.hazelcast.internal.yaml.YamlScalar Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2020, 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 scalar nodes
*
* The following types are supported:
*
* - String
* - Integer
* - Float
* - Boolean
*
*/
public interface YamlScalar extends YamlNode {
/**
* Checks if the value of this node is the given type
*
* @param type the {@link Class} instance of the type to check
* @param the type to check
* @return true if the value of the node is instance of the given type
*/
boolean isA(Class type);
/**
* Gets the value of the node
*
* Please note that if the scalar's type is not the expected type T,
* a {@link ClassCastException} is thrown at the call site.
*
* @param the expected type of the node
* @return the value of the node
*/
T nodeValue();
/**
* Gets the value of the node with validating its type against the
* provided type
*
* @param the expected type of the node
* @return the value of the node
* @throws YamlException if the scalar's value is not a type of T
*/
T nodeValue(Class type);
}