1 /* 2 * Copyright (c) 2006, 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 javax.lang.model.element; 27 28 /** 29 * An immutable sequence of characters. When created by the same 30 * implementation, objects implementing this interface must obey the 31 * general {@linkplain Object#equals equals contract} when compared 32 * with each other. Therefore, {@code Name} objects from the same 33 * implementation are usable in collections while {@code Name}s from 34 * different implementations may not work properly in collections. 35 * 36 * <p>An empty {@code Name} has a length of zero. 37 * 38 * <p>In the context of {@linkplain 39 * javax.annotation.processing.ProcessingEnvironment annotation 40 * processing}, the guarantees for "the same" implementation must 41 * include contexts where the {@linkplain javax.annotation.processing 42 * API mediated} side effects of {@linkplain 43 * javax.annotation.processing.Processor processors} could be visible 44 * to each other, including successive annotation processing 45 * {@linkplain javax.annotation.processing.RoundEnvironment rounds}. 46 * 47 * @author Joseph D. Darcy 48 * @author Scott Seligman 49 * @author Peter von der Ahé 50 * @see javax.lang.model.util.Elements#getName 51 * @since 1.6 52 */ 53 public interface Name extends CharSequence { 54 /** 55 * Returns {@code true} if this is an empty name with a length of 56 * zero; returns {@code false} otherwise. 57 * @return {@code true} for an empty name and {@code false} otherwise. 58 * 59 * @implSpec Returns the result of calling {@link 60 * CharSequence#isEmpty() CharSequence.isEmpty()}. 61 * @since 16 62 */ 63 @Override 64 default boolean isEmpty() { 65 return CharSequence.super.isEmpty(); 66 } 67 68 /** 69 * Returns {@code true} if the argument represents the same 70 * name as {@code this}, and {@code false} otherwise. 71 * 72 * <p>Note that the identity of a {@code Name} is a function both 73 * of its content in terms of a sequence of characters as well as 74 * the implementation which created it. 75 * 76 * @param obj the object to be compared with this element 77 * @return {@code true} if the specified object represents the same 78 * name as this 79 * @see Element#equals 80 */ 81 boolean equals(Object obj); 82 83 /** 84 * Obeys the general contract of {@link Object#hashCode Object.hashCode}. 85 * 86 * @see #equals 87 */ 88 int hashCode(); 89 90 /** 91 * Compares this name to the specified {@code CharSequence}. The result 92 * is {@code true} if and only if this name represents the same sequence 93 * of {@code char} values as the specified sequence. 94 * 95 * @return {@code true} if this name represents the same sequence 96 * of {@code char} values as the specified sequence, {@code false} 97 * otherwise 98 * 99 * @param cs The sequence to compare this name against 100 * @see String#contentEquals(CharSequence) 101 */ 102 boolean contentEquals(CharSequence cs); 103 }