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

Interface ResourceDescription

All Superinterfaces:
org.springframework.context.MessageSourceResolvable
All Known Implementing Classes:
AnnotationBasedResourceDescription, ResolvableResourceDescriptionSupport, SimpleResourceDescription, TypedResourceDescription
public interface ResourceDescription extends org.springframework.context.MessageSourceResolvable
A description of a resource. Resolvable to plain text by using a MessageSource.
Author:
Oliver Gierke

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getMessage()
    Returns the description.
    org.springframework.http.MediaType
    getType()
     
    boolean
    isDefault()
    Returns whether this is the default description.

    Methods inherited from interface org.springframework.context.MessageSourceResolvable

    getArguments, getCodes, getDefaultMessage

  • Method Details

    • getMessage

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

    • isDefault

      boolean isDefault()
      Returns whether this is the default description.
      Returns:

    • getType

      org.springframework.http.MediaType getType()