com.amazon.ion.IonBool Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ion-java Show documentation

A Java implementation of the Amazon Ion data notation.

The newest version!

/*
 * Copyright 2007-2019 Amazon.com, Inc. or its affiliates. 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.
 * A copy of the License is located at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * or in the "license" file accompanying this file. This file 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.amazon.ion;



/**
 * An Ion bool value.
 * 
 * WARNING: This interface should not be implemented or extended by
 * code outside of this library.
 */
public interface IonBool
    extends IonValue
{
    /**
     * Gets the value of this Ion bool as a Java
     * boolean value.
     *
     * @return the boolean value.
     * @throws NullValueException if this.isNullValue().
     */
    public boolean booleanValue()
        throws NullValueException;

    /**
     * Sets this instance to have a specific value.
     *
     * @param b the new value for this bool.
     */
    public void setValue(boolean b);

    /**
     * Sets this instance to have a specific value.
     *
     * @param b the new value for this bool;
     * may be null to make this null.bool.
     */
    public void setValue(Boolean b);

    public IonBool clone()
        throws UnknownSymbolException;
}