AnnotationBuilder (Grapht Dependency Injector 0.11.0-BETA2 API)

java.lang.Object
- org.grouplens.grapht.annotation.AnnotationBuilder<T>

Type Parameters:

T - The annotation type created
```
public final class AnnotationBuilder<T extends Annotation>
extends Object
```
AnnotationBuilder is a "builder" for creating proxy Annotation instances. This is useful when configuring dependency injection to match a qualifier annotation that defines attributes, such as the Named qualifier. As an example, AnnotationBuilder can be used to construct a Named instance that matches particular applications of that annotation:
```
 Named proxy = new AnnotationBuilder<Named>(Named.class)
      .set("value", "name")
      .build();
 
```
The above snippet creates an instance of Named that returns the String, "name", from its value() method. All other methods declared by Annotation are implemented correctly given the values configured by the builder, or the defaults declared in the annotation definition.
This lets developers define attribute-based qualifiers easily without being forced to provide an actual annotation implementation that can be used to create instances.
The proxies returned by this builder are immutable and serializable, like those returned by AnnotatedElement.
Author:

GroupLens Research

Constructor Summary

Constructors
Constructor and Description
`AnnotationBuilder(Class<T> annotType)` Create a new AnnotationBuilder without any assigned values, that will create annotations of the given class type.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`T`	`build()` Build an Annotation instance of type T that is configured to return the values assigned by the various set() methods for its defined attributes.
`static <T extends Annotation> AnnotationBuilder<T>`	`of(Class<T> annotType)` Constructor method to allow the builder type to be inferred.
`<A extends Annotation> AnnotationBuilder<T>`	`set(String name, A[] value)` As `set(String, boolean)` but assigns an Annotation array to the value.
`AnnotationBuilder<T>`	`set(String name, Annotation value)` As `set(String, boolean)` but assigns an Annotation instance to the value.
`AnnotationBuilder<T>`	`set(String name, boolean value)` Set the annotation defined member given by `name` to the boolean `value`.
`AnnotationBuilder<T>`	`set(String name, boolean[] value)` As `set(String, boolean)` but assigns a boolean[] value.
`AnnotationBuilder<T>`	`set(String name, byte value)` As `set(String, boolean)` but assigns a byte value.
`AnnotationBuilder<T>`	`set(String name, byte[] value)` As `set(String, boolean)` but assigns a byte[] value.
`AnnotationBuilder<T>`	`set(String name, char value)` As `set(String, boolean)` but assigns a char value.
`AnnotationBuilder<T>`	`set(String name, char[] value)` As `set(String, boolean)` but assigns a char[] value.
`AnnotationBuilder<T>`	`set(String name, Class<? extends Class> value)` As `set(String, Class)` but 'assigns an class value' .A NullPointerException is thrown if value is null.
`AnnotationBuilder<T>`	`set(String name, double value)` As `set(String, boolean)` but assigns a double value.
`AnnotationBuilder<T>`	`set(String name, double[] value)` As `set(String, boolean)` but assigns a double[] value.
`AnnotationBuilder<T>`	`set(String name, Enum<? extends Enum> value)` As `set(String, boolean)` but 'assigns an enum value' .A NullPointerException is thrown if value is null.
`AnnotationBuilder<T>`	`set(String name, float value)` As `set(String, boolean)` but assigns a float value.
`AnnotationBuilder<T>`	`set(String name, float[] value)` As `set(String, boolean)` but assigns a float[] value.
`AnnotationBuilder<T>`	`set(String name, int value)` As `set(String, boolean)` but assigns an int value.
`AnnotationBuilder<T>`	`set(String name, int[] value)` As `set(String, boolean)` but assigns a int[] value.
`AnnotationBuilder<T>`	`set(String name, long value)` As `set(String, boolean)` but assigns a long value.
`AnnotationBuilder<T>`	`set(String name, long[] value)` As `set(String, boolean)` but assigns a long[] value.
`AnnotationBuilder<T>`	`set(String name, short value)` As `set(String, boolean)` but assigns a short value.
`AnnotationBuilder<T>`	`set(String name, short[] value)` As `set(String, boolean)` but assigns a short[] value.
`AnnotationBuilder<T>`	`set(String name, String value)` As `set(String, boolean)` but assigns a String value.
`AnnotationBuilder<T>`	`set(String name, String[] value)` As `set(String, boolean)` but assigns a String[] value.
`<A extends Annotation> AnnotationBuilder<T>`	`setValue(A value)` Set the 'value' attribute to the given annotation.
`<A extends Annotation> AnnotationBuilder<T>`	`setValue(A[] value)` Set the 'value' attribute to the given annotation array.
`AnnotationBuilder<T>`	`setValue(boolean value)` Set the 'value' attribute to the given boolean value.
`AnnotationBuilder<T>`	`setValue(boolean[] value)` Set the 'value' attribute to the given boolean array.
`AnnotationBuilder<T>`	`setValue(byte value)` Set the 'value' attribute to the given byte value.
`AnnotationBuilder<T>`	`setValue(byte[] value)` Set the 'value' attribute to the given byte array.
`AnnotationBuilder<T>`	`setValue(char value)` Set the 'value' attribute to the given char value.
`AnnotationBuilder<T>`	`setValue(char[] value)` Set the 'value' attribute to the given char array.
`AnnotationBuilder<T>`	`setValue(Class<? extends Class> value)` Set the 'value' attribute to the given class
`AnnotationBuilder<T>`	`setValue(double value)` Set the 'value' attribute to the given double value.
`AnnotationBuilder<T>`	`setValue(double[] value)` Set the 'value' attribute to the given double array.
`AnnotationBuilder<T>`	`setValue(Enum<? extends Enum> value)` Set the 'value' attribute to the given enum.
`AnnotationBuilder<T>`	`setValue(float value)` Set the 'value' attribute to the given float value.
`AnnotationBuilder<T>`	`setValue(float[] value)` Set the 'value' attribute to the given float array.
`AnnotationBuilder<T>`	`setValue(int value)` Set the 'value' attribute to the given int value.
`AnnotationBuilder<T>`	`setValue(int[] value)` Set the 'value' attribute to the given int array.
`AnnotationBuilder<T>`	`setValue(long value)` Set the 'value' attribute to the given long value.
`AnnotationBuilder<T>`	`setValue(long[] value)` Set the 'value' attribute to the given long array.
`AnnotationBuilder<T>`	`setValue(short value)` Set the 'value' attribute to the given short value.
`AnnotationBuilder<T>`	`setValue(short[] value)` Set the 'value' attribute to the given short array.
`AnnotationBuilder<T>`	`setValue(String value)` Set the 'value' attribute to the given String value.
`AnnotationBuilder<T>`	`setValue(String[] value)` Set the 'value' attribute to the given String array.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AnnotationBuilder
```
public AnnotationBuilder(Class<T> annotType)
```
    Create a new AnnotationBuilder without any assigned values, that will create annotations of the given class type.
    
    Parameters:
    
    annotType - The annotation class type
    
    Throws:
    
    NullPointerException - if annotType is null
    
    IllegalArgumentException - if annotType is not an Annotation class
- Method Detail
  - of
```
public static <T extends Annotation> AnnotationBuilder<T> of(Class<T> annotType)
```
    Constructor method to allow the builder type to be inferred.
    
    Type Parameters:
    
    T - The type of annotation to build (type parameter).
    
    Parameters:
    
    annotType - The annotation type to build.
    
    Returns:
    
    An annotation builder to create an implementation of the annotation.
  - set
```
public AnnotationBuilder<T> set(String name,
                                boolean value)
```
    Set the annotation defined member given by name to the boolean value.
    
    Parameters:
    
    name - The name of the annotation attribute or member to assign
    
    value - The value to assign to the specified member
    
    Returns:
    
    This builder
    
    Throws:
    
    NullPointerException - if name is null
    
    IllegalArgumentException - if name is not a defined member in the annotation type for this builder, or if the type is not boolean
  - set
```
public AnnotationBuilder<T> set(String name,
                                byte value)
```
    As set(String, boolean) but assigns a byte value.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    This builder
  - set
```
public AnnotationBuilder<T> set(String name,
                                short value)
```
    As set(String, boolean) but assigns a short value.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    This builder
  - set
```
public AnnotationBuilder<T> set(String name,
                                int value)
```
    As set(String, boolean) but assigns an int value.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    This builder
  - set
```
public AnnotationBuilder<T> set(String name,
                                long value)
```
    As set(String, boolean) but assigns a long value.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    This builder
  - set
```
public AnnotationBuilder<T> set(String name,
                                char value)
```
    As set(String, boolean) but assigns a char value.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    This builder
  - set
```
public AnnotationBuilder<T> set(String name,
                                float value)
```
    As set(String, boolean) but assigns a float value.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    This builder
  - set
```
public AnnotationBuilder<T> set(String name,
                                double value)
```
    As set(String, boolean) but assigns a double value.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    This builder
  - set
```
public AnnotationBuilder<T> set(String name,
                                String value)
```
    As set(String, boolean) but assigns a String value. Throws a NullPointerException if value is null.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    This builder
  - set
```
public AnnotationBuilder<T> set(String name,
                                Annotation value)
```
    As set(String, boolean) but assigns an Annotation instance to the value. A NullPointerException is thrown if value is null.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    This builder
  - set
```
public AnnotationBuilder<T> set(String name,
                                boolean[] value)
```
    As set(String, boolean) but assigns a boolean[] value. A NullPointerException is thrown if the array is null.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    This builder
  - set
```
public AnnotationBuilder<T> set(String name,
                                byte[] value)
```
    As set(String, boolean) but assigns a byte[] value. A NullPointerException is thrown if the array is null.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    This builder
  - set
```
public AnnotationBuilder<T> set(String name,
                                short[] value)
```
    As set(String, boolean) but assigns a short[] value. A NullPointerException is thrown if the array is null.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    This builder
  - set
```
public AnnotationBuilder<T> set(String name,
                                int[] value)
```
    As set(String, boolean) but assigns a int[] value. A NullPointerException is thrown if the array is null.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    This builder
  - set
```
public AnnotationBuilder<T> set(String name,
                                long[] value)
```
    As set(String, boolean) but assigns a long[] value. A NullPointerException is thrown if the array is null.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    This builder
  - set
```
public AnnotationBuilder<T> set(String name,
                                char[] value)
```
    As set(String, boolean) but assigns a char[] value. A NullPointerException is thrown if the array is null.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    This builder
  - set
```
public AnnotationBuilder<T> set(String name,
                                float[] value)
```
    As set(String, boolean) but assigns a float[] value. A NullPointerException is thrown if the array is null.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    This builder
  - set
```
public AnnotationBuilder<T> set(String name,
                                double[] value)
```
    As set(String, boolean) but assigns a double[] value. A NullPointerException is thrown if the array is null.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    This builder
  - set
```
public AnnotationBuilder<T> set(String name,
                                String[] value)
```
    As set(String, boolean) but assigns a String[] value. A NullPointerException is thrown if the array is null.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    This builder
  - set
```
public <A extends Annotation> AnnotationBuilder<T> set(String name,
                                                       A[] value)
```
    As set(String, boolean) but assigns an Annotation array to the value. The array must be a proper array over the parameterized type, and not a cast of Object[], etc. A NullPointerException is thrown if the array is null.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    This builder
  - set
```
public AnnotationBuilder<T> set(String name,
                                Enum<? extends Enum> value)
```
    As set(String, boolean) but 'assigns an enum value' .A NullPointerException is thrown if value is null.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    This builder
  - set
```
public AnnotationBuilder<T> set(String name,
                                Class<? extends Class> value)
```
    As set(String, Class) but 'assigns an class value' .A NullPointerException is thrown if value is null.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    This builder
  - setValue
```
public AnnotationBuilder<T> setValue(boolean value)
```
    Set the 'value' attribute to the given boolean value.
    
    Parameters:
    
    value - The boolean value
    
    Returns:
    
    This builder
  - setValue
```
public AnnotationBuilder<T> setValue(byte value)
```
    Set the 'value' attribute to the given byte value.
    
    Parameters:
    
    value - The byte value
    
    Returns:
    
    This builder
  - setValue
```
public AnnotationBuilder<T> setValue(short value)
```
    Set the 'value' attribute to the given short value.
    
    Parameters:
    
    value - The short value
    
    Returns:
    
    This builder
  - setValue
```
public AnnotationBuilder<T> setValue(int value)
```
    Set the 'value' attribute to the given int value.
    
    Parameters:
    
    value - The int value
    
    Returns:
    
    This builder
  - setValue
```
public AnnotationBuilder<T> setValue(long value)
```
    Set the 'value' attribute to the given long value.
    
    Parameters:
    
    value - The long value
    
    Returns:
    
    This builder
  - setValue
```
public AnnotationBuilder<T> setValue(double value)
```
    Set the 'value' attribute to the given double value.
    
    Parameters:
    
    value - The double value
    
    Returns:
    
    This builder
  - setValue
```
public AnnotationBuilder<T> setValue(float value)
```
    Set the 'value' attribute to the given float value.
    
    Parameters:
    
    value - The float value
    
    Returns:
    
    This builder
  - setValue
```
public AnnotationBuilder<T> setValue(char value)
```
    Set the 'value' attribute to the given char value.
    
    Parameters:
    
    value - The char value
    
    Returns:
    
    This builder
  - setValue
```
public AnnotationBuilder<T> setValue(String value)
```
    Set the 'value' attribute to the given String value.
    
    Parameters:
    
    value - The String value
    
    Returns:
    
    This builder
  - setValue
```
public <A extends Annotation> AnnotationBuilder<T> setValue(A value)
```
    Set the 'value' attribute to the given annotation.
    
    Parameters:
    
    value - The annotation value
    
    Returns:
    
    This builder
  - setValue
```
public AnnotationBuilder<T> setValue(boolean[] value)
```
    Set the 'value' attribute to the given boolean array.
    
    Parameters:
    
    value - The boolean array
    
    Returns:
    
    This builder
  - setValue
```
public AnnotationBuilder<T> setValue(byte[] value)
```
    Set the 'value' attribute to the given byte array.
    
    Parameters:
    
    value - The byte array
    
    Returns:
    
    This builder
  - setValue
```
public AnnotationBuilder<T> setValue(short[] value)
```
    Set the 'value' attribute to the given short array.
    
    Parameters:
    
    value - The short array
    
    Returns:
    
    This builder
  - setValue
```
public AnnotationBuilder<T> setValue(int[] value)
```
    Set the 'value' attribute to the given int array.
    
    Parameters:
    
    value - The int array
    
    Returns:
    
    This builder
  - setValue
```
public AnnotationBuilder<T> setValue(long[] value)
```
    Set the 'value' attribute to the given long array.
    
    Parameters:
    
    value - The long array
    
    Returns:
    
    This builder
  - setValue
```
public AnnotationBuilder<T> setValue(double[] value)
```
    Set the 'value' attribute to the given double array.
    
    Parameters:
    
    value - The double array
    
    Returns:
    
    This builder
  - setValue
```
public AnnotationBuilder<T> setValue(float[] value)
```
    Set the 'value' attribute to the given float array.
    
    Parameters:
    
    value - The float array
    
    Returns:
    
    This builder
  - setValue
```
public AnnotationBuilder<T> setValue(char[] value)
```
    Set the 'value' attribute to the given char array.
    
    Parameters:
    
    value - The char array
    
    Returns:
    
    This builder
  - setValue
```
public AnnotationBuilder<T> setValue(String[] value)
```
    Set the 'value' attribute to the given String array.
    
    Parameters:
    
    value - The String array
    
    Returns:
    
    This builder
  - setValue
```
public <A extends Annotation> AnnotationBuilder<T> setValue(A[] value)
```
    Set the 'value' attribute to the given annotation array.
    
    Parameters:
    
    value - The annotation array
    
    Returns:
    
    This builder
  - setValue
```
public AnnotationBuilder<T> setValue(Enum<? extends Enum> value)
```
    Set the 'value' attribute to the given enum.
    
    Parameters:
    
    value - The enum type annotation
    
    Returns:
    
    This builder
  - setValue
```
public AnnotationBuilder<T> setValue(Class<? extends Class> value)
```
    Set the 'value' attribute to the given class
    
    Parameters:
    
    value - The class type annotation
    
    Returns:
    
    This builder
  - build
```
public T build()
```
    Build an Annotation instance of type T that is configured to return the values assigned by the various set() methods for its defined attributes. If attributes have a default value and the value was not overridden by the builder's configuration, then the default will be returned by the annotation instance.
    
    Returns:
    
    An instance of T with the attribute values specified on this builder
    
    Throws:
    
    IllegalStateException - if there are attributes with no default that have not been assigned explicit values

Class AnnotationBuilder<T extends Annotation>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AnnotationBuilder

Method Detail

of

set

set

set

set

set

set

set

set

set

set

set

set

set

set

set

set

set

set

set

set

set

set

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

build