org.springframework.data.rest.repository

Interface AttributeMetadata

All Known Implementing Classes:

JpaAttributeMetadata

public interface AttributeMetadata

Encapsulates necessary information about an attribute of a generic entity.

Author:

Jon Brisbin

Method Summary

Methods

Modifier and Type	Method and Description
<A extends java.lang.annotation.Annotation> A	annotation(java.lang.Class<A> annoType) Get the given annotation.
java.util.Collection<?>	asCollection(java.lang.Object target) Get the path of this attribute as a Collection.
java.util.Map	asMap(java.lang.Object target) Get the path of this attribute as a Map.
java.util.Set<?>	asSet(java.lang.Object target) Get the path of this attribute as a Set.
java.lang.Class<?>	elementType() The element type of this attribute, if this attribute is a "plural"-like attribute (a Collection, Map, etc...).
java.lang.Object	get(java.lang.Object target) Get the path of this attribute.
boolean	hasAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annoType) Does this attribute have the given annotation on it?
boolean	isCollectionLike() Can this attribute look like a Collection?
boolean	isMapLike() Can this attribute look like a Map?
boolean	isNullable() Whether this attribute can be nulled or not.
boolean	isSetLike() Can this attribute look like a Set?
java.lang.Class<?>	keyType() The type of this map's key, if it's map-like.
java.lang.String	name() Name of the attribute.
AttributeMetadata	set(java.lang.Object value, java.lang.Object target) Set the path of this attribute.
java.lang.Class<?>	type() The type of this attribute.

Method Detail

name

java.lang.String name()

Name of the attribute.

Returns:

name of the attribute.

type

java.lang.Class<?> type()

The type of this attribute.

Returns:

type of this attribute.

keyType

java.lang.Class<?> keyType()

The type of this map's key, if it's map-like.

Returns:

elementType

java.lang.Class<?> elementType()

The element type of this attribute, if this attribute is a "plural"-like attribute (a Collection, Map, etc...).

Returns:

Class of element type or null if not a plural attribute.

isNullable

boolean isNullable()

Whether this attribute can be nulled or not.

Returns:

isCollectionLike

boolean isCollectionLike()

Can this attribute look like a Collection?

Returns:

true if attribute is a Collection, false otherwise.

asCollection

java.util.Collection<?> asCollection(java.lang.Object target)

Get the path of this attribute as a Collection.

Parameters:

target - The entity to inspect for this attribute.

Returns:

attribute value as a Collection

isSetLike

boolean isSetLike()

Can this attribute look like a Set?

Returns:

true if attribute is a Set, false otherwise.

asSet

java.util.Set<?> asSet(java.lang.Object target)

Get the path of this attribute as a Set.

Parameters:

target - The entity to inspect for this attribute.

Returns:

attribute value as a Set

isMapLike

boolean isMapLike()

Can this attribute look like a Map?

Returns:

true if attribute is a Map, false otherwise.

asMap

java.util.Map asMap(java.lang.Object target)

Get the path of this attribute as a Map.

Parameters:

target - The entity to inspect for this attribute.

Returns:

attribute value as a Map

hasAnnotation

boolean hasAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annoType)

Does this attribute have the given annotation on it?

Parameters:

annoType - The type of annotation to search for.

Returns:

true if this annotation exists on this attribute, false otherwise.

annotation

<A extends java.lang.annotation.Annotation> A annotation(java.lang.Class<A> annoType)

Get the given annotation.

Type Parameters:

A -

Parameters:

annoType - The type of annotation to get.

Returns:

The annotation, or null if it doesn't exist.

get

java.lang.Object get(java.lang.Object target)

Get the path of this attribute.

Parameters:

target - The entity to inspect for this attribute.

Returns:

attribute value

set

AttributeMetadata set(java.lang.Object value,
                    java.lang.Object target)

Set the path of this attribute.

Parameters:

value - Value to set on this attribute.

target - The entity to set this attribute's value on.

Returns:

@this