PotentialAnnotation (Sangria 1.3.1 API)

java.lang.Object
+
- com.tavianator.sangria.core.PotentialAnnotation
+

+
+
+
```
public abstract class PotentialAnnotation
+extends Object
```
+
A record of stored annotations, perfect for builders with annotatedWith() methods.
+
+
Since:
+
1.1
+
Version:
+
1.2
+
Author:
+
Tavian Barnes (tavianator@tavianator.com)
+
+

+ +

+ + +
Nested Class Summary
+ + + + + + + + + + +
Nested Classes
Modifier and Type Class and Description
static interface PotentialAnnotation.Visitor<T> +
A visitor interface to examine a PotentialAnnotation's annotation, if it exists.
+
+

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PotentialAnnotation.Visitor<T>` + A visitor interface to examine a `PotentialAnnotation`'s annotation, if it exists. +

+ +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract <T> T`	`accept(PotentialAnnotation.Visitor<T> visitor)` + Accept a `PotentialAnnotation.Visitor`. +
`PotentialAnnotation`	`annotatedWith(Annotation annotation)` + Add an annotation. +
`PotentialAnnotation`	`annotatedWith(Class<? extends Annotation> annotationType)` + Add an annotation. +
`abstract boolean`	`equals(Object o)`
`static PotentialAnnotation`	`from(Key<?> key)` + Extract the annotation from a `Key`. +
`<T> Key<T>`	`getKey(Class<T> type)` + Create a `Key` with the given type and the stored annotation. +
`abstract <T> Key<T>`	`getKey(TypeLiteral<T> type)` + Create a `Key` with the given type and the stored annotation. +
`abstract boolean`	`hasAnnotation()`
`abstract int`	`hashCode()`
`static PotentialAnnotation`	`none()`
`abstract String`	`toString()`

+ + +
Methods inherited from class java.lang.Object
+clone, finalize, getClass, notify, notifyAll, wait, wait, wait

+ +
- + + +
  Method Detail
  + + + +
  - +
    none
    +
```
public static PotentialAnnotation none()
```
    +
    +
    Returns:
    +
    A PotentialAnnotation with no annotation.
    +
    +
  + + + +
  - +
    from
    +
```
public static PotentialAnnotation from(Key<?> key)
```
    +
    Extract the annotation from a Key.
    +
    +
    Parameters:
    +
    key - The Key whose annotation to use, if any.
    +
    Returns:
    +
    A PotentialAnnotation with the annotation from key.
    +
    Since:
    +
    1.2
    +
    +
  + + + +
  - +
    annotatedWith
    +
```
public PotentialAnnotation annotatedWith(Class<? extends Annotation> annotationType)
```
    +
    Add an annotation.
    +
    +
    Parameters:
    +
    annotationType - The annotation type to add.
    +
    Returns:
    +
    A new PotentialAnnotation associated with the given annotation type.
    +
    Throws:
    +
    CreationException - If an annotation is already present.
    +
    +
  + + + +
  - +
    annotatedWith
    +
```
public PotentialAnnotation annotatedWith(Annotation annotation)
```
    +
    Add an annotation.
    +
    +
    Parameters:
    +
    annotation - The annotation instance to add.
    +
    Returns:
    +
    A new PotentialAnnotation associated with the given annotation instance.
    +
    Throws:
    +
    CreationException - If an annotation is already present.
    +
    +
  + + + +
  - +
    hasAnnotation
    +
```
public abstract boolean hasAnnotation()
```
    +
    +
    Returns:
    +
    Whether an annotation is present.
    +
    +
  + + + +
  - +
    getKey
    +
```
public <T> Key<T> getKey(Class<T> type)
```
    +
    Create a Key with the given type and the stored annotation.
    +
    +
    Type Parameters:
    +
    T - The type of the key to create.
    +
    Parameters:
    +
    type - The type of the key to create.
    +
    Returns:
    +
    A Key.
    +
    +
  + + + +
  - +
    getKey
    +
```
public abstract <T> Key<T> getKey(TypeLiteral<T> type)
```
    +
    Create a Key with the given type and the stored annotation.
    +
    +
    Type Parameters:
    +
    T - The type of the key to create.
    +
    Parameters:
    +
    type - The type of the key to create.
    +
    Returns:
    +
    A Key.
    +
    +
  + + + +
  - +
    accept
    +
```
public abstract <T> T accept(PotentialAnnotation.Visitor<T> visitor)
```
    +
    Accept a PotentialAnnotation.Visitor.
    +
    +
    Type Parameters:
    +
    T - The type for the visitor to return.
    +
    Parameters:
    +
    visitor - The visitor to accept.
    +
    Returns:
    +
    The value produced by the visitor.
    +
    +
  + + + +
  - +
    equals
    +
```
public abstract boolean equals(Object o)
```
    +
    +
    Overrides:
    +
    equals in class Object
    +
    +
  + + + +
  - +
    hashCode
    +
```
public abstract int hashCode()
```
    +
    +
    Overrides:
    +
    hashCode in class Object
    +
    +
  + + + +
  - +
    toString
    +
```
public abstract String toString()
```
    +
    +
    Overrides:
    +
    toString in class Object
    +
    +
  +
+

Class PotentialAnnotation

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

none

from

annotatedWith

annotatedWith

hasAnnotation

getKey

getKey

accept

equals

hashCode

toString