org.springframework.data.rest.repository.jpa

Class JpaAttributeMetadata

java.lang.Object

org.springframework.data.rest.repository.jpa.JpaAttributeMetadata

All Implemented Interfaces:

AttributeMetadata

public class JpaAttributeMetadata
extends java.lang.Object
implements AttributeMetadata

Implementation of AttributeMetadata for JPA.

Author:

Jon Brisbin

Constructor Summary

Constructors

Constructor and Description
JpaAttributeMetadata(javax.persistence.metamodel.EntityType<?> entityType, javax.persistence.metamodel.Attribute attribute)

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.String	toString()
java.lang.Class<?>	type() The type of this attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

JpaAttributeMetadata

public JpaAttributeMetadata(javax.persistence.metamodel.EntityType<?> entityType,
                    javax.persistence.metamodel.Attribute attribute)

Method Detail

name

public java.lang.String name()

Description copied from interface: AttributeMetadata

Name of the attribute.

Specified by:

name in interface AttributeMetadata

Returns:

name of the attribute.

type

public java.lang.Class<?> type()

Description copied from interface: AttributeMetadata

The type of this attribute.

Specified by:

type in interface AttributeMetadata

Returns:

type of this attribute.

keyType

public java.lang.Class<?> keyType()

Description copied from interface: AttributeMetadata

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

Specified by:

keyType in interface AttributeMetadata

Returns:

elementType

public java.lang.Class<?> elementType()

Description copied from interface: AttributeMetadata

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

Specified by:

elementType in interface AttributeMetadata

Returns:

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

isNullable

public boolean isNullable()

Description copied from interface: AttributeMetadata

Whether this attribute can be nulled or not.

Specified by:

isNullable in interface AttributeMetadata

Returns:

isCollectionLike

public boolean isCollectionLike()

Description copied from interface: AttributeMetadata

Can this attribute look like a Collection?

Specified by:

isCollectionLike in interface AttributeMetadata

Returns:

true if attribute is a Collection, false otherwise.

asCollection

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

Description copied from interface: AttributeMetadata

Get the path of this attribute as a Collection.

Specified by:

asCollection in interface AttributeMetadata

Parameters:

target - The entity to inspect for this attribute.

Returns:

attribute value as a Collection

isSetLike

public boolean isSetLike()

Description copied from interface: AttributeMetadata

Can this attribute look like a Set?

Specified by:

isSetLike in interface AttributeMetadata

Returns:

true if attribute is a Set, false otherwise.

asSet

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

Description copied from interface: AttributeMetadata

Get the path of this attribute as a Set.

Specified by:

asSet in interface AttributeMetadata

Parameters:

target - The entity to inspect for this attribute.

Returns:

attribute value as a Set

isMapLike

public boolean isMapLike()

Description copied from interface: AttributeMetadata

Can this attribute look like a Map?

Specified by:

isMapLike in interface AttributeMetadata

Returns:

true if attribute is a Map, false otherwise.

asMap

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

Description copied from interface: AttributeMetadata

Get the path of this attribute as a Map.

Specified by:

asMap in interface AttributeMetadata

Parameters:

target - The entity to inspect for this attribute.

Returns:

attribute value as a Map

hasAnnotation

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

Description copied from interface: AttributeMetadata

Does this attribute have the given annotation on it?

Specified by:

hasAnnotation in interface AttributeMetadata

Parameters:

annoType - The type of annotation to search for.

Returns:

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

annotation

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

Description copied from interface: AttributeMetadata

Get the given annotation.

Specified by:

annotation in interface AttributeMetadata

Parameters:

annoType - The type of annotation to get.

Returns:

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

get

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

Description copied from interface: AttributeMetadata

Get the path of this attribute.

Specified by:

get in interface AttributeMetadata

Parameters:

target - The entity to inspect for this attribute.

Returns:

attribute value

set

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

Description copied from interface: AttributeMetadata

Set the path of this attribute.

Specified by:

set in interface AttributeMetadata

Parameters:

value - Value to set on this attribute.

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

Returns:

@this

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object