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 optkl.json;
27 
28 
29 import optkl.json.impl.JsonBooleanImpl;
30 
31 /**
32  * The interface that represents JSON boolean.
33  * <p>
34  * A {@code JsonBoolean} can be produced by {@link Json#parse(String)}.
35  * <p> Alternatively, {@link #of(boolean)} can be used to
36  * obtain a {@code JsonBoolean}.
37  *
38  * @since 99
39  */
40 public non-sealed interface JsonBoolean extends JsonValue {
41 
42     /**
43      * {@return the {@code boolean} value represented by this
44      * {@code JsonBoolean}}
45      */
46     boolean value();
47 
48     /**
49      * {@return the {@code JsonBoolean} created from the given
50      * {@code boolean}}
51      *
52      * @param src the given {@code boolean}.
53      */
54     static JsonBoolean of(boolean src) {
55         return src ? JsonBooleanImpl.TRUE : JsonBooleanImpl.FALSE;
56     }
57 
58     /**
59      * {@return {@code true} if the given object is also a {@code JsonBoolean}
60      * and the two {@code JsonBoolean}s represent the same boolean value} Two
61      * {@code JsonBoolean}s {@code jb1} and {@code jb2} represent the same
62      * boolean values if {@code jb1.value().equals(jb2.value())}.
63      *
64      * @see #value()
65      */
66     @Override
67     boolean equals(Object obj);
68 
69     /**
70      * {@return the hash code value for this {@code JsonBoolean}} The hash code value
71      * of a {@code JsonBoolean} is defined to be the hash code of {@code JsonBoolean}'s
72      * {@link #value()}. Thus, for two {@code JsonBooleans}s {@code jb1} and {@code jb2},
73      * {@code jb1.equals(jb2)} implies that {@code jb1.hashCode() == jb2.hashCode()}
74      * as required by the general contract of {@link Object#hashCode}.
75      *
76      * @see #value()
77      */
78     @Override
79     int hashCode();
80 }