001/*
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003 *
004 * Copyright (c) 2011-2017 Oracle and/or its affiliates. All rights reserved.
005 *
006 * The contents of this file are subject to the terms of either the GNU
007 * General Public License Version 2 only ("GPL") or the Common Development
008 * and Distribution License("CDDL") (collectively, the "License").  You
009 * may not use this file except in compliance with the License.  You can
010 * obtain a copy of the License at
011 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
012 * or LICENSE.txt.  See the License for the specific
013 * language governing permissions and limitations under the License.
014 *
015 * When distributing the software, include this License Header Notice in each
016 * file and include the License file at LICENSE.txt.
017 *
018 * GPL Classpath Exception:
019 * Oracle designates this particular file as subject to the "Classpath"
020 * exception as provided by Oracle in the GPL Version 2 section of the License
021 * file that accompanied this code.
022 *
023 * Modifications:
024 * If applicable, add the following below the License Header, with the fields
025 * enclosed by brackets [] replaced by your own identifying information:
026 * "Portions Copyright [year] [name of copyright owner]"
027 *
028 * Contributor(s):
029 * If you wish your version of this file to be governed by only the CDDL or
030 * only the GPL Version 2, indicate your decision by adding "[Contributor]
031 * elects to include this software in this distribution under the [CDDL or GPL
032 * Version 2] license."  If you don't indicate a single choice of license, a
033 * recipient has the option to distribute your version of this file under
034 * either the CDDL, the GPL Version 2 or to extend the choice of license to
035 * its licensees as provided above.  However, if you add GPL Version 2 code
036 * and therefore, elected the GPL Version 2 license, then the option applies
037 * only if the new code is made subject to such option by the copyright
038 * holder.
039 */
040
041package javax.json;
042
043/**
044 * An immutable JSON string value.
045 *
046 * <EMBED CLASS='external-html' DATA-FILE-ID=LICENSE DATA-CIETName=JsonString>
047 */
048public interface JsonString extends JsonValue {
049
050    /**
051     * Returns the JSON string value.
052     *
053     * @return a JSON string value
054     */
055    String getString();
056
057
058    /**
059     * Returns the char sequence for the JSON String value
060     *
061     * @return a char sequence for the JSON String value
062     */
063    CharSequence getChars();
064
065    /**
066     * Compares the specified object with this {@code JsonString} for equality.
067     * Returns {@code true} if and only if the specified object is also a
068     * {@code JsonString}, and their {@link #getString()} objects are
069     * <i>equal</i>.
070     *
071     * @param obj the object to be compared for equality with this 
072     *      {@code JsonString}
073     * @return {@code true} if the specified object is equal to this 
074     *      {@code JsonString}
075     */
076    @Override
077    boolean equals(Object obj);
078
079    /**
080     * Returns the hash code value for this {@code JsonString} object.  
081     * The hash code of a {@code JsonString} object is defined to be its 
082     * {@link #getString()} object's hash code.
083     *
084     * @return the hash code value for this {@code JsonString} object
085     */
086    @Override
087    int hashCode();
088
089}