org.springframework.data.rest.core.mapping

Class SimpleResourceDescription

java.lang.Object

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

org.springframework.data.rest.core.mapping.SimpleResourceDescription

All Implemented Interfaces:

MessageSourceResolvable, ResourceDescription

Direct Known Subclasses:

TypedResourceDescription

public class SimpleResourceDescription
extends ResolvableResourceDescriptionSupport

Author:

Oliver Gierke

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_KEY_PREFIX
protected static MediaType	DEFAULT_MEDIA_TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimpleResourceDescription(String message, MediaType mediaType) Creates a new SimpleResourceDescription with the given message and MediaType.

Method Summary

Modifier and Type	Method and Description
static ResourceDescription	defaultFor(org.springframework.hateoas.LinkRelation rel)
String[]	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

Field Detail

DEFAULT_KEY_PREFIX

public static final String DEFAULT_KEY_PREFIX

See Also:

Constant Field Values

DEFAULT_MEDIA_TYPE

protected static final MediaType DEFAULT_MEDIA_TYPE

Constructor Detail

SimpleResourceDescription

protected SimpleResourceDescription(String message,
                                    MediaType mediaType)

Creates a new SimpleResourceDescription with the given message and MediaType.

Parameters:

message - must not be null or empty.

mediaType - must not be null or empty.

Method Detail

defaultFor

public static ResourceDescription defaultFor(org.springframework.hateoas.LinkRelation rel)

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()

isDefault

public boolean isDefault()

Description copied from interface: ResourceDescription

Returns whether this is the default description.

Returns:

getCodes

public String[] getCodes()