Top Description Inners Fields Constructors Methods
org.codehaus.groovy.ast

public Class GenericsType

extends ASTNode
Class Inheritance
Imports
org.codehaus.groovy.ast.tools.GenericsUtils, .WideningCategories, java.lang.reflect.Modifier, java.util.Arrays, .HashSet, .Map, .Objects, .Set

This class is used to describe generic type signatures for ClassNodes.
See Also
ClassNode

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final GenericsType[]
private final ClassNode
private String
private boolean
private boolean
private ClassNode
private final ClassNode[]
private boolean

Constructor Summary

AccessConstructor and Description
public
GenericsType(final ClassNode type, final ClassNode[] upperBounds, final ClassNode lowerBound)

public
GenericsType(final ClassNode basicType)

Method Summary

Modifier and TypeMethod and Description
private static StringBuilder
appendName(final ClassNode theType, final StringBuilder sb)

private boolean
checkGenerics(final ClassNode classNode)

Compares the bounds of this generics specification against the given type for compatibility.

private static boolean

Returns:

true if generics are compatible
compareGenericsWithBound
(final ClassNode
the classnode from which we will compare generics types
classNode
,
final ClassNode
the bound to which the types will be compared
bound
)

Given a parameterized type (List<String> for example), checks that its generic types are compatible with those from a bound.

private static String
genericsBounds(final ClassNode theType, final Set<String> visited)

public ClassNode
public String
public ClassNode
public ClassNode[]
public boolean
isCompatibleWith(final ClassNode classNode)

Determines if the provided type is compatible with this specification.

public boolean
public boolean
public boolean
public void
setName(final String name)

public void
setPlaceholder(final boolean placeholder)

public void
setResolved(final boolean resolved)

public void
setType(final ClassNode type)

public void
setWildcard(final boolean wildcard)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
private static String
toString(final GenericsType gt, final Set<String> visited)

Inherited from org.codehaus.groovy.ast.ASTNode:
copyNodeMetaDatagetColumnNumbergetLastColumnNumbergetLastLineNumbergetLineNumbergetMetaDataMapgetTextsetColumnNumbersetLastColumnNumbersetLastLineNumbersetLineNumbersetMetaDataMapsetSourcePositionvisit

Field Detail

EMPTY_ARRAYback to summary
public static final GenericsType[] EMPTY_ARRAY
lowerBoundback to summary
private final ClassNode lowerBound
nameback to summary
private String name
placeholderback to summary
private boolean placeholder
resolvedback to summary
private boolean resolved
typeback to summary
private ClassNode type
upperBoundsback to summary
private final ClassNode[] upperBounds
wildcardback to summary
private boolean wildcard

Constructor Detail

GenericsTypeback to summary
public GenericsType(final ClassNode type, final ClassNode[] upperBounds, final ClassNode lowerBound)
GenericsTypeback to summary
public GenericsType(final ClassNode basicType)

Method Detail

appendNameback to summary
private static StringBuilder appendName(final ClassNode theType, final StringBuilder sb)
checkGenericsback to summary
private boolean checkGenerics(final ClassNode classNode)

Compares the bounds of this generics specification against the given type for compatibility. Ex: String would satisfy <? extends CharSequence>.

compareGenericsWithBoundback to summary
private static boolean compareGenericsWithBound(final ClassNode classNode, final ClassNode bound)

Given a parameterized type (List<String> for example), checks that its generic types are compatible with those from a bound.

Parameters
classNode:ClassNode

the classnode from which we will compare generics types

bound:ClassNode

the bound to which the types will be compared

Returns:boolean

true if generics are compatible

genericsBoundsback to summary
private static String genericsBounds(final ClassNode theType, final Set<String> visited)
getLowerBoundback to summary
public ClassNode getLowerBound()
getNameback to summary
public String getName()
getTypeback to summary
public ClassNode getType()
getUpperBoundsback to summary
public ClassNode[] getUpperBounds()
isCompatibleWithback to summary
public boolean isCompatibleWith(final ClassNode classNode)

Determines if the provided type is compatible with this specification. The check is complete, meaning that nested generics are also checked.

isPlaceholderback to summary
public boolean isPlaceholder()
isResolvedback to summary
public boolean isResolved()
isWildcardback to summary
public boolean isWildcard()
setNameback to summary
public void setName(final String name)
setPlaceholderback to summary
public void setPlaceholder(final boolean placeholder)
setResolvedback to summary
public void setResolved(final boolean resolved)
setTypeback to summary
public void setType(final ClassNode type)
setWildcardback to summary
public void setWildcard(final boolean wildcard)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
toStringback to summary
private static String toString(final GenericsType gt, final Set<String> visited)
org.codehaus.groovy.ast back to summary

public Class GenericsType.GenericsTypeName

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final String

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
that
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public String
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

nameback to summary
private final String name

Constructor Detail

GenericsTypeNameback to summary
public GenericsTypeName(final String name)

Method Detail

equalsback to summary
public boolean equals(Object that)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
that:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getNameback to summary
public String getName()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override