1 /*
2  * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 package com.sun.jdi;
27 
28 /**
29  * Provides access to a primitive <code>char</code> value in
30  * the target VM.
31  *
32  * @author Robert Field
33  * @author Gordon Hirsch
34  * @author James McIlree
35  * @since  1.3
36  */
37 @jdk.Exported
38 public interface CharValue extends PrimitiveValue, Comparable<CharValue> {
39 
40     /**
41      * Returns this CharValue as a <code>char</code>.
42      *
43      * @return the <code>char</code> mirrored by this object.
44      */
value()45     char value();
46 
47     /**
48      * Compares the specified Object with this CharValue for equality.
49      *
50      * @return true if the Object is a CharValue and if applying "=="
51      * to the two mirrored primitives would evaluate to true; false
52      * otherwise.
53      */
equals(Object obj)54     boolean equals(Object obj);
55 
56     /**
57      * Returns the hash code value for this CharValue.
58      *
59      * @return the integer hash code
60      */
hashCode()61     int hashCode();
62 }
63