Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/javax/lang/model/element/Name.java@fcf89720ae71 (annotated)
src/share/classes/javax/lang/model/element/Name.java
Mon, 10 Dec 2012 16:21:26 +0000
- author
- vromero
- date
- Mon, 10 Dec 2012 16:21:26 +0000
- changeset 1442
- fcf89720ae71
- parent 554
- 9d9f26857129
- child 2525
- 2eb010b6cb22
- permissions
- -rw-r--r--
8003967: detect and remove all mutable implicit static enum fields in langtools
Reviewed-by: jjg
| duke@1 | 1 | /* |
| ohair@554 | 2 | * Copyright (c) 2006, Oracle and/or its affiliates. All rights reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@554 | 23 | * questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package javax.lang.model.element; |
| duke@1 | 27 | |
| duke@1 | 28 | /** |
| duke@1 | 29 | * An immutable sequence of characters. When created by the same |
| duke@1 | 30 | * implementation, objects implementing this interface must obey the |
| duke@1 | 31 | * general {@linkplain Object#equals equals contract} when compared |
| duke@1 | 32 | * with each other. Therefore, {@code Name} objects from the same |
| duke@1 | 33 | * implementation are usable in collections while {@code Name}s from |
| duke@1 | 34 | * different implementations may not work properly in collections. |
| duke@1 | 35 | * |
| duke@1 | 36 | * <p>An empty {@code Name} has a length of zero. |
| duke@1 | 37 | * |
| duke@1 | 38 | * <p>In the context of {@linkplain |
| duke@1 | 39 | * javax.annotation.processing.ProcessingEnvironment annotation |
| duke@1 | 40 | * processing}, the guarantees for "the same" implementation must |
| duke@1 | 41 | * include contexts where the {@linkplain javax.annotation.processing |
| duke@1 | 42 | * API mediated} side effects of {@linkplain |
| duke@1 | 43 | * javax.annotation.processing.Processor processors} could be visible |
| duke@1 | 44 | * to each other, including successive annotation processing |
| duke@1 | 45 | * {@linkplain javax.annotation.processing.RoundEnvironment rounds}. |
| duke@1 | 46 | * |
| duke@1 | 47 | * @author Joseph D. Darcy |
| duke@1 | 48 | * @author Scott Seligman |
| duke@1 | 49 | * @author Peter von der Ahé |
| duke@1 | 50 | * @see javax.lang.model.util.Elements#getName |
| duke@1 | 51 | * @since 1.6 |
| duke@1 | 52 | */ |
| duke@1 | 53 | public interface Name extends CharSequence { |
| duke@1 | 54 | /** |
| duke@1 | 55 | * Returns {@code true} if the argument represents the same |
| duke@1 | 56 | * name as {@code this}, and {@code false} otherwise. |
| duke@1 | 57 | * |
| duke@1 | 58 | * <p>Note that the identity of a {@code Name} is a function both |
| duke@1 | 59 | * of its content in terms of a sequence of characters as well as |
| duke@1 | 60 | * the implementation which created it. |
| duke@1 | 61 | * |
| duke@1 | 62 | * @param obj the object to be compared with this element |
| duke@1 | 63 | * @return {@code true} if the specified object represents the same |
| duke@1 | 64 | * name as this |
| duke@1 | 65 | * @see Element#equals |
| duke@1 | 66 | */ |
| duke@1 | 67 | boolean equals(Object obj); |
| duke@1 | 68 | |
| duke@1 | 69 | /** |
| duke@1 | 70 | * Obeys the general contract of {@link Object#hashCode Object.hashCode}. |
| duke@1 | 71 | * |
| duke@1 | 72 | * @see #equals |
| duke@1 | 73 | */ |
| duke@1 | 74 | int hashCode(); |
| duke@1 | 75 | |
| duke@1 | 76 | /** |
| duke@1 | 77 | * Compares this name to the specified {@code CharSequence}. The result |
| duke@1 | 78 | * is {@code true} if and only if this name represents the same sequence |
| duke@1 | 79 | * of {@code char} values as the specified sequence. |
| duke@1 | 80 | * |
| duke@1 | 81 | * @return {@code true} if this name represents the same sequence |
| duke@1 | 82 | * of {@code char} values as the specified sequence, {@code false} |
| duke@1 | 83 | * otherwise |
| duke@1 | 84 | * |
| duke@1 | 85 | * @param cs The sequence to compare this name against |
| duke@1 | 86 | * @see String#contentEquals(CharSequence) |
| duke@1 | 87 | */ |
| duke@1 | 88 | boolean contentEquals(CharSequence cs); |
| duke@1 | 89 | } |
