B C E F G H I J L M P R S T V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
B
- build() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder
-
Transform the entities, Links, relationships and included into a
RepresentationModel
.
C
- com.toedter.spring.hateoas.jsonapi - package com.toedter.spring.hateoas.jsonapi
-
JSON:API-specific extensions, SPIs and Jackson customizations.
- configureObjectMapper(ObjectMapper) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiMediaTypeConfiguration
- create() - Static method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
- create() - Static method in class com.toedter.spring.hateoas.jsonapi.JsonApiErrors
- customize(ObjectMapper) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration
-
Customizes the object mapper if a customizer was set with withObjectMapperCustomizer.
E
- equals(Object) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
F
- fields(String, String...) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder
-
Adds a sparse fieldset for the given JSON:API type.
G
- getCode() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
-
Gets an application-specific error code, expressed as a string value.
- getDetail() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
-
Gets a human-readable explanation specific to this occurrence of the problem.
- getErrors() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiErrors
- getId() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
-
Gets a unique identifier for this particular occurrence of the problem.
- getJacksonModule() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiMediaTypeConfiguration
- getLinks() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
-
Gets a links object containing the following members: about: a link that leads to further details about this particular occurrence of the problem.
- getMediaTypes() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiMediaTypeConfiguration
- getMeta() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
-
Gets a meta object containing non-standard meta-information about the error.
- getSource() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
-
Gets an object containing references to the source of the error, optionally including any of the following members: pointer: a JSON Pointer [RFC6901] to the associated entity in the request document [e.g.
- getStatus() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
-
Gets the the HTTP status code applicable to this problem, expressed as a string value.
- getTitle() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
-
Gets a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- getTypeForClass(Class<?>) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration
-
Returns the JSON:API resource object type for a given class, when it was added with
JsonApiConfiguration.withTypeForClass(Class, String)
.
H
- hashCode() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
I
- included(Object) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder
-
Adds the given
Object
to the includedEntityModel
s. - included(EntityModel<?>) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder
-
Adds the given
EntityModel
to the includedEntityModel
s. - isJsonApiVersionRendered() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration
-
Indicates if the JSON:API version is rendered.
- isLowerCasedTypeRendered() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration
-
Indicates if the JSON:API type attribute of resource objects is lower-cased.
- isPageMetaAutomaticallyCreated() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration
-
Indicates if page meta data (rendered as top level JSON:API meta) for a paged model is created automatically.
- isPluralizedTypeRendered() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration
-
Indicates if the JSON:API type attribute of resource objects is pluralized.
J
- Jackson2JsonApiModule - Class in com.toedter.spring.hateoas.jsonapi
-
Jackson
SimpleModule
for JSON:API serializers and deserializers. - Jackson2JsonApiModule() - Constructor for class com.toedter.spring.hateoas.jsonapi.Jackson2JsonApiModule
- JSON_API - Static variable in class com.toedter.spring.hateoas.jsonapi.MediaTypes
-
Public constant media type for
application/vnd.api+json
. - JSON_API_VALUE - Static variable in class com.toedter.spring.hateoas.jsonapi.MediaTypes
-
A String equivalent of the JSON:API media type
- JsonApiConfiguration - Class in com.toedter.spring.hateoas.jsonapi
-
JSON:API specific configuration.
- JsonApiConfiguration() - Constructor for class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration
-
Creates a new default
JsonApiConfiguration
. - JsonApiError - Class in com.toedter.spring.hateoas.jsonapi
-
Class to build a single JSON:API compliant error.
- JsonApiError() - Constructor for class com.toedter.spring.hateoas.jsonapi.JsonApiError
-
Creates an empty
JsonApiError
. - JsonApiErrors - Class in com.toedter.spring.hateoas.jsonapi
-
Class to build JSON:API compliant error messages.
- JsonApiErrors() - Constructor for class com.toedter.spring.hateoas.jsonapi.JsonApiErrors
- JsonApiErrors(JsonApiError) - Constructor for class com.toedter.spring.hateoas.jsonapi.JsonApiErrors
- JsonApiId - Annotation Type in com.toedter.spring.hateoas.jsonapi
-
Specifies the JSON:API id of a resource object.
- JsonApiMediaTypeConfiguration - Class in com.toedter.spring.hateoas.jsonapi
-
Spring configuration for JSON:API support.
- JsonApiMediaTypeConfiguration(ObjectProvider<JsonApiConfiguration>, AutowireCapableBeanFactory) - Constructor for class com.toedter.spring.hateoas.jsonapi.JsonApiMediaTypeConfiguration
- jsonApiModel() - Static method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder
-
Creates a new
JsonApiModelBuilder
. - JsonApiModelBuilder - Class in com.toedter.spring.hateoas.jsonapi
-
Builder API to create complex JSON:API representations exposing a JSON:API idiomatic API.
- JsonApiRelationships - Annotation Type in com.toedter.spring.hateoas.jsonapi
-
Specifies the JSON:API relationships of a resource object.
- JsonApiRelationshipSerializer - Class in com.toedter.spring.hateoas.jsonapi
- JsonApiRelationshipSerializer(JsonApiConfiguration) - Constructor for class com.toedter.spring.hateoas.jsonapi.JsonApiRelationshipSerializer
- JsonApiType - Annotation Type in com.toedter.spring.hateoas.jsonapi
-
Specifies the JSON:API type of a resource object.
- JsonApiTypeForClass - Annotation Type in com.toedter.spring.hateoas.jsonapi
-
Specifies the JSON:API type of a resource object.
L
- link(String, LinkRelation) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder
-
Adds a
Link
with the given href andLinkRelation
to theRepresentationModel
to be built. - link(Link) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder
-
Adds a
Link
to theRepresentationModel
to be built. - links(Iterable<Link>) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder
-
Adds the given
Link
s to theRepresentationModel
to be built.
M
- MediaTypes - Class in com.toedter.spring.hateoas.jsonapi
-
Provides the JSON:API media type
application/vnd.api+json
. - MediaTypes() - Constructor for class com.toedter.spring.hateoas.jsonapi.MediaTypes
- meta(String, Object) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder
-
Adds the given key/value pair to the JSON:API meta.
- model(Object) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder
-
Creates an
EntityModel
from the object as the base for the RepresentationModel to be built. - model(RepresentationModel<?>) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder
-
Sets the
RepresentationModel
as the base for the RepresentationModel to be built.
P
- pageLinks(String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder
-
Creates all pagination links with JSON:API default request parameters for page number page[number] and page size page[size].
- pageLinks(String, String, String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder
-
Creates all pagination links.
- pageMeta() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder
-
Adds the paging information to the JSON:API meta.
R
- relationship(String, Object) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder
-
Adds or updates a relationship based on the
Object
. - relationship(String, String, String, Links) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder
-
Adds or updates a relationship based on the links to the
RepresentationModel
to be built. - relationship(String, Collection<?>) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder
-
Adds or updates a relationship based on the
Collection
. - relationship(String, Map<String, Object>) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder
-
Adds or updates a relationship based on the meta to the
RepresentationModel
to be built. - relationship(String, EntityModel<?>) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder
-
Adds or updates a relationship based on the given
EntityModel
to theRepresentationModel
to be built. - relationship(String, EntityModel<?>, String, String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder
-
Adds or updates a relationship based on the given
EntityModel
and links. - relationshipWithDataArray(String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder
-
If called (anywhere in the builder sequence), the data portion of this relationship will be always rendered as an array, even if the data is not set or is one single element, e.g.
S
- serialize(JsonApiRelationship, JsonGenerator, SerializerProvider) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiRelationshipSerializer
T
- toString() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
- toString() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiErrors
V
- value() - Method in annotation type com.toedter.spring.hateoas.jsonapi.JsonApiRelationships
- value() - Method in annotation type com.toedter.spring.hateoas.jsonapi.JsonApiTypeForClass
W
- withAboutLink(String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
-
Adds an about link to the error.
- withCode(String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
-
Sets an application-specific error code, expressed as a string value.
- withDetail(String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
-
Sets a human-readable explanation specific to this occurrence of the problem.
- withError(JsonApiError) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiErrors
- withId(String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
-
Sets a unique identifier for this particular occurrence of the problem.
- withJsonApiVersionRendered(boolean) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration
-
Indicates if the JSON:API version is rendered.
- withLowerCasedTypeRendered(boolean) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration
-
Indicates if the JSON:API type attribute of resource objects is lower-cased.
- withMeta(Map<String, Object>) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
-
Sets a meta object containing non-standard meta-information about the error.
- withObjectMapperCustomizer(Consumer<ObjectMapper>) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration
-
You can pass a lambda expression to customize the ObjectMapper used for serialization.
- withPageMetaAutomaticallyCreated(boolean) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration
-
Indicates if page meta data (rendered as top level JSON:API meta) for a paged model is created automatically.
- withPluralizedTypeRendered(boolean) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration
-
Indicates if the JSON:API type attribute of resource objects is pluralized.
- withSourceParameter(String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
-
Adds a source parameter to the error.
- withSourcePointer(String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
-
Adds a source pointer to the error.
- withStatus(String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
-
Adds the HTTP status code applicable to this problem, expressed as a string value.
- withTitle(String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
-
Sets a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- withTypeForClass(Class<?>, String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration
-
Creates a mapping for a given class to get the JSON:API resource object type when rendered.
All Classes All Packages