Class AnnotationsReader

java.lang.Object

com.ibm.wala.shrike.shrikeCT.AttributeReader

com.ibm.wala.shrike.shrikeCT.AnnotationsReader

Direct Known Subclasses:

TypeAnnotationsReader

public class AnnotationsReader
extends AttributeReader

This class reads Annotations attributes, e.g., RuntimeInvisibleAnnotations.

Author:

sjfink

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnnotationsReader.AnnotationAttribute	Representation of an annotation attribute.
static enum	AnnotationsReader.AnnotationType
static class	AnnotationsReader.ArrayElementValue	represents an annotation argument that itself is an array of arguments
static class	AnnotationsReader.ConstantElementValue	Represents a constant argument to an annotation.
static interface	AnnotationsReader.ElementValue	Marker interface for possible element values in an annotation attribute.
static class	AnnotationsReader.EnumElementValue	Represents enum constant annotation arguments.

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	beginOffset	offset in class file where this attribute begins

Fields inherited from class AttributeReader

attr, cr, length

Modifier and Type	Field	Description
protected final int	attr
protected final ClassReader	cr
protected final int	length

Constructor Summary

Constructors

Constructor	Description
AnnotationsReader(ClassReader.AttrIterator iter, String label)

Method Summary

Modifier and Type	Method	Description
AnnotationsReader.AnnotationAttribute[]	getAllAnnotations()	get all the annotations declared in this attribute.
AnnotationsReader.AnnotationAttribute[][]	getAllParameterAnnotations()	param_annotations { u2 attribute_name_index; u4 attribute_length; u1 num_parameters; { u2 num_annotations; annotation annotations[num_annotations]; } parameter_annotations[num_parameters];
int	getAnnotationCount()
protected Pair<AnnotationsReader.AnnotationAttribute, Integer>	getAttributeAndSize(int begin)	annotation { u2 type_index; u2 num_element_value_pairs; { u2 element_name_index; element_value value; } element_value_pairs[num_element_value_pairs]
int	getAttributeSize()
static AnnotationsReader	getReaderForAnnotation(AnnotationsReader.AnnotationType type, ClassReader.AttrIterator iter)
protected String	getUtf8ConstantPoolValue(int offset)	get the Utf8 constant pool value, where the constant pool offset is given in the class
static boolean	isKnownAnnotation(String name)
protected Pair<AnnotationsReader.ElementValue, Integer>	readElementValueAndSize(int offset)	element_value { u1 tag; union { u2 const_value_index; { u2 type_name_index; u2 const_name_index; } enum_const_value; u2 class_info_index; annotation annotation_value; { u2 num_values; element_value values[num_values]; } array_value; } value;

Methods inherited from class AttributeReader

checkSize, checkSizeEquals, getClassReader, getRawOffset, getRawSize

Modifier and Type	Method	Description
protected final void	checkSize(int offset, int len)	Ensure that the len bytes starting at offset fall within the attribute data.
protected final void	checkSizeEquals(int offset, int len)	Ensure that the len bytes starting at offset end at the end of the attribute data.
final ClassReader	getClassReader()
final int	getRawOffset()
final int	getRawSize()

Methods inherited from class Object

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

Field Details

beginOffset

protected final int beginOffset

offset in class file where this attribute begins

Constructor Details

AnnotationsReader

public AnnotationsReader(ClassReader.AttrIterator iter,
 String label)
                  throws InvalidClassFileException

Throws:

InvalidClassFileException

Method Details

getAnnotationCount

public int getAnnotationCount()
                       throws InvalidClassFileException

Returns:

number of annotations in this attribute

Throws:

InvalidClassFileException

getAttributeSize

public int getAttributeSize()
                     throws InvalidClassFileException

Returns:

total length of this attribute in bytes, including the first 6 bytes

Throws:

InvalidClassFileException

getUtf8ConstantPoolValue

protected String getUtf8ConstantPoolValue(int offset)
                                   throws InvalidClassFileException

get the Utf8 constant pool value, where the constant pool offset is given in the class

Parameters:

offset - offset in the class file at which the constant pool offset is given

Throws:

InvalidClassFileException

getAllAnnotations

public AnnotationsReader.AnnotationAttribute[] getAllAnnotations()
                                                          throws InvalidClassFileException

get all the annotations declared in this attribute.

RuntimeVisibleAnnotations_attribute {
  u2         attribute_name_index;
  u4         attribute_length;
  u2         num_annotations;
  annotation annotations[num_annotations];
}

Throws:

InvalidClassFileException

See Also:

• JLS (SE8), 4.7.16

getAllParameterAnnotations

public AnnotationsReader.AnnotationAttribute[][] getAllParameterAnnotations()
                                                                     throws InvalidClassFileException

param_annotations {
  u2 attribute_name_index;
  u4 attribute_length;
  u1 num_parameters;
  {
    u2 num_annotations;
    annotation annotations[num_annotations];
  } parameter_annotations[num_parameters];

Throws:

InvalidClassFileException

getAttributeAndSize

protected Pair<AnnotationsReader.AnnotationAttribute, Integer> getAttributeAndSize(int begin)
                                                                            throws InvalidClassFileException

annotation {
  u2 type_index;
  u2 num_element_value_pairs;
  { u2 element_name_index;
    element_value value;
  } element_value_pairs[num_element_value_pairs]

Throws:

InvalidClassFileException

readElementValueAndSize

protected Pair<AnnotationsReader.ElementValue, Integer> readElementValueAndSize(int offset)
                                                                         throws IllegalArgumentException,
InvalidClassFileException

element_value {
  u1 tag;
  union {
    u2 const_value_index;
    {  u2 type_name_index;
       u2 const_name_index;
    } enum_const_value;
    u2 class_info_index;
    annotation annotation_value;
    {  u2 num_values;
       element_value values[num_values];
    } array_value;
  } value;

A constant value (including class info) is represented by a AnnotationsReader.ConstantElementValue. An enum constant value is represented by an AnnotationsReader.EnumElementValue. An array value is represented by an AnnotationsReader.ArrayElementValue. Finally, a nested annotation is represented by an AnnotationsReader.AnnotationAttribute.

Throws:

IllegalArgumentException

InvalidClassFileException

isKnownAnnotation

public static boolean isKnownAnnotation(String name)

getReaderForAnnotation

public static AnnotationsReader getReaderForAnnotation(AnnotationsReader.AnnotationType type,
 ClassReader.AttrIterator iter)