Package org.objectweb.asm.util

Class CheckSignatureAdapter

java.lang.Object

org.objectweb.asm.signature.SignatureVisitor

org.objectweb.asm.util.CheckSignatureAdapter

public class CheckSignatureAdapter
extends SignatureVisitor

A SignatureVisitor that checks that its methods are properly used.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	CheckSignatureAdapter.State	The possible states of the automaton used to check the order of method calls.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	canBeVoid	Whether the visited signature can be 'V'.
static final int	CLASS_SIGNATURE	Type to be used to check class signatures.
private static final String	INVALID
static final int	METHOD_SIGNATURE	Type to be used to check method signatures.
private final SignatureVisitor	signatureVisitor	The visitor to which this adapter must delegate calls.
private CheckSignatureAdapter.State	state	The current state of the automaton used to check the order of method calls.
private final int	type	The type of the visited signature.
static final int	TYPE_SIGNATURE	Type to be used to check type signatures.See CheckSignatureAdapter(int, SignatureVisitor).
private static final EnumSet<CheckSignatureAdapter.State>	VISIT_CLASS_BOUND_STATES	The valid automaton states for a visitClassBound() method call.
private static final EnumSet<CheckSignatureAdapter.State>	VISIT_EXCEPTION_TYPE_STATES	The valid automaton states for a visitExceptionType() method call.
private static final EnumSet<CheckSignatureAdapter.State>	VISIT_FORMAL_TYPE_PARAMETER_STATES	The valid automaton states for a visitFormalTypeParameter(java.lang.String) method call.
private static final EnumSet<CheckSignatureAdapter.State>	VISIT_INTERFACE_BOUND_STATES	The valid automaton states for a visitInterfaceBound() method call.
private static final EnumSet<CheckSignatureAdapter.State>	VISIT_INTERFACE_STATES	The valid automaton states for a visitInterface() method call.
private static final EnumSet<CheckSignatureAdapter.State>	VISIT_PARAMETER_TYPE_STATES	The valid automaton states for a visitParameterType() method call.
private static final EnumSet<CheckSignatureAdapter.State>	VISIT_RETURN_TYPE_STATES	The valid automaton states for a visitReturnType() method call.
private static final EnumSet<CheckSignatureAdapter.State>	VISIT_SUPER_CLASS_STATES	The valid automaton states for a visitSuperclass() method call.

Fields inherited from class org.objectweb.asm.signature.SignatureVisitor

api, EXTENDS, INSTANCEOF, SUPER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CheckSignatureAdapter(int api, int type, SignatureVisitor signatureVisitor)	Constructs a new CheckSignatureAdapter.
	CheckSignatureAdapter(int type, SignatureVisitor signatureVisitor)	Constructs a new CheckSignatureAdapter.

Method Summary

Modifier and Type	Method	Description
private void	checkClassName(String name, String message)
private void	checkIdentifier(String name, String message)
SignatureVisitor	visitArrayType()	Visits a signature corresponding to an array type.
void	visitBaseType(char descriptor)	Visits a signature corresponding to a primitive type.
SignatureVisitor	visitClassBound()	Visits the class bound of the last visited formal type parameter.
void	visitClassType(String name)	Starts the visit of a signature corresponding to a class or interface type.
void	visitEnd()	Ends the visit of a signature corresponding to a class or interface type.
SignatureVisitor	visitExceptionType()	Visits the type of a method exception.
void	visitFormalTypeParameter(String name)	Visits a formal type parameter.
void	visitInnerClassType(String name)	Visits an inner class.
SignatureVisitor	visitInterface()	Visits the type of an interface implemented by the class.
SignatureVisitor	visitInterfaceBound()	Visits an interface bound of the last visited formal type parameter.
SignatureVisitor	visitParameterType()	Visits the type of a method parameter.
SignatureVisitor	visitReturnType()	Visits the return type of the method.
SignatureVisitor	visitSuperclass()	Visits the type of the super class.
void	visitTypeArgument()	Visits an unbounded type argument of the last visited class or inner class type.
SignatureVisitor	visitTypeArgument(char wildcard)	Visits a type argument of the last visited class or inner class type.
void	visitTypeVariable(String name)	Visits a signature corresponding to a type variable.

Methods inherited from class java.lang.Object

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

Field Details

CLASS_SIGNATURE

public static final int CLASS_SIGNATURE

Type to be used to check class signatures. See CheckSignatureAdapter(int, SignatureVisitor).

See Also:

• Constant Field Values

METHOD_SIGNATURE

public static final int METHOD_SIGNATURE

Type to be used to check method signatures. See CheckSignatureAdapter(int, SignatureVisitor).

See Also:

• Constant Field Values

TYPE_SIGNATURE

public static final int TYPE_SIGNATURE

Type to be used to check type signatures.See CheckSignatureAdapter(int, SignatureVisitor).

See Also:

• Constant Field Values

VISIT_FORMAL_TYPE_PARAMETER_STATES

private static final EnumSet<CheckSignatureAdapter.State> VISIT_FORMAL_TYPE_PARAMETER_STATES

The valid automaton states for a visitFormalTypeParameter(java.lang.String) method call.

VISIT_CLASS_BOUND_STATES

private static final EnumSet<CheckSignatureAdapter.State> VISIT_CLASS_BOUND_STATES

The valid automaton states for a visitClassBound() method call.

VISIT_INTERFACE_BOUND_STATES

private static final EnumSet<CheckSignatureAdapter.State> VISIT_INTERFACE_BOUND_STATES

The valid automaton states for a visitInterfaceBound() method call.

VISIT_SUPER_CLASS_STATES

private static final EnumSet<CheckSignatureAdapter.State> VISIT_SUPER_CLASS_STATES

The valid automaton states for a visitSuperclass() method call.

VISIT_INTERFACE_STATES

private static final EnumSet<CheckSignatureAdapter.State> VISIT_INTERFACE_STATES

The valid automaton states for a visitInterface() method call.

VISIT_PARAMETER_TYPE_STATES

private static final EnumSet<CheckSignatureAdapter.State> VISIT_PARAMETER_TYPE_STATES

The valid automaton states for a visitParameterType() method call.

VISIT_RETURN_TYPE_STATES

private static final EnumSet<CheckSignatureAdapter.State> VISIT_RETURN_TYPE_STATES

The valid automaton states for a visitReturnType() method call.

VISIT_EXCEPTION_TYPE_STATES

private static final EnumSet<CheckSignatureAdapter.State> VISIT_EXCEPTION_TYPE_STATES

The valid automaton states for a visitExceptionType() method call.

INVALID

private static final String INVALID

See Also:

• Constant Field Values

type

private final int type

The type of the visited signature.

state

private CheckSignatureAdapter.State state

The current state of the automaton used to check the order of method calls.

canBeVoid

private boolean canBeVoid

Whether the visited signature can be 'V'.

signatureVisitor

private final SignatureVisitor signatureVisitor

The visitor to which this adapter must delegate calls. May be null.

Constructor Details

CheckSignatureAdapter

public CheckSignatureAdapter(int type,
 SignatureVisitor signatureVisitor)

Constructs a new CheckSignatureAdapter. Subclasses must not use this constructor. Instead, they must use the CheckSignatureAdapter(int, int, SignatureVisitor) version.

Parameters:

type - the type of signature to be checked. See CLASS_SIGNATURE, METHOD_SIGNATURE and TYPE_SIGNATURE.

signatureVisitor - the visitor to which this adapter must delegate calls. May be null.

CheckSignatureAdapter

protected CheckSignatureAdapter(int api,
 int type,
 SignatureVisitor signatureVisitor)

Constructs a new CheckSignatureAdapter.

Parameters:

api - the ASM API version implemented by this visitor. Must be one of the ASMx values in Opcodes.

type - the type of signature to be checked. See CLASS_SIGNATURE, METHOD_SIGNATURE and TYPE_SIGNATURE.

signatureVisitor - the visitor to which this adapter must delegate calls. May be null.

Method Details

visitFormalTypeParameter

public void visitFormalTypeParameter(String name)

Description copied from class: SignatureVisitor

Visits a formal type parameter.

Overrides:

visitFormalTypeParameter in class SignatureVisitor

Parameters:

name - the name of the formal parameter.

visitClassBound

public SignatureVisitor visitClassBound()

Description copied from class: SignatureVisitor

Visits the class bound of the last visited formal type parameter.

Overrides:

visitClassBound in class SignatureVisitor

Returns:

a non null visitor to visit the signature of the class bound.

visitInterfaceBound

public SignatureVisitor visitInterfaceBound()

Description copied from class: SignatureVisitor

Visits an interface bound of the last visited formal type parameter.

Overrides:

visitInterfaceBound in class SignatureVisitor

Returns:

a non null visitor to visit the signature of the interface bound.

visitSuperclass

public SignatureVisitor visitSuperclass()

Description copied from class: SignatureVisitor

Visits the type of the super class.

Overrides:

visitSuperclass in class SignatureVisitor

Returns:

a non null visitor to visit the signature of the super class type.

visitInterface

public SignatureVisitor visitInterface()

Description copied from class: SignatureVisitor

Visits the type of an interface implemented by the class.

Overrides:

visitInterface in class SignatureVisitor

Returns:

a non null visitor to visit the signature of the interface type.

visitParameterType

public SignatureVisitor visitParameterType()

Description copied from class: SignatureVisitor

Visits the type of a method parameter.

Overrides:

visitParameterType in class SignatureVisitor

Returns:

a non null visitor to visit the signature of the parameter type.

visitReturnType

public SignatureVisitor visitReturnType()

Description copied from class: SignatureVisitor

Visits the return type of the method.

Overrides:

visitReturnType in class SignatureVisitor

Returns:

a non null visitor to visit the signature of the return type.

visitExceptionType

public SignatureVisitor visitExceptionType()

Description copied from class: SignatureVisitor

Visits the type of a method exception.

Overrides:

visitExceptionType in class SignatureVisitor

Returns:

a non null visitor to visit the signature of the exception type.

visitBaseType

public void visitBaseType(char descriptor)

Description copied from class: SignatureVisitor

Visits a signature corresponding to a primitive type.

Overrides:

visitBaseType in class SignatureVisitor

Parameters:

descriptor - the descriptor of the primitive type, or 'V' for void .

visitTypeVariable

public void visitTypeVariable(String name)

Description copied from class: SignatureVisitor

Visits a signature corresponding to a type variable.

Overrides:

visitTypeVariable in class SignatureVisitor

Parameters:

name - the name of the type variable.

visitArrayType

public SignatureVisitor visitArrayType()

Description copied from class: SignatureVisitor

Visits a signature corresponding to an array type.

Overrides:

visitArrayType in class SignatureVisitor

Returns:

a non null visitor to visit the signature of the array element type.

visitClassType

public void visitClassType(String name)

Description copied from class: SignatureVisitor

Starts the visit of a signature corresponding to a class or interface type.

Overrides:

visitClassType in class SignatureVisitor

Parameters:

name - the internal name of the class or interface (see Type.getInternalName()).

visitInnerClassType

public void visitInnerClassType(String name)

Description copied from class: SignatureVisitor

Visits an inner class.

Overrides:

visitInnerClassType in class SignatureVisitor

Parameters:

name - the local name of the inner class in its enclosing class.

visitTypeArgument

public void visitTypeArgument()

Description copied from class: SignatureVisitor

Visits an unbounded type argument of the last visited class or inner class type.

Overrides:

visitTypeArgument in class SignatureVisitor

visitTypeArgument

public SignatureVisitor visitTypeArgument(char wildcard)

Description copied from class: SignatureVisitor

Visits a type argument of the last visited class or inner class type.

Overrides:

visitTypeArgument in class SignatureVisitor

Parameters:

wildcard - '+', '-' or '='.

Returns:

a non null visitor to visit the signature of the type argument.

visitEnd

public void visitEnd()

Description copied from class: SignatureVisitor

Ends the visit of a signature corresponding to a class or interface type.

Overrides:

visitEnd in class SignatureVisitor

checkClassName

private void checkClassName(String name,
 String message)

checkIdentifier

private void checkIdentifier(String name,
 String message)