source: josm/trunk/src/javax/json/JsonValue.java@ 13611

Last change on this file since 13611 was 13231, checked in by Don-vip, 7 years ago

see #15682 - upgrade to JSR 374 (JSON Processing) API 1.1.2

File size: 4.3 KB
Line 
1/*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright (c) 2011-2017 Oracle and/or its affiliates. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can
10 * obtain a copy of the License at
11 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
12 * or LICENSE.txt. See the License for the specific
13 * language governing permissions and limitations under the License.
14 *
15 * When distributing the software, include this License Header Notice in each
16 * file and include the License file at LICENSE.txt.
17 *
18 * GPL Classpath Exception:
19 * Oracle designates this particular file as subject to the "Classpath"
20 * exception as provided by Oracle in the GPL Version 2 section of the License
21 * file that accompanied this code.
22 *
23 * Modifications:
24 * If applicable, add the following below the License Header, with the fields
25 * enclosed by brackets [] replaced by your own identifying information:
26 * "Portions Copyright [year] [name of copyright owner]"
27 *
28 * Contributor(s):
29 * If you wish your version of this file to be governed by only the CDDL or
30 * only the GPL Version 2, indicate your decision by adding "[Contributor]
31 * elects to include this software in this distribution under the [CDDL or GPL
32 * Version 2] license." If you don't indicate a single choice of license, a
33 * recipient has the option to distribute your version of this file under
34 * either the CDDL, the GPL Version 2 or to extend the choice of license to
35 * its licensees as provided above. However, if you add GPL Version 2 code
36 * and therefore, elected the GPL Version 2 license, then the option applies
37 * only if the new code is made subject to such option by the copyright
38 * holder.
39 */
40
41package javax.json;
42
43/**
44 * <code>JsonValue</code> represents an immutable JSON value.
45 *
46 *
47 * <p>A JSON value is one of the following:
48 * an object ({@link JsonObject}), an array ({@link JsonArray}),
49 * a number ({@link JsonNumber}), a string ({@link JsonString}),
50 * {@code true} ({@link JsonValue#TRUE JsonValue.TRUE}), {@code false}
51 * ({@link JsonValue#FALSE JsonValue.FALSE}),
52 * or {@code null} ({@link JsonValue#NULL JsonValue.NULL}).
53 */
54public interface JsonValue {
55
56 /**
57 * The empty JSON object.
58 *
59 * @since 1.1
60 */
61 static final JsonObject EMPTY_JSON_OBJECT = new EmptyObject();
62
63 /**
64 * The empty JSON array.
65 *
66 * @since 1.1
67 */
68 static final JsonArray EMPTY_JSON_ARRAY = new EmptyArray();
69
70 /**
71 * Indicates the type of a {@link JsonValue} object.
72 */
73 enum ValueType {
74 /**
75 * JSON array.
76 */
77 ARRAY,
78
79 /**
80 * JSON object.
81 */
82 OBJECT,
83
84 /**
85 * JSON string.
86 */
87 STRING,
88
89 /**
90 * JSON number.
91 */
92 NUMBER,
93
94 /**
95 * JSON true.
96 */
97 TRUE,
98
99 /**
100 * JSON false.
101 */
102 FALSE,
103
104 /**
105 * JSON null.
106 */
107 NULL
108 }
109
110 /**
111 * JSON null value.
112 */
113 static final JsonValue NULL = new JsonValueImpl(ValueType.NULL);
114
115 /**
116 * JSON true value.
117 */
118 static final JsonValue TRUE = new JsonValueImpl(ValueType.TRUE);
119
120 /**
121 * JSON false value.
122 */
123 static final JsonValue FALSE = new JsonValueImpl(ValueType.FALSE);
124
125 /**
126 * Returns the value type of this JSON value.
127 *
128 * @return JSON value type
129 */
130 ValueType getValueType();
131
132 /**
133 * Return the JsonValue as a JsonObject
134 *
135 * @return the JsonValue as a JsonObject
136 * @throws ClassCastException if the JsonValue is not a JsonObject
137 *
138 * @since 1.1
139 */
140 default JsonObject asJsonObject() {
141 return JsonObject.class.cast(this);
142 }
143
144 /**
145 * Return the JsonValue as a JsonArray
146 *
147 * @return the JsonValue as a JsonArray
148 * @throws ClassCastException if the JsonValue is not a JsonArray
149 *
150 * @since 1.1
151 */
152 default JsonArray asJsonArray() {
153 return JsonArray.class.cast(this);
154 }
155
156 /**
157 * Returns JSON text for this JSON value.
158 *
159 * @return JSON text
160 */
161 @Override
162 String toString();
163
164}
Note: See TracBrowser for help on using the repository browser.