Package org.springframework.data.rest.core.mapping

Class AnnotationBasedResourceDescription

java.lang.Object

org.springframework.data.rest.core.mapping.ResolvableResourceDescriptionSupport

org.springframework.data.rest.core.mapping.AnnotationBasedResourceDescription

All Implemented Interfaces:

MessageSourceResolvable, ResourceDescription

public class AnnotationBasedResourceDescription
extends ResolvableResourceDescriptionSupport

A ResourceDescription that is customized based on a Description annotation. Allows to fall back on another ResourceDescription to provide defaults.

Author:

Oliver Gierke

Constructor Summary

Constructors

Constructor	Description
AnnotationBasedResourceDescription(Class<?> type, ResourceDescription fallback)
AnnotationBasedResourceDescription(Description description, ResourceDescription fallback)	Creates a new AnnotationBasedResourceDescription for the given Description and fallback.

Method Summary

Modifier and Type	Method	Description
String @Nullable []	getCodes()
String	getMessage()	Returns the description.
MediaType	getType()
boolean	isDefault()	Returns whether this is the default description.

Methods inherited from class org.springframework.data.rest.core.mapping.ResolvableResourceDescriptionSupport

getArguments, getDefaultMessage

Methods inherited from class java.lang.Object

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

Constructor Details

AnnotationBasedResourceDescription

public AnnotationBasedResourceDescription(Description description,
 ResourceDescription fallback)

Creates a new AnnotationBasedResourceDescription for the given Description and fallback.

Parameters:

description - must not be null.

fallback - must not be null.

AnnotationBasedResourceDescription

public AnnotationBasedResourceDescription(Class<?> type,
 ResourceDescription fallback)

Method Details

getCodes

public String @Nullable [] getCodes()

getMessage

public String getMessage()

Description copied from interface: ResourceDescription

Returns the description. This can be a message source code or a custom text format. Prefer resolving the ResourceDescription using a MessageSource.

Returns:

getType

public MediaType getType()

Returns:

the mediaType

isDefault

public boolean isDefault()

Description copied from interface: ResourceDescription

Returns whether this is the default description.

Returns: