source: josm/trunk/src/javax/json/JsonString.java@ 14537

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

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

File size: 3.1 KB
RevLine 
[13231]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 * An immutable JSON string value.
45 */
46public interface JsonString extends JsonValue {
47
48 /**
49 * Returns the JSON string value.
50 *
51 * @return a JSON string value
52 */
53 String getString();
54
55
56 /**
57 * Returns the char sequence for the JSON String value
58 *
59 * @return a char sequence for the JSON String value
60 */
61 CharSequence getChars();
62
63 /**
64 * Compares the specified object with this {@code JsonString} for equality.
65 * Returns {@code true} if and only if the specified object is also a
66 * {@code JsonString}, and their {@link #getString()} objects are
67 * <i>equal</i>.
68 *
69 * @param obj the object to be compared for equality with this
70 * {@code JsonString}
71 * @return {@code true} if the specified object is equal to this
72 * {@code JsonString}
73 */
74 @Override
75 boolean equals(Object obj);
76
77 /**
78 * Returns the hash code value for this {@code JsonString} object.
79 * The hash code of a {@code JsonString} object is defined to be its
80 * {@link #getString()} object's hash code.
81 *
82 * @return the hash code value for this {@code JsonString} object
83 */
84 @Override
85 int hashCode();
86
87}
Note: See TracBrowser for help on using the repository browser.