TypeReferenceLocation (Windup 4.2.0.Final Javadoc API)

java.lang.Object
- java.lang.Enum<TypeReferenceLocation>
- - org.jboss.windup.ast.java.data.TypeReferenceLocation

All Implemented Interfaces:

Serializable, Comparable<TypeReferenceLocation>
```
public enum TypeReferenceLocation
extends Enum<TypeReferenceLocation>
```
Designates a location where a given ClassReference was found in a Java source file.

Author:

Lincoln Baxter, III

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ANNOTATION` A Java class references the annotation.
`CATCH_EXCEPTION_STATEMENT` A Java class method catches the specified type.
`CONSTRUCTOR_CALL` A Java class constructs the specified type.
`ENUM_CONSTANT` A Java class declares the enumeration.
`FIELD_DECLARATION` A Java class declares a field of the specified type.
`IMPLEMENTS_TYPE` A Java class implements the specified type; works transitively.
`IMPORT` A Java class imports the type.
`INHERITANCE` A Java class inherits the specified type; works transitively.
`INSTANCE_OF` A Java class of the specified type is used in an `instanceof` statement.
`METHOD` A Java class declares the referenced method.
`METHOD_CALL` A Java class calls the specified method; works transitively for interfaces.
`METHOD_PARAMETER` A Java class declares the referenced method parameter.
`RETURN_TYPE` A Java class returns the specified type.
`TAGLIB_IMPORT` This is only relevant for JSP sources and represents the import of a taglib into the JSP source file.
`THROW_STATEMENT` A method in the Java class throws the an instance of the specified type.
`THROWS_METHOD_DECLARATION` A Java class declares that it may throw the specified type.
`TYPE` A Java class declares the type.
`VARIABLE_DECLARATION` A Java class declares a variable of the specified type.
`VARIABLE_INITIALIZER` A variable initalization expression value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`toReadablePrefix()` Returns the enumeration as a human readable value.
`static TypeReferenceLocation`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static TypeReferenceLocation[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - IMPORT
```
public static final TypeReferenceLocation IMPORT
```
    A Java class imports the type.
  - TYPE
```
public static final TypeReferenceLocation TYPE
```
    A Java class declares the type.
  - ENUM_CONSTANT
```
public static final TypeReferenceLocation ENUM_CONSTANT
```
    A Java class declares the enumeration.
  - METHOD
```
public static final TypeReferenceLocation METHOD
```
    A Java class declares the referenced method.
  - INHERITANCE
```
public static final TypeReferenceLocation INHERITANCE
```
    A Java class inherits the specified type; works transitively.
  - CONSTRUCTOR_CALL
```
public static final TypeReferenceLocation CONSTRUCTOR_CALL
```
    A Java class constructs the specified type.
  - METHOD_CALL
```
public static final TypeReferenceLocation METHOD_CALL
```
    A Java class calls the specified method; works transitively for interfaces. That means, if there's a rule with an interface FQCN and it has <location>METHOD_CALL</location>, a call of a method on types implementing or exntending that interface will fire the rule.
  - METHOD_PARAMETER
```
public static final TypeReferenceLocation METHOD_PARAMETER
```
    A Java class declares the referenced method parameter.
  - ANNOTATION
```
public static final TypeReferenceLocation ANNOTATION
```
    A Java class references the annotation.
  - RETURN_TYPE
```
public static final TypeReferenceLocation RETURN_TYPE
```
    A Java class returns the specified type.
  - INSTANCE_OF
```
public static final TypeReferenceLocation INSTANCE_OF
```
    A Java class of the specified type is used in an instanceof statement.
  - THROWS_METHOD_DECLARATION
```
public static final TypeReferenceLocation THROWS_METHOD_DECLARATION
```
    A Java class declares that it may throw the specified type.
  - THROW_STATEMENT
```
public static final TypeReferenceLocation THROW_STATEMENT
```
    A method in the Java class throws the an instance of the specified type.
  - CATCH_EXCEPTION_STATEMENT
```
public static final TypeReferenceLocation CATCH_EXCEPTION_STATEMENT
```
    A Java class method catches the specified type.
  - FIELD_DECLARATION
```
public static final TypeReferenceLocation FIELD_DECLARATION
```
    A Java class declares a field of the specified type.
  - VARIABLE_DECLARATION
```
public static final TypeReferenceLocation VARIABLE_DECLARATION
```
    A Java class declares a variable of the specified type.
  - IMPLEMENTS_TYPE
```
public static final TypeReferenceLocation IMPLEMENTS_TYPE
```
    A Java class implements the specified type; works transitively.
  - VARIABLE_INITIALIZER
```
public static final TypeReferenceLocation VARIABLE_INITIALIZER
```
    A variable initalization expression value. For example, this would resolve to "mypackage.MyConstants.FOO" for the following field declaration:
```
 int foo = mypackage.MyConstants.FOO;
 
```
  - TAGLIB_IMPORT
```
public static final TypeReferenceLocation TAGLIB_IMPORT
```
    This is only relevant for JSP sources and represents the import of a taglib into the JSP source file.
- Method Detail
  - values
```
public static TypeReferenceLocation[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (TypeReferenceLocation c : TypeReferenceLocation.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TypeReferenceLocation valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - toReadablePrefix
```
public String toReadablePrefix()
```
    Returns the enumeration as a human readable value.

Enum TypeReferenceLocation

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

IMPORT

TYPE

ENUM_CONSTANT

METHOD

INHERITANCE

CONSTRUCTOR_CALL

METHOD_CALL

METHOD_PARAMETER

ANNOTATION

RETURN_TYPE

INSTANCE_OF

THROWS_METHOD_DECLARATION

THROW_STATEMENT

CATCH_EXCEPTION_STATEMENT

FIELD_DECLARATION

VARIABLE_DECLARATION

IMPLEMENTS_TYPE

VARIABLE_INITIALIZER

TAGLIB_IMPORT

Method Detail

values

valueOf

toReadablePrefix