javax.lang.model.element: public interface: Name

javax.lang.model.element
public interface: Name [javadoc | source]

All Implemented Interfaces:
CharSequence

An immutable sequence of characters. When created by the same implementation, objects implementing this interface must obey the general {@linkplain Object#equals equals contract} when compared with each other. Therefore, {@code Name} objects from the same implementation are usable in collections while {@code Name}s from different implementations may not work properly in collections.

An empty {@code Name} has a length of zero.

In the context of {@linkplain javax.annotation.processing.ProcessingEnvironment annotation processing}, the guarantees for "the same" implementation must include contexts where the {@linkplain javax.annotation.processing API mediated} side effects of {@linkplain javax.annotation.processing.Processor processors} could be visible to each other, including successive annotation processing {@linkplain javax.annotation.processing.RoundEnvironment rounds}.

Also see:

javax.lang.model.util.Elements#getName

author: Joseph - D. Darcy

author: Scott - Seligman

author: Peter - von der Ahé

since: 1.6 -

Method from javax.lang.model.element.Name Summary:
contentEquals, equals, hashCode

Method from javax.lang.model.element.Name Detail:
public boolean contentEquals(CharSequence cs) Compares this name to the specified {@code CharSequence}. The result is {@code true} if and only if this name represents the same sequence of {@code char} values as the specified sequence.
public boolean equals(Object obj) Returns {@code true} if the argument represents the same name as {@code this}, and {@code false} otherwise. Note that the identity of a {@code Name} is a function both of its content in terms of a sequence of characters as well as the implementation which created it.
public int hashCode() Obeys the general contract of Object.hashCode .

Method from javax.lang.model.element.Name Detail:

 public boolean contentEquals(CharSequence cs)Compares this name to the specified {@code CharSequence}. The result
is {@code true} if and only if this name represents the same sequence
of {@code char} values as the specified sequence.

 public boolean equals(Object obj)Returns {@code true} if the argument represents the same
name as {@code this}, and {@code false} otherwise.

Note that the identity of a {@code Name} is a function both
of its content in terms of a sequence of characters as well as
the implementation which created it.

 public int hashCode()Obeys the general contract of  Object.hashCode .