Index (Spring HATEOAS Siren 1.2.0 API)

B C D E F G H L M N P R S T U V W
All Classes All Packages

B

build() - Method in class de.ingogriebsch.spring.hateoas.siren.SirenModelBuilder: Builds a RepresentationModel based on the content hold in this SirenModelBuilder instance.

C

CHECKBOX - de.ingogriebsch.spring.hateoas.siren.SirenActionFieldType: Deprecated.
classes(Iterable<String>) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenModelBuilder: Adds the given classes to the RepresentationModel to be built.
classes(String...) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenModelBuilder: Adds the given classes to the RepresentationModel to be built.
CollectionModelFactory - Interface in de.ingogriebsch.spring.hateoas.siren: A factory to create a CollectionModel instance based on the given input that is evaluated during deserialization.
COLOR - de.ingogriebsch.spring.hateoas.siren.SirenActionFieldType: Deprecated.
configureObjectMapper(ObjectMapper) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenMediaTypeConfiguration
convert(AffordanceModel.PropertyMetadata, MediaType) - Method in interface de.ingogriebsch.spring.hateoas.siren.SirenActionFieldTypeConverter: Deprecated.
use SirenActionFieldTypeConverter.execute(PropertyMetadata, MediaType) instead.
create(JavaType, Iterable<Link>, Iterable<Object>, PagedModel.PageMetadata) - Method in interface de.ingogriebsch.spring.hateoas.siren.PagedModelFactory: Creates a PagedModel based on the given input.
create(JavaType, Iterable<Link>, Iterable<Object>, Map<String, Object>) - Method in interface de.ingogriebsch.spring.hateoas.siren.CollectionModelFactory: Creates a CollectionModel based on the given input.
create(JavaType, Iterable<Link>, Object, Map<String, Object>) - Method in interface de.ingogriebsch.spring.hateoas.siren.EntityModelFactory: Creates an EntityModel based on the given input.
create(JavaType, Iterable<Link>, Map<String, Object>) - Method in interface de.ingogriebsch.spring.hateoas.siren.RepresentationModelFactory: Creates a RepresentationModel based on the given input.

D

DATE - de.ingogriebsch.spring.hateoas.siren.SirenActionFieldType: Deprecated.
DATETIME - de.ingogriebsch.spring.hateoas.siren.SirenActionFieldType: Deprecated.
DATETIME_LOCAL - de.ingogriebsch.spring.hateoas.siren.SirenActionFieldType: Deprecated.
de.ingogriebsch.spring.hateoas.siren - package de.ingogriebsch.spring.hateoas.siren: Siren-specific extensions, SPIs and Jackson customizations.
DEFAULT_INSTANCE - Static variable in interface de.ingogriebsch.spring.hateoas.siren.RepresentationModelFactories: The default instance that can be used if no specific implementation of this interface is necessary.
DEFAULT_INSTANCE - Static variable in interface de.ingogriebsch.spring.hateoas.siren.SirenActionFieldTypeConverter: The default instance that can be used if no specific implementation of this interface is necessary.
DEFAULT_INSTANCE - Static variable in interface de.ingogriebsch.spring.hateoas.siren.SirenEntityClassProvider: The default instance that can be used if no specific implementation of this interface is necessary.
DEFAULT_INSTANCE - Static variable in interface de.ingogriebsch.spring.hateoas.siren.SirenEntityRelProvider: The default instance that can be used if no specific implementation of this interface is necessary.

E

EMAIL - de.ingogriebsch.spring.hateoas.siren.SirenActionFieldType: Deprecated.
entities(Iterable<?>) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenModelBuilder: Adds the given entities to the RepresentationModel to be built.
entities(Object) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenModelBuilder: Adds the given entity to the RepresentationModel to be built.
entities(Object...) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenModelBuilder: Adds the given entities to the RepresentationModel to be built.
entities(String, Iterable<?>) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenModelBuilder: Adds the given entities to the RepresentationModel to be built.
entities(String, Object) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenModelBuilder: Adds the given entity to the RepresentationModel to be built.
entities(String, Object...) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenModelBuilder: Adds the given entities to the RepresentationModel to be built.
entities(LinkRelation, Iterable<?>) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenModelBuilder: Adds the given entities to the RepresentationModel to be built.
entities(LinkRelation, Object) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenModelBuilder: Adds the given entity to the RepresentationModel to be built.
entities(LinkRelation, Object...) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenModelBuilder: Adds the given entities to the RepresentationModel to be built.
EntityModelFactory - Interface in de.ingogriebsch.spring.hateoas.siren: A factory to create an EntityModel instance based on the given input that is evaluated during deserialization.
execute(AffordanceModel.PropertyMetadata, MediaType) - Method in interface de.ingogriebsch.spring.hateoas.siren.SirenActionFieldTypeConverter: Converts the given property metadata and the type of the respective Siren action into a HtmlInputType, if possible.

F

FILE - de.ingogriebsch.spring.hateoas.siren.SirenActionFieldType: Deprecated.
forCollectioModel() - Method in interface de.ingogriebsch.spring.hateoas.siren.RepresentationModelFactories
forEntityModel() - Method in interface de.ingogriebsch.spring.hateoas.siren.RepresentationModelFactories
forPagedModel() - Method in interface de.ingogriebsch.spring.hateoas.siren.RepresentationModelFactories
forRepresentationModel() - Method in interface de.ingogriebsch.spring.hateoas.siren.RepresentationModelFactories

G

get(RepresentationModel<?>) - Method in interface de.ingogriebsch.spring.hateoas.siren.SirenEntityClassProvider: Returns the class(es) explaining the nature of the content of a Siren entity.
get(RepresentationModel<?>, RepresentationModel<?>) - Method in interface de.ingogriebsch.spring.hateoas.siren.SirenEntityRelProvider: Returns the relations explaining the relationship between the model and it's parent.
getJacksonModule() - Method in class de.ingogriebsch.spring.hateoas.siren.SirenMediaTypeConfiguration
getMediaTypes() - Method in class de.ingogriebsch.spring.hateoas.siren.SirenMediaTypeConfiguration

H

HIDDEN - de.ingogriebsch.spring.hateoas.siren.SirenActionFieldType: Deprecated.

L

linksAndActions(Iterable<Link>) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenModelBuilder: Adds the given links to the RepresentationModel to be built.
linksAndActions(Link) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenModelBuilder: Adds the given link to the RepresentationModel to be built.
linksAndActions(Link...) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenModelBuilder: Adds the given links to the RepresentationModel to be built.
linksAndActions(Links) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenModelBuilder: Adds the given links to the RepresentationModel to be built.

M

MediaTypes - Class in de.ingogriebsch.spring.hateoas.siren: Constants for the Siren hypermedia type.
MediaTypes() - Constructor for class de.ingogriebsch.spring.hateoas.siren.MediaTypes
MONTH - de.ingogriebsch.spring.hateoas.siren.SirenActionFieldType: Deprecated.

N

NUMBER - de.ingogriebsch.spring.hateoas.siren.SirenActionFieldType: Deprecated.

P

PagedModelFactory - Interface in de.ingogriebsch.spring.hateoas.siren: A factory to create a PagedModel instance based on the given input that is evaluated during deserialization.
PASSWORD - de.ingogriebsch.spring.hateoas.siren.SirenActionFieldType: Deprecated.
properties(Object) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenModelBuilder: Adds the given properties to the RepresentationModel to be built.

R

RADIO - de.ingogriebsch.spring.hateoas.siren.SirenActionFieldType: Deprecated.
RANGE - de.ingogriebsch.spring.hateoas.siren.SirenActionFieldType: Deprecated.
RepresentationModelFactories - Interface in de.ingogriebsch.spring.hateoas.siren: A container that holds the factories for all known types of RepresentationModels that are used during the deserialization process.
RepresentationModelFactory - Interface in de.ingogriebsch.spring.hateoas.siren: A factory to create a RepresentationModel instance based on the given input that is evaluated during deserialization.

S

SEARCH - de.ingogriebsch.spring.hateoas.siren.SirenActionFieldType: Deprecated.
SIREN_JSON - Static variable in class de.ingogriebsch.spring.hateoas.siren.MediaTypes: Public constant media type for application/vnd.siren+json.
SIREN_JSON_VALUE - Static variable in class de.ingogriebsch.spring.hateoas.siren.MediaTypes: A String equivalent of MediaTypes.SIREN_JSON.
SirenActionFieldType - Enum in de.ingogriebsch.spring.hateoas.siren: Deprecated.
use HtmlInputType instead.
SirenActionFieldTypeConverter - Interface in de.ingogriebsch.spring.hateoas.siren: SPI to convert a property that is part of an AffordanceModel and the type of the surrounding Siren action into a SirenActionFieldType.
SirenConfiguration - Class in de.ingogriebsch.spring.hateoas.siren: A Siren specific configuration that allows to configure specific parts of the library.
SirenConfiguration() - Constructor for class de.ingogriebsch.spring.hateoas.siren.SirenConfiguration
SirenEntityClassProvider - Interface in de.ingogriebsch.spring.hateoas.siren: SPI to provide information about the nature of the content of a Siren entity.
SirenEntityRelProvider - Interface in de.ingogriebsch.spring.hateoas.siren: SPI to provide information about the relationship of a Siren entity to it's parent.
SirenLinkDiscoverer - Class in de.ingogriebsch.spring.hateoas.siren: LinkDiscoverer implementation that is based on the Siren link structure.
SirenLinkDiscoverer() - Constructor for class de.ingogriebsch.spring.hateoas.siren.SirenLinkDiscoverer: Constructor for MediaTypes.SIREN_JSON.
SirenMediaTypeConfiguration - Class in de.ingogriebsch.spring.hateoas.siren: A Spring based configuration that enables Siren support in the surrounding environment.
SirenMediaTypeConfiguration(ObjectProvider<MessageResolver>, ObjectProvider<SirenConfiguration>, ObjectProvider<SirenEntityClassProvider>, ObjectProvider<SirenEntityRelProvider>, ObjectProvider<SirenActionFieldTypeConverter>, ObjectProvider<RepresentationModelFactories>) - Constructor for class de.ingogriebsch.spring.hateoas.siren.SirenMediaTypeConfiguration
sirenModel() - Static method in class de.ingogriebsch.spring.hateoas.siren.SirenModelBuilder: Creates a new SirenModelBuilder.
SirenModelBuilder - Class in de.ingogriebsch.spring.hateoas.siren: A builder that allows to build complex Siren entity structures.

T

TEL - de.ingogriebsch.spring.hateoas.siren.SirenActionFieldType: Deprecated.
TEXT - de.ingogriebsch.spring.hateoas.siren.SirenActionFieldType: Deprecated.
TIME - de.ingogriebsch.spring.hateoas.siren.SirenActionFieldType: Deprecated.
title(String) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenModelBuilder: Adds the given title to the RepresentationModel to be built.

U

URL - de.ingogriebsch.spring.hateoas.siren.SirenActionFieldType: Deprecated.

V

valueOf(String) - Static method in enum de.ingogriebsch.spring.hateoas.siren.SirenActionFieldType: Deprecated.

Returns the enum constant of this type with the specified name.
values() - Static method in enum de.ingogriebsch.spring.hateoas.siren.SirenActionFieldType: Deprecated.

Returns an array containing the constants of this enum type, in the order they are declared.

W

WEEK - de.ingogriebsch.spring.hateoas.siren.SirenActionFieldType: Deprecated.
withActionFieldTypeMappging(Class<?>, SirenActionFieldType) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenConfiguration: Deprecated.
use SirenConfiguration.withActionFieldTypeMappging(Class, HtmlInputType) instead.
withActionFieldTypeMappging(Class<?>, HtmlInputType) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenConfiguration: Configures additional mappings that are used to convert the type of a payload field into a Siren action field type.
withEntityAndCollectionModelSubclassingEnabled(boolean) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenConfiguration: Configures whether it is possible to subclass EntityModels and CollectionModels.
withObjectMapperCustomizer(Consumer<ObjectMapper>) - Method in class de.ingogriebsch.spring.hateoas.siren.SirenConfiguration: Configures the ObjectMapper instance that is used for serialization.

B C D E F G H L M N P R S T U V W
All Classes All Packages