com.amazon.carbonado.info

Class StorablePropertyAnnotation

java.lang.Object

com.amazon.carbonado.info.StorablePropertyAnnotation

public class StorablePropertyAnnotation
extends java.lang.Object

Information about a custom annotation applied to a property.

Author:

Brian S O'Neill

Constructor Summary

Constructors

Constructor and Description
StorablePropertyAnnotation(java.lang.annotation.Annotation annotation, java.lang.reflect.Method method) Use this constructor if an annotation was actually defined.
StorablePropertyAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType, java.lang.reflect.Method method) Use this constructor if an annotation was not defined, but instead is being automatically applied.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.reflect.Method	getAnnotatedMethod() Returns the method that has the annotation.
java.lang.annotation.Annotation	getAnnotation() Returns the actual annotation instance, which may be null if annotation was automatically applied.
java.lang.Class<? extends java.lang.annotation.Annotation>	getAnnotationType() Returns the type of annotation that was applied to the property method.

Methods inherited from class java.lang.Object

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

Constructor Detail

StorablePropertyAnnotation

public StorablePropertyAnnotation(java.lang.annotation.Annotation annotation,
                          java.lang.reflect.Method method)

Use this constructor if an annotation was actually defined.

Parameters:

annotation - annotation on method

method - method with annotation

StorablePropertyAnnotation

public StorablePropertyAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType,
                          java.lang.reflect.Method method)

Use this constructor if an annotation was not defined, but instead is being automatically applied.

Parameters:

annotationType - annotation type on method

method - method with annotation

Method Detail

getAnnotation

public java.lang.annotation.Annotation getAnnotation()

Returns the actual annotation instance, which may be null if annotation was automatically applied.

getAnnotationType

public java.lang.Class<? extends java.lang.annotation.Annotation> getAnnotationType()

Returns the type of annotation that was applied to the property method.

getAnnotatedMethod

public java.lang.reflect.Method getAnnotatedMethod()

Returns the method that has the annotation.