com.amazon.carbonado.util

Class AnnotationDescPrinter

java.lang.Object

com.amazon.carbonado.util.AnnotationVisitor<java.lang.Object,java.lang.Object>

com.amazon.carbonado.util.AnnotationDescPrinter

public class AnnotationDescPrinter
extends AnnotationVisitor<java.lang.Object,java.lang.Object>

Prints machine readable, self-describing, annotation descriptors.

Author:

Brian S O'Neill

See Also:

AnnotationDescParser

Constructor Summary

Constructors

Constructor and Description
AnnotationDescPrinter(boolean sort, java.lang.StringBuilder b)

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	makePlainDescriptor(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) Returns an annotation descriptor that has no parameters.
static java.lang.String	makePlainDescriptor(java.lang.String annotationType) Returns an annotation descriptor that has no parameters.
java.lang.Object	visit(java.lang.annotation.Annotation value) Prints the annotation to the builder passed to the constructor.
java.lang.Object	visit(java.lang.String name, int pos, java.lang.annotation.Annotation[] value, java.lang.Object param) Visits each array element.
java.lang.Object	visit(java.lang.String name, int pos, java.lang.annotation.Annotation value, java.lang.Object param) Visits an annotation by breaking it down into its components and calling various other visit methods.
java.lang.Object	visit(java.lang.String name, int pos, boolean[] value, java.lang.Object param) Visits each array element.
java.lang.Object	visit(java.lang.String name, int pos, boolean value, java.lang.Object param) Override to visit booleans.
java.lang.Object	visit(java.lang.String name, int pos, byte[] value, java.lang.Object param) Visits each array element.
java.lang.Object	visit(java.lang.String name, int pos, byte value, java.lang.Object param) Override to visit bytes.
java.lang.Object	visit(java.lang.String name, int pos, char[] value, java.lang.Object param) Visits each array element.
java.lang.Object	visit(java.lang.String name, int pos, char value, java.lang.Object param) Override to visit chars.
java.lang.Object	visit(java.lang.String name, int pos, java.lang.Class[] value, java.lang.Object param) Visits each array element.
java.lang.Object	visit(java.lang.String name, int pos, java.lang.Class value, java.lang.Object param) Override to visit Classes.
java.lang.Object	visit(java.lang.String name, int pos, double[] value, java.lang.Object param) Visits each array element.
java.lang.Object	visit(java.lang.String name, int pos, double value, java.lang.Object param) Override to visit doubles.
java.lang.Object	visit(java.lang.String name, int pos, java.lang.Enum[] value, java.lang.Object param) Visits each array element.
java.lang.Object	visit(java.lang.String name, int pos, java.lang.Enum value, java.lang.Object param) Override to visit Enums.
java.lang.Object	visit(java.lang.String name, int pos, float[] value, java.lang.Object param) Visits each array element.
java.lang.Object	visit(java.lang.String name, int pos, float value, java.lang.Object param) Override to visit floats.
java.lang.Object	visit(java.lang.String name, int pos, int[] value, java.lang.Object param) Visits each array element.
java.lang.Object	visit(java.lang.String name, int pos, int value, java.lang.Object param) Override to visit ints.
java.lang.Object	visit(java.lang.String name, int pos, long[] value, java.lang.Object param) Visits each array element.
java.lang.Object	visit(java.lang.String name, int pos, long value, java.lang.Object param) Override to visit longs.
java.lang.Object	visit(java.lang.String name, int pos, short[] value, java.lang.Object param) Visits each array element.
java.lang.Object	visit(java.lang.String name, int pos, short value, java.lang.Object param) Override to visit shorts.
java.lang.Object	visit(java.lang.String name, int pos, java.lang.String[] value, java.lang.Object param) Visits each array element.
java.lang.Object	visit(java.lang.String name, int pos, java.lang.String value, java.lang.Object param) Override to visit Strings.

Methods inherited from class com.amazon.carbonado.util.AnnotationVisitor

visit

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationDescPrinter

public AnnotationDescPrinter(boolean sort,
                     java.lang.StringBuilder b)

Parameters:

sort - when true, sort annotation members by name (case sensitive)

b - StringBuilder to get printed results

Method Detail

makePlainDescriptor

public static java.lang.String makePlainDescriptor(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

Returns an annotation descriptor that has no parameters.

makePlainDescriptor

public static java.lang.String makePlainDescriptor(java.lang.String annotationType)

Returns an annotation descriptor that has no parameters.

visit

public java.lang.Object visit(java.lang.annotation.Annotation value)

Prints the annotation to the builder passed to the constructor.

Parameters:

value - Annotation to visit

Returns:

null

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     java.lang.annotation.Annotation value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Visits an annotation by breaking it down into its components and calling various other visit methods.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member or not part of an annotation

pos - position of member in list or array

value - Annotation visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     int value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Override to visit ints.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - int visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     long value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Override to visit longs.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - long visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     float value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Override to visit floats.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - float visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     double value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Override to visit doubles.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - double visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     boolean value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Override to visit booleans.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - boolean visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     byte value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Override to visit bytes.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - byte visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     short value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Override to visit shorts.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - short visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     char value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Override to visit chars.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - char visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     java.lang.String value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Override to visit Strings.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - String visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     java.lang.Class value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Override to visit Classes.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - Class visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     java.lang.Enum value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Override to visit Enums.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - Enum visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     java.lang.annotation.Annotation[] value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Visits each array element.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - Annotation array visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     int[] value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Visits each array element.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - int array visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     long[] value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Visits each array element.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - long array visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     float[] value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Visits each array element.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - float array visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     double[] value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Visits each array element.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - double array visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     boolean[] value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Visits each array element.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - boolean array visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     byte[] value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Visits each array element.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - byte array visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     short[] value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Visits each array element.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - short array visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     char[] value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Visits each array element.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - char array visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     java.lang.String[] value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Visits each array element.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - String array visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     java.lang.Class[] value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Visits each array element.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - Class array visited

param - custom parameter

Returns:

custom result, null by default

visit

public java.lang.Object visit(java.lang.String name,
                     int pos,
                     java.lang.Enum[] value,
                     java.lang.Object param)

Description copied from class: AnnotationVisitor

Visits each array element.

Overrides:

visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>

Parameters:

name - member name, or null if array member

pos - position of member in list or array

value - Enum array visited

param - custom parameter

Returns:

custom result, null by default