oracle.dbtools.plugin.api.di

Interface Annotations

All Known Implementing Classes:

AnnotationsProvider

public interface Annotations

Provides methods for working with annotations.

Author:

cdivilly

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Annotations.Builder<T extends Annotation> Builds new Annotation instances

Field Summary

Fields

Modifier and Type	Field and Description
static Annotations	INSTANCE Global Annotations Service instance, for use by code that runs outside of the dependency injection runtime

Method Summary

Modifier and Type	Method and Description
<T extends Annotation> Annotations.Builder<T>	create(Class<T> type) Create an Annotation literal Annotations.Builder.
boolean	equals(Annotation[] expected, Annotation[] actual) Determines if one array of annotations is exactly equivalent to another
<T extends Annotation> T	literal(Class<T> type) Create an Annotation literal value that has no properties.
<T extends Annotation> T	literal(Class<T> type, Object value) Create an Annotation literal value for the specified Annotation type, using the specified #value() property.
boolean	matches(Annotation[] expected, Annotation[] actual) Determines if one array of annotations is a subset of another
<T extends Annotation> Annotations.Builder<T>	modify(T annotation) Create an Annotation literal Annotations.Builder initialized with the values of an existing annotation.

Field Detail

INSTANCE

static final Annotations INSTANCE

Global Annotations Service instance, for use by code that runs outside of the dependency injection runtime

Method Detail

create

<T extends Annotation> Annotations.Builder<T> create(Class<T> type)

Create an Annotation literal Annotations.Builder.

Type Parameters:

T - An instance of an Annotation sub-type

Parameters:

type - The type of annotation to build

Returns:

a Annotations.Builder instance.

See Also:

Annotations.Builder

equals

boolean equals(Annotation[] expected,
               Annotation[] actual)

Determines if one array of annotations is exactly equivalent to another

Parameters:

expected - The annotations that must be present

actual - The annotations that are present

Returns:

true if the actual set of annotations is identical to the expected set of annotations

literal

<T extends Annotation> T literal(Class<T> type)

Create an Annotation literal value that has no properties.

Type Parameters:

T - An instance of an Annotation sub-type

Parameters:

type - The type of annotation to instantiate

Returns:

Annotation instance

literal

<T extends Annotation> T literal(Class<T> type,
                                 Object value)

Create an Annotation literal value for the specified Annotation type, using the specified #value() property.

Type Parameters:

T - An instance of an Annotation sub-type

Parameters:

type - The type of annotation to instantiate

value - The value to assign to the #value() property

Returns:

Annotation instance

matches

boolean matches(Annotation[] expected,
                Annotation[] actual)

Determines if one array of annotations is a subset of another

Parameters:

expected - The annotations that must be present

actual - The annotations that are present

Returns:

true if the actual set of annotations contains every annotation in the expected set, false otherwise

modify

<T extends Annotation> Annotations.Builder<T> modify(T annotation)

Create an Annotation literal Annotations.Builder initialized with the values of an existing annotation.

Type Parameters:

T - An instance of an Annotation sub-type

Parameters:

annotation - The existing annotation instance

Returns:

Annotations.Builder instance