org.springframework.restdocs.constraints

Class ConstraintDescriptions

java.lang.Object

org.springframework.restdocs.constraints.ConstraintDescriptions

public class ConstraintDescriptions
extends Object

Provides access to descriptions of a class's constraints.

Author:

Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
ConstraintDescriptions(Class<?> clazz) Create a new ConstraintDescriptions for the given clazz.
ConstraintDescriptions(Class<?> clazz, ConstraintDescriptionResolver descriptionResolver) Create a new ConstraintDescriptions for the given clazz.
ConstraintDescriptions(Class<?> clazz, ConstraintResolver constraintResolver) Create a new ConstraintDescriptions for the given clazz.
ConstraintDescriptions(Class<?> clazz, ConstraintResolver constraintResolver, ConstraintDescriptionResolver descriptionResolver) Create a new ConstraintDescriptions for the given clazz.

Method Summary

Modifier and Type	Method and Description
List<String>	descriptionsForProperty(String property) Returns a list of the descriptions for the constraints on the given property.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstraintDescriptions

public ConstraintDescriptions(Class<?> clazz)

Create a new ConstraintDescriptions for the given clazz. Constraints will be resolved using a ValidatorConstraintResolver and descriptions will be resolved using a ResourceBundleConstraintDescriptionResolver.

Parameters:

clazz - the class

ConstraintDescriptions

public ConstraintDescriptions(Class<?> clazz,
                              ConstraintResolver constraintResolver)

Create a new ConstraintDescriptions for the given clazz. Constraints will be resolved using the given constraintResolver and descriptions will be resolved using a ResourceBundleConstraintDescriptionResolver.

Parameters:

clazz - the class

constraintResolver - the constraint resolver

ConstraintDescriptions

public ConstraintDescriptions(Class<?> clazz,
                              ConstraintDescriptionResolver descriptionResolver)

Create a new ConstraintDescriptions for the given clazz. Constraints will be resolved using a ValidatorConstraintResolver and descriptions will be resolved using the given descriptionResolver.

Parameters:

clazz - the class

descriptionResolver - the description resolver

ConstraintDescriptions

public ConstraintDescriptions(Class<?> clazz,
                              ConstraintResolver constraintResolver,
                              ConstraintDescriptionResolver descriptionResolver)

Create a new ConstraintDescriptions for the given clazz. Constraints will be resolved using the given constraintResolver and descriptions will be resolved using the given descriptionResolver.

Parameters:

clazz - the class

constraintResolver - the constraint resolver

descriptionResolver - the description resolver

Method Detail

descriptionsForProperty

public List<String> descriptionsForProperty(String property)

Returns a list of the descriptions for the constraints on the given property.

Parameters:

property - the property

Returns:

the list of constraint descriptions