Index (JSON:API for Spring HATEOAS 3.0.1-SNAPSHOT API)

B C E F G H I J L M N P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

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.
configureJsonMapper(JsonMapper.Builder) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiMediaTypeConfiguration
create() - Static method in class com.toedter.spring.hateoas.jsonapi.JsonApiError: Creates an empty JsonApiError.
create() - Static method in class com.toedter.spring.hateoas.jsonapi.JsonApiErrors: Creates a new empty JsonApiErrors collection.
customize(JsonMapper.Builder) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: Customizes the given JsonMapper.Builder with the registered callback.

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.
findLinksWithRel(LinkRelation, InputStream) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiLinkDiscoverer
findLinksWithRel(LinkRelation, String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiLinkDiscoverer
findLinkWithRel(LinkRelation, InputStream) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiLinkDiscoverer
findLinkWithRel(LinkRelation, String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiLinkDiscoverer

G

getAffordancesRenderedAsLinkMeta() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: Indicates if Spring HATEOAS affordances are rendered as JSON:API link meta.
getClassForType(String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: Returns the class for a given type, when the class was added with JsonApiConfiguration.withTypeForClass(Class, String).
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: Gets the list of JsonApiError objects contained in this errors collection.
getExt() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiObject: Gets the list of JSON:API extensions.
getId() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError: Gets a unique identifier for this particular occurrence of the problem.
getJsonApiIdNotSerializedForValue() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: If you want to create JSON for a POST request that does not contain the id attribute.
getJsonApiObject() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: Indicates if the JSON:API object is rendered.
getJsonMapper() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: Returns a configured JsonMapper instance.
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.
getLinksNotUrlEncoded() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: By default, JSON:API links are serialized as URL encoded.
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.
getMeta() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiObject: Gets the JSON:API object meta.
getProfile() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiObject: Gets the list of JSON:API profiles.
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 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).
getVersion() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiObject: Gets the supported JSON:API version.

H

HAL_FORMS - Enum constant in enum class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration.AffordanceType: Affordances will be rendered as link meta (HAL-FORMS format).
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 included RepresentationModels.
included(Collection<?>) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder: Adds the given Collection to the included RepresentationModels.
included(RepresentationModel<?>) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder: Adds the given RepresentationModel to the included RepresentationModels.
isEmptyAttributesObjectSerialized() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: Indicates if empty attributes are serialized as empty object.
isJsonApi11LinkPropertiesRemovedFromLinkMeta() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: JSON:API 1.1 introduced the possible link properties title, type, and hreflang (and some more), see JSON:API link objects.
isJsonApiCompliantLinks() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: JSON:API is very strict about the allowed link relations, the allowed top-level links are self, related, describedBy, next, pre, first and last.
isLinksAtResourceLevel() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: Controls where links are placed in JSON:API documents for single resource (EntityModel) serialization.
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 metadata (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.
isTypeForClassUsedForDeserialization() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: Indicates if the Java class to JSON:API mapping created with JsonApiConfiguration is also used during deserialization.

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: Creates a new Jackson2JsonApiModule without JsonApiConfiguration.
Jackson2JsonApiModule(JsonApiConfiguration) - Constructor for class com.toedter.spring.hateoas.jsonapi.Jackson2JsonApiModule: Creates a new Jackson2JsonApiModule with a given JsonApiConfiguration.
JSON_API - Static variable in class com.toedter.spring.hateoas.jsonapi.MediaTypes: MediaType constant for JSON:API: application/vnd.api+json.
JSON_API_VALUE - Static variable in class com.toedter.spring.hateoas.jsonapi.MediaTypes: String representation of the JSON:API media type: "application/vnd.api+json".
JsonApiConfiguration - Class in com.toedter.spring.hateoas.jsonapi: Configuration class for customizing JSON:API serialization and deserialization behavior.
JsonApiConfiguration() - Constructor for class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: Creates a new default JsonApiConfiguration.
JsonApiConfiguration.AffordanceType - Enum Class in com.toedter.spring.hateoas.jsonapi: The list of possible affordance types.
JsonApiError - Class in com.toedter.spring.hateoas.jsonapi: Represents a single JSON:API error object compliant with the JSON:API specification.
JsonApiError() - Constructor for class com.toedter.spring.hateoas.jsonapi.JsonApiError: Creates an empty JsonApiError.
JsonApiErrors - Class in com.toedter.spring.hateoas.jsonapi: Collection of JSON:API error objects for building compliant error responses.
JsonApiErrors() - Constructor for class com.toedter.spring.hateoas.jsonapi.JsonApiErrors: Creates an empty JsonApiErrors collection.
JsonApiErrors(JsonApiError) - Constructor for class com.toedter.spring.hateoas.jsonapi.JsonApiErrors: Creates a JsonApiErrors collection with an initial error.
JsonApiId - Annotation Interface in com.toedter.spring.hateoas.jsonapi: Marks a field or method as the source of the JSON:API resource identifier.
JsonApiLinkDiscoverer - Class in com.toedter.spring.hateoas.jsonapi: LinkDiscoverer implementation based on JSON:API link structure.
JsonApiLinkDiscoverer() - Constructor for class com.toedter.spring.hateoas.jsonapi.JsonApiLinkDiscoverer: Constructor for JSON_API.
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: Creates a new JsonApiMediaTypeConfiguration.
JsonApiMeta - Annotation Interface in com.toedter.spring.hateoas.jsonapi: Marks a field or method for inclusion in the JSON:API meta object.
jsonApiModel() - Static method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder: Creates a new JsonApiModelBuilder.
JsonApiModelBuilder - Class in com.toedter.spring.hateoas.jsonapi: Fluent builder API for creating complex JSON:API representations with relationships and included resources.
JsonApiObject - Class in com.toedter.spring.hateoas.jsonapi: This class represents a JSON:API object compliant to the see JSON:API 1.1 specification.
JsonApiObject() - Constructor for class com.toedter.spring.hateoas.jsonapi.JsonApiObject: Creates an empty JSON:API object for deserialization.
JsonApiObject(boolean) - Constructor for class com.toedter.spring.hateoas.jsonapi.JsonApiObject: Creates a JSON:API object compliant to the see JSON:API 1.1 spec.
JsonApiObject(boolean, List<URI>, List<URI>, Map<String, Object>) - Constructor for class com.toedter.spring.hateoas.jsonapi.JsonApiObject: Creates a JSON:API object compliant to the see JSON:API 1.1 spec.
JsonApiRelationships - Annotation Interface in com.toedter.spring.hateoas.jsonapi: Specifies the JSON:API relationships of a resource object.
JsonApiType - Annotation Interface in com.toedter.spring.hateoas.jsonapi: Marks a field or method as the source of the JSON:API resource type.
JsonApiTypeForClass - Annotation Interface in com.toedter.spring.hateoas.jsonapi: Specifies the JSON:API type for resource objects of this class.

L

link(String, LinkRelation) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder: Adds a Link with the given href and LinkRelation to the top level of the JSON:API document.
link(Link) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder: Adds a Link to the top level of the JSON:API document.
links(Iterable<Link>) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder: Adds multiple Links to the top level of the JSON:API document.

M

MediaTypes - Class in com.toedter.spring.hateoas.jsonapi: Provides constants for the JSON:API media type.
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 given object as the primary data for the JSON:API document.
model(RepresentationModel<?>) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder: Sets the RepresentationModel as the primary data for the JSON:API document to be built.

N

NONE - Enum constant in enum class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration.AffordanceType: Default, affordances will NOT be rendered as link meta.

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, Object, 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, 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<?>, String, String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder: Adds or updates a relationship based on the given EntityModel and links.
relationship(String, EntityModel<?>) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder: Adds or updates a relationship based on the given EntityModel to the RepresentationModel to be built.
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 always be rendered as an array, even if the data is not set or is one single element, e.g.
relationshipWithEmptyData(String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder: Adds or updates a relationship with explicit empty array data.
relationshipWithNullData(String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiModelBuilder: Adds or updates a relationship with explicit null data.

S

SPRING_HATEOAS - Enum constant in enum class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration.AffordanceType: Affordances will be rendered as link meta (proprietary format).
supports(MediaType) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiLinkDiscoverer

T

toString() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError
toString() - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiErrors

V

value() - Element in annotation interface com.toedter.spring.hateoas.jsonapi.JsonApiRelationships: The name of the relationship.
value() - Element in annotation interface com.toedter.spring.hateoas.jsonapi.JsonApiTypeForClass: The JSON:API type for resource objects of this class.
valueOf(String) - Static method in enum class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration.AffordanceType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration.AffordanceType: Returns an array containing the constants of this enum class, in the order they are declared.

W

withAboutLink(String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError: Adds an about link to the error.
withAffordancesRenderedAsLinkMeta(JsonApiConfiguration.AffordanceType) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: Indicates if Spring HATEOAS affordances are rendered as JSON:API link meta.
withCode(String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError: Gets an application-specific error code, expressed as a string value.
withDetail(String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError: Gets a human-readable explanation specific to this occurrence of the problem.
withEmptyAttributesObjectSerialized(boolean) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: Indicates if empty attributes are serialized as empty object.
withError(JsonApiError) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiErrors: Adds an error to this collection.
withId(String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError: Gets a unique identifier for this particular occurrence of the problem.
withJsonApi11LinkPropertiesRemovedFromLinkMeta(boolean) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: JSON:API 1.1 introduced the possible link properties title, type, and hreflang (and some more), see JSON:API link objects.
withJsonApiCompliantLinks(boolean) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: JSON:API is very strict about the allowed link relations, the allowed top-level links are self, related, describedBy, next, pre, first and last.
withJsonApiIdNotSerializedForValue(String) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: If you want to create JSON for a POST request that does not contain the id attribute.
withJsonApiObject(JsonApiObject) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: Indicates if the JSON:API object is rendered.
withLinksAtResourceLevel(boolean) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: Controls where links are placed in JSON:API documents for single resource (EntityModel) serialization.
withLinksNotUrlEncoded(Set<LinkRelation>) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: By default, JSON:API links are serialized as URL encoded.
withLowerCasedTypeRendered(boolean) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: Indicates if the JSON:API type attribute of resource objects is lower-cased.
withMapperCustomizer(UnaryOperator<JsonMapper.Builder>) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: A customizer function that allows modification of the JsonMapper.Builder used for JSON:API serialization and deserialization.
withMeta(Map<String, Object>) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiError: Gets a meta object containing non-standard meta-information about the error.
withPageMetaAutomaticallyCreated(boolean) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: Indicates if page metadata (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: Gets the HTTP status code applicable to this problem, expressed as a string value.
withTitle(String) - 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.
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.
withTypeForClassUsedForDeserialization(boolean) - Method in class com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration: Indicates if the Java class to JSON:API mapping created with JsonApiConfiguration is also used during deserialization.

B C E F G H I J L M N P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form