org.springframework.data.cassandra.repository.support

Class IdInterfaceValidator

java.lang.Object

org.springframework.data.cassandra.repository.support.IdInterfaceValidator

public class IdInterfaceValidator
extends Object

Constructor Summary

Constructors

Constructor and Description
IdInterfaceValidator()

Method Summary

Modifier and Type	Method and Description
static void	validate(Class<?> id) Validates the form of the given id interface candidate type.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdInterfaceValidator

public IdInterfaceValidator()

Method Detail

validate

public static void validate(Class<?> id)

Validates the form of the given id interface candidate type. If the interface violates the following restrictions, then an IdInterfaceExceptions is thrown containing all of the violations encountered, which can be obtained from IdInterfaceExceptions.getExceptions() or, as a convenience, IdInterfaceExceptions.getMessages().

Id interfaces are intended to have methods representing setters and getters. Getter methods take the form

• PropertyType getPropertyName() or
• PropertyType propertyName().

Setter methods take the form

• void|IdType setPropertyName(PropertyType),
• void|IdType withPropertyName(PropertyType), or
• void|IdType propertyName(PropertyType);

setter methods may also declare that they return their id interface type to support method chaining.

Id interfaces

• must be an interface, not a class,
• may extend Serializable,
• may extend MapId,
• must have getter methods that only return a Serializable type,
• must have setter methods that only take a single Serializable type,
• must have setter methods that only return void or the id interface's type,
• must not define any getter methods with the literal name "get", and
• must not define any setter methods with the literal names "set" or "with".

Parameters:

id - The candidate interface type

Throws:

IdInterfaceExceptions

See Also:

IdInterfaceExceptions.getExceptions(), IdInterfaceException}