duke@1: /*
ohair@554:  * Copyright (c) 2006, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package javax.lang.model.element;
duke@1: 
duke@1: /**
duke@1:  * An immutable sequence of characters.  When created by the same
duke@1:  * implementation, objects implementing this interface must obey the
duke@1:  * general {@linkplain Object#equals equals contract} when compared
duke@1:  * with each other.  Therefore, {@code Name} objects from the same
duke@1:  * implementation are usable in collections while {@code Name}s from
duke@1:  * different implementations may not work properly in collections.
duke@1:  *
duke@1:  * <p>An empty {@code Name} has a length of zero.
duke@1:  *
duke@1:  * <p>In the context of {@linkplain
duke@1:  * javax.annotation.processing.ProcessingEnvironment annotation
duke@1:  * processing}, the guarantees for "the same" implementation must
duke@1:  * include contexts where the {@linkplain javax.annotation.processing
duke@1:  * API mediated} side effects of {@linkplain
duke@1:  * javax.annotation.processing.Processor processors} could be visible
duke@1:  * to each other, including successive annotation processing
duke@1:  * {@linkplain javax.annotation.processing.RoundEnvironment rounds}.
duke@1:  *
duke@1:  * @author Joseph D. Darcy
duke@1:  * @author Scott Seligman
duke@1:  * @author Peter von der Ah&eacute;
duke@1:  * @see javax.lang.model.util.Elements#getName
duke@1:  * @since 1.6
duke@1:  */
duke@1: public interface Name extends CharSequence {
duke@1:     /**
duke@1:      * Returns {@code true} if the argument represents the same
duke@1:      * name as {@code this}, and {@code false} otherwise.
duke@1:      *
duke@1:      * <p>Note that the identity of a {@code Name} is a function both
duke@1:      * of its content in terms of a sequence of characters as well as
duke@1:      * the implementation which created it.
duke@1:      *
duke@1:      * @param obj  the object to be compared with this element
duke@1:      * @return {@code true} if the specified object represents the same
duke@1:      *          name as this
duke@1:      * @see Element#equals
duke@1:      */
duke@1:     boolean equals(Object obj);
duke@1: 
duke@1:     /**
duke@1:      * Obeys the general contract of {@link Object#hashCode Object.hashCode}.
duke@1:      *
duke@1:      * @see #equals
duke@1:      */
duke@1:     int hashCode();
duke@1: 
duke@1:     /**
duke@1:      * Compares this name to the specified {@code CharSequence}. The result
duke@1:      * is {@code true} if and only if this name represents the same sequence
duke@1:      * of {@code char} values as the specified sequence.
duke@1:      *
duke@1:      * @return {@code true} if this name represents the same sequence
duke@1:      * of {@code char} values as the specified sequence, {@code false}
duke@1:      * otherwise
duke@1:      *
duke@1:      * @param cs The sequence to compare this name against
duke@1:      * @see String#contentEquals(CharSequence)
duke@1:      */
duke@1:     boolean contentEquals(CharSequence cs);
duke@1: }