com.basho.riak.client.api.convert.reflection

Class AnnotationUtil

java.lang.Object

com.basho.riak.client.api.convert.reflection.AnnotationUtil

public class AnnotationUtil
extends Object

Static utility methods used to get/set annotated fields/methods.

Since:

2.0

Author:

Brian Roach

Method Summary

Modifier and Type	Method and Description
static <T> BinaryValue	getBucketName(T domainObject)
static <T> BinaryValue	getBucketName(T domainObject, BinaryValue defaultBucketName)
static <T> BinaryValue	getBucketType(T domainObject)
static <T> BinaryValue	getBucketType(T domainObject, BinaryValue defaultBucketType)
static <T> String	getContentType(T domainObject)
static <T> String	getContentType(T domainObject, String defaultContentType)
static <T> RiakIndexes	getIndexes(RiakIndexes container, T domainObject) Attempts to get all the riak indexes from a domain object by looking for a @RiakIndexes annotated member.
static <T> BinaryValue	getKey(T domainObject) Attempts to get a key from domainObject by looking for a @RiakKey annotated member.
static <T> BinaryValue	getKey(T domainObject, BinaryValue defaultKey) Attempts to get a key from domainObject by looking for a @RiakKey annotated member.
static <T> RiakLinks	getLinks(RiakLinks container, T domainObject) Attempts to get the the Riak links from a domain object by looking for a @RiakLinks annotated member.
static <T> Boolean	getTombstone(T domainObject) Attempts to get boolean from domainObject by looking for a @RiakTombstone annotated member.
static <T> RiakUserMetadata	getUsermetaData(RiakUserMetadata metaContainer, T domainObject) Attempts to get the riak user metadata from a domain object by looking for a @RiakUsermeta annotated field or getter method.
static <T> VClock	getVClock(T domainObject) Attempts to get a vector clock from domainObject by looking for a @RiakVClock annotated member.
static <T> VClock	getVClock(T domainObject, VClock defaultVClock)
static <T> boolean	hasVClockAnnotation(T domainObject)
static <T> T	populateIndexes(RiakIndexes indexes, T domainObject) Attempts to populate a domain object with the contents of the supplied RiakIndexes by looking for a @RiakIndex annotated member
static <T> T	populateLinks(RiakLinks links, T domainObject) Attempts to populate a domain object with riak links by looking for a @RiakLinks annotated member.
static <T> T	populateUsermeta(RiakUserMetadata usermetaData, T domainObject) Attempts to populate a domain object with user metadata by looking for a @RiakUsermeta annotated member.
static <T> T	setBucketName(T domainObject, BinaryValue bucketName)
static <T> T	setBucketType(T domainObject, BinaryValue bucketType)
static <T> T	setContentType(T domainObject, String contentType)
static <T> T	setKey(T domainObject, BinaryValue key) Attempts to inject key as the value of the @RiakKey annotated member of domainObject
static <T> T	setLastModified(T domainObject, Long lastModified)
static <T> T	setTombstone(T domainObject, boolean isTombstone) Attempts to inject isTombstone as the value of the @RiakTombstone annotated member of domainObject
static <T> T	setVClock(T domainObject, VClock vclock) Attempts to inject vclock as the value of the @RiakVClock annotated member of domainObject
static <T> T	setVTag(T domainObject, String vtag)

Methods inherited from class java.lang.Object

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

Method Detail

setKey

public static <T> T setKey(T domainObject,
                           BinaryValue key)
                    throws ConversionException

Attempts to inject key as the value of the @RiakKey annotated member of domainObject

Type Parameters:

T - the type of domainObject

Parameters:

domainObject - the object to inject the key into

key - the key to inject

Returns:

domainObject with @RiakKey annotated member set to key

Throws:

ConversionException - if there is a @RiakKey annotated member but it cannot be set to the value of key

getKey

public static <T> BinaryValue getKey(T domainObject,
                                     BinaryValue defaultKey)

Attempts to get a key from domainObject by looking for a @RiakKey annotated member. If non-present it simply returns defaultKey

Type Parameters:

T - the type of domainObject

Parameters:

domainObject - the object to search for a key

defaultKey - the pass through value that will get returned if no key found on domainObject

Returns:

either the value found on domainObject;s @RiakKey member or defaultkey

getKey

public static <T> BinaryValue getKey(T domainObject)

Attempts to get a key from domainObject by looking for a @RiakKey annotated member. If non-present it simply returns null

Type Parameters:

T - the type of domainObject

Parameters:

domainObject - the object to search for a key

Returns:

either the value found on domainObject;s @RiakKey member or null

setBucketName

public static <T> T setBucketName(T domainObject,
                                  BinaryValue bucketName)

getBucketName

public static <T> BinaryValue getBucketName(T domainObject,
                                            BinaryValue defaultBucketName)

getBucketName

public static <T> BinaryValue getBucketName(T domainObject)

setBucketType

public static <T> T setBucketType(T domainObject,
                                  BinaryValue bucketType)

getBucketType

public static <T> BinaryValue getBucketType(T domainObject,
                                            BinaryValue defaultBucketType)

getBucketType

public static <T> BinaryValue getBucketType(T domainObject)

hasVClockAnnotation

public static <T> boolean hasVClockAnnotation(T domainObject)

setVClock

public static <T> T setVClock(T domainObject,
                              VClock vclock)
                       throws ConversionException

Attempts to inject vclock as the value of the @RiakVClock annotated member of domainObject

Type Parameters:

T - the type of domainObject

Parameters:

domainObject - the object to inject the key into

vclock - the vclock to inject

Returns:

domainObject with @RiakVClock annotated member set to vclock

Throws:

ConversionException - if there is a @RiakVClock annotated member but it cannot be set to the value of vclock

getVClock

public static <T> VClock getVClock(T domainObject,
                                   VClock defaultVClock)

getVClock

public static <T> VClock getVClock(T domainObject)

Attempts to get a vector clock from domainObject by looking for a @RiakVClock annotated member. If non-present it simply returns null

Type Parameters:

T - the type of domainObject

Parameters:

domainObject - the object to search for a key

Returns:

either the value found on domainObject;s @RiakVClock member or null

setTombstone

public static <T> T setTombstone(T domainObject,
                                 boolean isTombstone)
                          throws ConversionException

Attempts to inject isTombstone as the value of the @RiakTombstone annotated member of domainObject

Type Parameters:

T - the type of domainObject

Parameters:

domainObject - the object to inject the key into

isTombstone - the boolean to inject

Returns:

domainObject with @RiakTombstone annotated member set to isTombstone

Throws:

ConversionException - if there is a @RiakTombstone annotated member but it cannot be set to the value of isTombstone

getTombstone

public static <T> Boolean getTombstone(T domainObject)

Attempts to get boolean from domainObject by looking for a @RiakTombstone annotated member. If non-present it simply returns null

Type Parameters:

T - the type of domainObject

Parameters:

domainObject - the object to search for a key

Returns:

either the value found on domainObject's @RiakTombstone member or null

getIndexes

public static <T> RiakIndexes getIndexes(RiakIndexes container,
                                         T domainObject)

Attempts to get all the riak indexes from a domain object by looking for a @RiakIndexes annotated member.

If no indexes are present, an empty RiakIndexes is returned.

Type Parameters:

T - the type of the domain object

Parameters:

domainObject - the domain object

Returns:

a RiakIndexes

populateIndexes

public static <T> T populateIndexes(RiakIndexes indexes,
                                    T domainObject)

Attempts to populate a domain object with the contents of the supplied RiakIndexes by looking for a @RiakIndex annotated member

Type Parameters:

T - the type of the domain object

Parameters:

indexes - a populated RiakIndexes object.

domainObject - the domain object

Returns:

the domain object.

getLinks

public static <T> RiakLinks getLinks(RiakLinks container,
                                     T domainObject)

Attempts to get the the Riak links from a domain object by looking for a @RiakLinks annotated member.

Type Parameters:

T - the domain object type

Parameters:

container - the RiakLinks container

domainObject - the domain object

Returns:

a Collection of RiakLink objects.

populateLinks

public static <T> T populateLinks(RiakLinks links,
                                  T domainObject)

Attempts to populate a domain object with riak links by looking for a @RiakLinks annotated member.

Type Parameters:

T - the type of the domain object

Parameters:

links - a collection of RiakLink objects

domainObject - the domain object

Returns:

the domain object

getUsermetaData

public static <T> RiakUserMetadata getUsermetaData(RiakUserMetadata metaContainer,
                                                   T domainObject)

Attempts to get the riak user metadata from a domain object by looking for a @RiakUsermeta annotated field or getter method.

Type Parameters:

T - the type of the domain object

Parameters:

metaContainer - the RiakUserMetadata container

domainObject - the domain object

Returns:

a Map containing the user metadata.

populateUsermeta

public static <T> T populateUsermeta(RiakUserMetadata usermetaData,
                                     T domainObject)

Attempts to populate a domain object with user metadata by looking for a @RiakUsermeta annotated member.

Type Parameters:

T - the type of the domain object

Parameters:

usermetaData - a Map of user metadata.

domainObject - the domain object.

Returns:

the domain object.

getContentType

public static <T> String getContentType(T domainObject,
                                        String defaultContentType)

getContentType

public static <T> String getContentType(T domainObject)

setContentType

public static <T> T setContentType(T domainObject,
                                   String contentType)

setVTag

public static <T> T setVTag(T domainObject,
                            String vtag)

setLastModified

public static <T> T setLastModified(T domainObject,
                                    Long lastModified)