1 /*
 2  * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
 3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 4  *
 5  * This code is free software; you can redistribute it and/or modify it
 6  * under the terms of the GNU General Public License version 2 only, as
 7  * published by the Free Software Foundation.  Oracle designates this
 8  * particular file as subject to the "Classpath" exception as provided
 9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 package oracle.code.json;
27 
28 import oracle.code.json.impl.JsonBooleanImpl;
29 
30 /**
31  * The interface that represents JSON boolean.
32  * <p>
33  * A {@code JsonBoolean} can be produced by {@link Json#parse(String)}.
34  * <p> Alternatively, {@link #of(boolean)} can be used to
35  * obtain a {@code JsonBoolean}.
36  *
37  * @since 99
38  */
39 public non-sealed interface JsonBoolean extends JsonValue {
40 
41     /**
42      * {@return the {@code boolean} value represented by this
43      * {@code JsonBoolean}}
44      */
45     boolean value();
46 
47     /**
48      * {@return the {@code JsonBoolean} created from the given
49      * {@code boolean}}
50      *
51      * @param src the given {@code boolean}.
52      */
53     static JsonBoolean of(boolean src) {
54         return src ? JsonBooleanImpl.TRUE : JsonBooleanImpl.FALSE;
55     }
56 
57     /**
58      * {@return {@code true} if the given object is also a {@code JsonBoolean}
59      * and the two {@code JsonBoolean}s represent the same boolean value} Two
60      * {@code JsonBoolean}s {@code jb1} and {@code jb2} represent the same
61      * boolean values if {@code jb1.value().equals(jb2.value())}.
62      *
63      * @see #value()
64      */
65     @Override
66     boolean equals(Object obj);
67 
68     /**
69      * {@return the hash code value for this {@code JsonBoolean}} The hash code value
70      * of a {@code JsonBoolean} is defined to be the hash code of {@code JsonBoolean}'s
71      * {@link #value()}. Thus, for two {@code JsonBooleans}s {@code jb1} and {@code jb2},
72      * {@code jb1.equals(jb2)} implies that {@code jb1.hashCode() == jb2.hashCode()}
73      * as required by the general contract of {@link Object#hashCode}.
74      *
75      * @see #value()
76      */
77     @Override
78     int hashCode();
79 }