Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

javax.ide.model.java.declaration
Class Declaration.DeclarationKind  view Declaration.DeclarationKind download Declaration.DeclarationKind.java

java.lang.Object
  extended byjavax.ide.model.java.declaration.Declaration.DeclarationKind
Enclosing class:
Declaration

public static final class Declaration.DeclarationKind
extends java.lang.Object

Identifies a Mirror.


Field Summary
static int DECL_ANNOTATION
          An annotation.
static int DECL_base
           
static int DECL_CLASS
          A class, interface, enum, or annotation type.
private static java.lang.Class[] DECL_classes
           
static int DECL_CONSTRUCTOR
          A field or enum constant.
static int DECL_FIELD
          A field or enum constant.
static int DECL_max
           
static int DECL_METHOD
          A method, constructor, or annotation element.
private static java.lang.String[] DECL_names
           
static int DECL_PACKAGE
          A method, constructor, or annotation element.
static int DECL_PARAMETER
          A parameter.
static int DECL_TYPE_VARIABLE
          A type variable.
static int DECL_WILDCARD_TYPE
          A wildcard type.
private  java.lang.Class declClass
           
private  java.lang.String name
           
private  int ordinal
           
private static java.util.Map values
           
 
Constructor Summary
private Declaration.DeclarationKind(int ordinal, java.lang.String name, java.lang.Class c)
           
 
Method Summary
 int compareTo(Declaration.DeclarationKind other)
           
 boolean equals(java.lang.Object other)
          Determine whether this Object is semantically equal to another Object.
 java.lang.Class getDeclarationClass()
           
 java.lang.Class getDeclaringClass()
           
 int hashCode()
          Get a value that represents this Object, as uniquely as possible within the confines of an int.
 java.lang.String name()
           
 int ordinal()
           
 java.lang.String toString()
          Convert this Object to a human-readable String.
static Declaration.DeclarationKind valueOf(java.lang.Class ignored, java.lang.String name)
           
static Declaration.DeclarationKind valueOf(int ordinal)
           
static Declaration.DeclarationKind[] values()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

DECL_base

public static final int DECL_base
See Also:
Constant Field Values

DECL_ANNOTATION

public static final int DECL_ANNOTATION
An annotation. AnnotationD.

See Also:
Constant Field Values

DECL_CLASS

public static final int DECL_CLASS
A class, interface, enum, or annotation type. ClassD.

See Also:
Constant Field Values

DECL_CONSTRUCTOR

public static final int DECL_CONSTRUCTOR
A field or enum constant. ConstructorD.

See Also:
Constant Field Values

DECL_FIELD

public static final int DECL_FIELD
A field or enum constant. FieldD.

See Also:
Constant Field Values

DECL_METHOD

public static final int DECL_METHOD
A method, constructor, or annotation element. MethodD.

See Also:
Constant Field Values

DECL_PACKAGE

public static final int DECL_PACKAGE
A method, constructor, or annotation element. PackageD.

See Also:
Constant Field Values

DECL_PARAMETER

public static final int DECL_PARAMETER
A parameter. ParameterD.

See Also:
Constant Field Values

DECL_TYPE_VARIABLE

public static final int DECL_TYPE_VARIABLE
A type variable. TypeVariableD.

See Also:
Constant Field Values

DECL_WILDCARD_TYPE

public static final int DECL_WILDCARD_TYPE
A wildcard type. WildcardTypeD.

See Also:
Constant Field Values

DECL_max

public static final int DECL_max
See Also:
Constant Field Values

ordinal

private final int ordinal

name

private final java.lang.String name

declClass

private final java.lang.Class declClass

values

private static final java.util.Map values

DECL_names

private static final java.lang.String[] DECL_names

DECL_classes

private static final java.lang.Class[] DECL_classes
Constructor Detail

Declaration.DeclarationKind

private Declaration.DeclarationKind(int ordinal,
                                    java.lang.String name,
                                    java.lang.Class c)
Method Detail

getDeclarationClass

public java.lang.Class getDeclarationClass()

name

public java.lang.String name()

toString

public java.lang.String toString()
Description copied from class: java.lang.Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).


ordinal

public int ordinal()

hashCode

public int hashCode()
Description copied from class: java.lang.Object
Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

  • Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
  • It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in java.util.Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)


compareTo

public int compareTo(Declaration.DeclarationKind other)

equals

public boolean equals(java.lang.Object other)
Description copied from class: java.lang.Object
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

  • It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
  • It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
  • It must be reflexive. a.equals(a) must always be true.
  • It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
  • a.equals(null) must be false.
  • It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.


getDeclaringClass

public java.lang.Class getDeclaringClass()

valueOf

public static Declaration.DeclarationKind valueOf(int ordinal)

valueOf

public static Declaration.DeclarationKind valueOf(java.lang.Class ignored,
                                                  java.lang.String name)

values

public static Declaration.DeclarationKind[] values()