Class SuperficialValidation

java.lang.Object

com.google.auto.common.SuperficialValidation

public final class SuperficialValidation
extends Object

A utility class that traverses Element instances and ensures that all type information is present and resolvable.

Author:

Gregory Kick

Method Summary

Modifier and Type	Method	Description
static boolean	validateElement(Element element)	Returns true if all types referenced by the given element are defined.
static boolean	validateElements(Iterable<? extends Element> elements)	Returns true if all of the given elements return true from validateElement(Element).
static boolean	validateType(TypeMirror type)	Returns true if the given type is fully defined.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

validateElements

public static boolean validateElements(Iterable<? extends Element> elements)

Returns true if all of the given elements return true from validateElement(Element).

validateElement

public static boolean validateElement(Element element)

Returns true if all types referenced by the given element are defined. The exact meaning of this depends on the kind of element. For packages, it means that all annotations on the package are fully defined. For other element kinds, it means that types referenced by the element, anything it contains, and any of its annotations element are all defined.

validateType

public static boolean validateType(TypeMirror type)

Returns true if the given type is fully defined. This means that the type itself is defined, as are any types it references, such as any type arguments or type bounds. For an ExecutableType, the parameter and return types must be fully defined, as must types declared in a throws clause or in the bounds of any type parameters.