| 1 | /*
|
|---|
| 2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
|
|---|
| 3 | *
|
|---|
| 4 | * Copyright (c) 2011-2013 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://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
|
|---|
| 12 | * or packager/legal/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 packager/legal/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 |
|
|---|
| 41 | package javax.json;
|
|---|
| 42 |
|
|---|
| 43 | /**
|
|---|
| 44 | * An immutable JSON string value.
|
|---|
| 45 | *
|
|---|
| 46 | * @author Jitendra Kotamraju
|
|---|
| 47 | */
|
|---|
| 48 | public interface JsonString extends JsonValue {
|
|---|
| 49 |
|
|---|
| 50 | /**
|
|---|
| 51 | * Returns the JSON string value.
|
|---|
| 52 | *
|
|---|
| 53 | * @return a JSON string value
|
|---|
| 54 | */
|
|---|
| 55 | String getString();
|
|---|
| 56 |
|
|---|
| 57 |
|
|---|
| 58 | /**
|
|---|
| 59 | * Returns the char sequence for the JSON String value
|
|---|
| 60 | *
|
|---|
| 61 | * @return a char sequence for the JSON String value
|
|---|
| 62 | */
|
|---|
| 63 | CharSequence getChars();
|
|---|
| 64 |
|
|---|
| 65 | /**
|
|---|
| 66 | * Compares the specified object with this {@code JsonString} for equality.
|
|---|
| 67 | * Returns {@code true} if and only if the specified object is also a
|
|---|
| 68 | * {@code JsonString}, and their {@link #getString()} objects are
|
|---|
| 69 | * <i>equal</i>.
|
|---|
| 70 | *
|
|---|
| 71 | * @param obj the object to be compared for equality with this
|
|---|
| 72 | * {@code JsonString}
|
|---|
| 73 | * @return {@code true} if the specified object is equal to this
|
|---|
| 74 | * {@code JsonString}
|
|---|
| 75 | */
|
|---|
| 76 | @Override
|
|---|
| 77 | boolean equals(Object obj);
|
|---|
| 78 |
|
|---|
| 79 | /**
|
|---|
| 80 | * Returns the hash code value for this {@code JsonString} object.
|
|---|
| 81 | * The hash code of a {@code JsonString} object is defined to be its
|
|---|
| 82 | * {@link #getString()} object's hash code.
|
|---|
| 83 | *
|
|---|
| 84 | * @return the hash code value for this {@code JsonString} object
|
|---|
| 85 | */
|
|---|
| 86 | @Override
|
|---|
| 87 | int hashCode();
|
|---|
| 88 |
|
|---|
| 89 | }
|
|---|
