/*

 * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.jdi;

/**

 * Provides access to a primitive <code>char</code> value in

 * the target VM.

 *

 * @author Robert Field

 * @author Gordon Hirsch

 * @author James McIlree

 * @since  1.3

 */

@jdk.Exported

public interface CharValue extends PrimitiveValue, Comparable<CharValue> {

    /**

     * Returns this CharValue as a <code>char</code>.

     *

     * @return the <code>char</code> mirrored by this object.

     */

    char value();

    /**

     * Compares the specified Object with this CharValue for equality.

     *

     * @return true if the Object is a CharValue and if applying "=="

     * to the two mirrored primitives would evaluate to true; false

     * otherwise.

     */

    boolean equals(Object obj);

    /**

     * Returns the hash code value for this CharValue.

     *

     * @return the integer hash code

     */

    int hashCode();

}