Index (JSONAPI Converter 0.13 API)

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

A

addLink(String, Link) - Method in class com.github.jasminb.jsonapi.JSONAPIDocument: Adds a named link.
addLink(String, Link) - Method in class com.github.jasminb.jsonapi.Links: Adds a named link.
addMeta(String, Object) - Method in class com.github.jasminb.jsonapi.JSONAPIDocument
ALLOW_UNKNOWN_INCLUSIONS - com.github.jasminb.jsonapi.DeserializationFeature: This option determines whether encountering unknown types results in IllegalArgumentException being thrown, or if parsing continues and the unknown field is ignored.
ALLOW_UNKNOWN_TYPE_IN_RELATIONSHIP - com.github.jasminb.jsonapi.DeserializationFeature: This option determines if relationship (collection) can have unknown type.
asString(Object) - Method in class com.github.jasminb.jsonapi.IntegerIdHandler
asString(Object) - Method in class com.github.jasminb.jsonapi.LongIdHandler
asString(Object) - Method in interface com.github.jasminb.jsonapi.ResourceIdHandler: Convert identifier to String.
asString(Object) - Method in class com.github.jasminb.jsonapi.StringIdHandler
ATTRIBUTES - Static variable in interface com.github.jasminb.jsonapi.JSONAPISpecConstants

B

build() - Method in class com.github.jasminb.jsonapi.SerializationSettings.Builder: Create new SerialisationSettings instance.
Builder() - Constructor for class com.github.jasminb.jsonapi.SerializationSettings.Builder

C

cache(String, Object) - Method in class com.github.jasminb.jsonapi.ResourceCache: Adds resource to cache.
cache(Map<String, Object>) - Method in class com.github.jasminb.jsonapi.ResourceCache: Adds multiple resources to cache.
clear() - Method in class com.github.jasminb.jsonapi.ResourceCache: Clears current thread scope state.
com.github.jasminb.jsonapi - package com.github.jasminb.jsonapi
com.github.jasminb.jsonapi.annotations - package com.github.jasminb.jsonapi.annotations
com.github.jasminb.jsonapi.exceptions - package com.github.jasminb.jsonapi.exceptions
com.github.jasminb.jsonapi.models.errors - package com.github.jasminb.jsonapi.models.errors
com.github.jasminb.jsonapi.retrofit - package com.github.jasminb.jsonapi.retrofit
contains(String) - Method in class com.github.jasminb.jsonapi.ResourceCache: Checks if resource with given identifier is cached.
convert(ResponseBody) - Method in class com.github.jasminb.jsonapi.retrofit.JSONAPIDocumentResponseBodyConverter
convert(ResponseBody) - Method in class com.github.jasminb.jsonapi.retrofit.JSONAPIResponseBodyConverter
convert(T) - Method in class com.github.jasminb.jsonapi.retrofit.JSONAPIRequestBodyConverter
ConverterConfiguration - Class in com.github.jasminb.jsonapi: Converter configuration.
ConverterConfiguration(Class<?>...) - Constructor for class com.github.jasminb.jsonapi.ConverterConfiguration: Creates new ConverterConfiguration.
createErrorDocument(Iterable<? extends Error>) - Static method in class com.github.jasminb.jsonapi.JSONAPIDocument: Factory method for creating JSONAPIDocument that holds the Error object.

D

DATA - Static variable in interface com.github.jasminb.jsonapi.JSONAPISpecConstants
DeserializationFeature - Enum in com.github.jasminb.jsonapi: Enumeration that defines list of deserialization features that can be set to ResourceConverter.
disableDeserializationOption(DeserializationFeature) - Method in class com.github.jasminb.jsonapi.ResourceConverter: Removes (disables) existing deserialization option.
disableSerializationOption(SerializationFeature) - Method in class com.github.jasminb.jsonapi.ResourceConverter: Removes (disables) existing serialization option.
DocumentSerializationException - Exception in com.github.jasminb.jsonapi.exceptions: Thrown in case resource serialization fails.
DocumentSerializationException(Throwable) - Constructor for exception com.github.jasminb.jsonapi.exceptions.DocumentSerializationException: Creates new DocumentSerializationException.

E

enableDeserializationOption(DeserializationFeature) - Method in class com.github.jasminb.jsonapi.ResourceConverter: Adds (enables) new deserialization option.
enableSerializationOption(SerializationFeature) - Method in class com.github.jasminb.jsonapi.ResourceConverter: Adds (enables) new serialization option.
ensurePrimaryDataValidArray(JsonNode) - Static method in class com.github.jasminb.jsonapi.ValidationUtils: Ensures 'DATA' node is Array containing only valid Resource Objects or Resource Identifier Objects.
ensurePrimaryDataValidObjectOrNull(JsonNode) - Static method in class com.github.jasminb.jsonapi.ValidationUtils: Ensures 'DATA' node is a valid object, null or has JsonNode type NULL.
ensureValidDocument(ObjectMapper, JsonNode) - Static method in class com.github.jasminb.jsonapi.ValidationUtils: Ensures document has at least one of 'DATA', 'ERRORS' or 'META' attributes.
ensureValidResourceObjectArray(JsonNode) - Static method in class com.github.jasminb.jsonapi.ValidationUtils: Ensures 'DATA' node is Array containing only valid Resource Objects.
Error - Class in com.github.jasminb.jsonapi.models.errors: JSON API Error model.
Error() - Constructor for class com.github.jasminb.jsonapi.models.errors.Error
Errors - Class in com.github.jasminb.jsonapi.models.errors: JSON API error response.
Errors() - Constructor for class com.github.jasminb.jsonapi.models.errors.Errors
ERRORS - Static variable in interface com.github.jasminb.jsonapi.JSONAPISpecConstants
ErrorUtils - Class in com.github.jasminb.jsonapi: Utility class providing methods needed for parsing JSON API Spec errors.
excludedRelationships(String) - Method in class com.github.jasminb.jsonapi.SerializationSettings.Builder: Explicitly disable relationship serialisation.

F

FIRST - Static variable in interface com.github.jasminb.jsonapi.JSONAPISpecConstants
fromString(String) - Method in class com.github.jasminb.jsonapi.IntegerIdHandler
fromString(String) - Method in class com.github.jasminb.jsonapi.LongIdHandler
fromString(String) - Method in interface com.github.jasminb.jsonapi.ResourceIdHandler: Create identifier object by consuming its string representation.
fromString(String) - Method in class com.github.jasminb.jsonapi.StringIdHandler

G

get() - Method in class com.github.jasminb.jsonapi.JSONAPIDocument: Gets resource object
get(String) - Method in class com.github.jasminb.jsonapi.ResourceCache: Returns cached resource or null if resource was not found in cache.
getAbout() - Method in class com.github.jasminb.jsonapi.models.errors.Links
getAnnotatedFields(Class<?>, Class<? extends Annotation>, boolean) - Static method in class com.github.jasminb.jsonapi.ReflectionUtils: Returns all field from a given class that are annotated with provided annotation type.
getCode() - Method in class com.github.jasminb.jsonapi.models.errors.Error
getDefaultFeatures() - Static method in enum com.github.jasminb.jsonapi.DeserializationFeature: Returns set of features that are enabled by default.
getDefaultFeatures() - Static method in enum com.github.jasminb.jsonapi.SerializationFeature: Returns set of features that are enabled by default.
getDetail() - Method in class com.github.jasminb.jsonapi.models.errors.Error
getErrors() - Method in exception com.github.jasminb.jsonapi.exceptions.ResourceParseException: Returns Errors or null
getErrors() - Method in class com.github.jasminb.jsonapi.JSONAPIDocument: Returns error objects or null in case no errors were set.
getErrors() - Method in class com.github.jasminb.jsonapi.models.errors.Errors
getExt() - Method in class com.github.jasminb.jsonapi.JsonApi
getFieldRelationship(Field) - Method in class com.github.jasminb.jsonapi.ConverterConfiguration: Resolves Relationship instance for given field.
getFieldType(Field) - Static method in class com.github.jasminb.jsonapi.ReflectionUtils
getFirst() - Method in class com.github.jasminb.jsonapi.Links: Convenience method for returning the first link.
getHref() - Method in class com.github.jasminb.jsonapi.Link: Gets href.
getId() - Method in class com.github.jasminb.jsonapi.models.errors.Error
getIdField(Class<?>) - Method in class com.github.jasminb.jsonapi.ConverterConfiguration: Returns the id field for given type.
getIdHandler(Class<?>) - Method in class com.github.jasminb.jsonapi.ConverterConfiguration: Returns handler registered for given type's id field.
getJsonapi() - Method in class com.github.jasminb.jsonapi.models.errors.Errors
getJsonApi() - Method in class com.github.jasminb.jsonapi.JSONAPIDocument: Returns JSON API object if present.
getLast() - Method in class com.github.jasminb.jsonapi.Links: Convenience method for returning the last link.
getLink(String) - Method in class com.github.jasminb.jsonapi.Links: Convenience method for returning named link.
getLinks() - Method in class com.github.jasminb.jsonapi.JSONAPIDocument: Gets links.
getLinks() - Method in class com.github.jasminb.jsonapi.Links: Gets all registered links.
getLinks() - Method in class com.github.jasminb.jsonapi.models.errors.Error
getLinksField(Class<?>) - Method in class com.github.jasminb.jsonapi.ConverterConfiguration: Resolves link field for given type.
getMeta() - Method in class com.github.jasminb.jsonapi.JsonApi
getMeta() - Method in class com.github.jasminb.jsonapi.JSONAPIDocument: Get meta data.
getMeta() - Method in class com.github.jasminb.jsonapi.Link: Gets meta.
getMeta() - Method in class com.github.jasminb.jsonapi.models.errors.Error
getMeta(Class<?>) - Method in class com.github.jasminb.jsonapi.JSONAPIDocument: Returns typed meta-data object or null if no meta is present.
getMetaField(Class<?>) - Method in class com.github.jasminb.jsonapi.ConverterConfiguration: Returns field annotated with meta annotation for given type.
getMetaType(Class<?>) - Method in class com.github.jasminb.jsonapi.ConverterConfiguration: Returns meta-data type for given class.
getNext() - Method in class com.github.jasminb.jsonapi.Links: Convenience method for returning the next link.
getParameter() - Method in class com.github.jasminb.jsonapi.models.errors.Source
getPointer() - Method in class com.github.jasminb.jsonapi.models.errors.Source
getPrevious() - Method in class com.github.jasminb.jsonapi.Links: Convenience method for returning the prev link.
getProfile() - Method in class com.github.jasminb.jsonapi.JsonApi
getRelated() - Method in class com.github.jasminb.jsonapi.Links: Convenience method for returning the related link.
getRelationshipField(Class<?>, String) - Method in class com.github.jasminb.jsonapi.ConverterConfiguration: Returns relationship field.
getRelationshipFields(Class<?>) - Method in class com.github.jasminb.jsonapi.ConverterConfiguration: Returns list of all fields annotated with Relationship annotation for given class.
getRelationshipLinksField(Class<?>, String) - Method in class com.github.jasminb.jsonapi.ConverterConfiguration: Returns relationship links field.
getRelationshipMetaField(Class<?>, String) - Method in class com.github.jasminb.jsonapi.ConverterConfiguration: Returns relationship meta field.
getRelationshipMetaType(Class<?>, String) - Method in class com.github.jasminb.jsonapi.ConverterConfiguration: Returns a type of a relationship meta field.
getRelationshipType(Class<?>, String) - Method in class com.github.jasminb.jsonapi.ConverterConfiguration: Returns a type of a relationship.
getRelName() - Method in enum com.github.jasminb.jsonapi.RelType: Obtains the name of the relationship, suitable for use in serialized JSON.
getResponseJSONNode() - Method in class com.github.jasminb.jsonapi.JSONAPIDocument: Returns raw JSON node used to create this JSONAPIDocument.
getSelf() - Method in class com.github.jasminb.jsonapi.Links: Convenience method for returning the self link.
getSource() - Method in class com.github.jasminb.jsonapi.models.errors.Error
getStatus() - Method in class com.github.jasminb.jsonapi.models.errors.Error
getTitle() - Method in class com.github.jasminb.jsonapi.models.errors.Error
getType() - Method in exception com.github.jasminb.jsonapi.exceptions.UnregisteredTypeException: Returns the unregistered type for which this exception is applicable to.
getType() - Method in class com.github.jasminb.jsonapi.retrofit.RetrofitType: Gets type.
getType(Class<?>) - Method in class com.github.jasminb.jsonapi.ConverterConfiguration: Resolves and returns the type given to provided class.
getTypeClass(String) - Method in class com.github.jasminb.jsonapi.ConverterConfiguration: Resolves a type for given type name.
getTypeName(Class<?>) - Method in class com.github.jasminb.jsonapi.ConverterConfiguration: Resolves and returns name of the type given to provided class.
getTypeName(Class<?>) - Static method in class com.github.jasminb.jsonapi.ReflectionUtils: Returns the type name defined using Type annotation on provided class.
getVersion() - Method in class com.github.jasminb.jsonapi.JsonApi

H

hasIncludedRelationships() - Method in class com.github.jasminb.jsonapi.SerializationSettings: Returns true in case there is at least one relationship that should be included during serialization.
HREF - Static variable in interface com.github.jasminb.jsonapi.JSONAPISpecConstants

I

Id - Annotation Type in com.github.jasminb.jsonapi.annotations: Annotation used to mark resource field as an id in JSON API resource class.
ID - Static variable in interface com.github.jasminb.jsonapi.JSONAPISpecConstants
INCLUDE_ID - com.github.jasminb.jsonapi.SerializationFeature: If enabled, Id attribute will be serialized
INCLUDE_JSONAPI_OBJECT - com.github.jasminb.jsonapi.SerializationFeature: If enabled JSON API object will be serialized.
INCLUDE_LINKS - com.github.jasminb.jsonapi.SerializationFeature: If enabled, links attribute will be serialized
INCLUDE_META - com.github.jasminb.jsonapi.SerializationFeature: If enabled, meta attribute will be serialized
INCLUDE_RELATIONSHIP_ATTRIBUTES - com.github.jasminb.jsonapi.SerializationFeature: This option if enabled instructs resource converter to serialize entire relationship objects (type and id are serialized by default)
INCLUDED - Static variable in interface com.github.jasminb.jsonapi.JSONAPISpecConstants
includeRelationship(String) - Method in class com.github.jasminb.jsonapi.SerializationSettings.Builder: Explicitly enable relationship serialisation.
init() - Method in class com.github.jasminb.jsonapi.ResourceCache: Initialises cache for current thread-scope.
IntegerIdHandler - Class in com.github.jasminb.jsonapi: Handles Integer as resource identifier type.
IntegerIdHandler() - Constructor for class com.github.jasminb.jsonapi.IntegerIdHandler: Creates new IntegerIdHandler.
InvalidJsonApiResourceException - Exception in com.github.jasminb.jsonapi.exceptions: InvalidJsonApiResourceException implementation.
InvalidJsonApiResourceException() - Constructor for exception com.github.jasminb.jsonapi.exceptions.InvalidJsonApiResourceException: Creates a new InvalidJsonApiResourceException.
InvalidJsonApiResourceException(String) - Constructor for exception com.github.jasminb.jsonapi.exceptions.InvalidJsonApiResourceException: Creates a new InvalidJsonApiResourceException.
isArrayOfResourceIdentifierObjects(JsonNode) - Static method in class com.github.jasminb.jsonapi.ValidationUtils: Returns true in case 'DATA' node has array of valid Resource Identifier Objects.
isArrayOfResourceObjects(JsonNode) - Static method in class com.github.jasminb.jsonapi.ValidationUtils: Returns true in case 'DATA' node has array of valid Resource Objects.
isCollection() - Method in class com.github.jasminb.jsonapi.retrofit.RetrofitType: Is collection boolean.
isEligibleType(Class<?>) - Static method in class com.github.jasminb.jsonapi.ConverterConfiguration: Checks if class is eligible as resource type (must have Type annotation and field annotated with Id.
isJSONAPIDocumentType() - Method in class com.github.jasminb.jsonapi.retrofit.RetrofitType: Returns true if type used to instantiate this object was wrapped with JSONAPIDocument.
isNotNullNode(JsonNode) - Static method in class com.github.jasminb.jsonapi.ValidationUtils: Returns true in case 'DATA' node is not null and does not have JsonNode type NULL.
isRegisteredType(Class<?>) - Method in class com.github.jasminb.jsonapi.ConverterConfiguration: Checks if provided class was registered with this configuration instance.
isRegisteredType(Class<?>) - Method in class com.github.jasminb.jsonapi.ResourceConverter: Checks if provided type is registered with this converter instance.
isRelationshipExcluded(String) - Method in class com.github.jasminb.jsonapi.SerializationSettings: Checks if relationship with provided name has been explicitly marked for exclusion in serialized object.
isRelationshipIncluded(String) - Method in class com.github.jasminb.jsonapi.SerializationSettings: Checks if relationship with provided name has been explicitly marked for inclusion in serialized object.
isResourceIdentifierObject(JsonNode) - Static method in class com.github.jasminb.jsonapi.ValidationUtils: Returns true in case node has 'ID' and 'TYPE' attributes.
isResourceObject(JsonNode) - Static method in class com.github.jasminb.jsonapi.ValidationUtils: Returns true in case 'DATA' node has 'ATTRIBUTES' and 'TYPE' attributes.
isValid() - Method in class com.github.jasminb.jsonapi.retrofit.RetrofitType: Is valid boolean.
isValidObject(JsonNode) - Static method in class com.github.jasminb.jsonapi.ValidationUtils: Returns true in case 'DATA' node is valid Resource Object or Resource Identifier Object.

J

JSON_API - Static variable in interface com.github.jasminb.jsonapi.JSONAPISpecConstants
JsonApi - Class in com.github.jasminb.jsonapi: JSON API model.
JsonApi() - Constructor for class com.github.jasminb.jsonapi.JsonApi
JSONAPIConverterFactory - Class in com.github.jasminb.jsonapi.retrofit: JSON API request/response converter factory.
JSONAPIConverterFactory(ObjectMapper, Class<?>...) - Constructor for class com.github.jasminb.jsonapi.retrofit.JSONAPIConverterFactory: Creates new JSONAPIConverterFactory.
JSONAPIConverterFactory(ResourceConverter) - Constructor for class com.github.jasminb.jsonapi.retrofit.JSONAPIConverterFactory: Creates new JSONAPIConverterFactory.
JSONAPIConverterFactory(ResourceConverter, ResourceConverter) - Constructor for class com.github.jasminb.jsonapi.retrofit.JSONAPIConverterFactory: Creates new JSONAPIConverterFactory.
JSONAPIDocument<T> - Class in com.github.jasminb.jsonapi: JSON API Document wrapper.
JSONAPIDocument() - Constructor for class com.github.jasminb.jsonapi.JSONAPIDocument: Creates new JSONAPIDocument.
JSONAPIDocument(Error) - Constructor for class com.github.jasminb.jsonapi.JSONAPIDocument: Creates new JSONAPIDocument.
JSONAPIDocument(Iterable<? extends Error>) - Constructor for class com.github.jasminb.jsonapi.JSONAPIDocument: Creates new JSONAPIDocument.
JSONAPIDocument(T) - Constructor for class com.github.jasminb.jsonapi.JSONAPIDocument: Creates new JsonApiDocument.
JSONAPIDocument(T, JsonNode, ObjectMapper) - Constructor for class com.github.jasminb.jsonapi.JSONAPIDocument: Creates new JSONAPIDocument.
JSONAPIDocument(T, ObjectMapper) - Constructor for class com.github.jasminb.jsonapi.JSONAPIDocument: Creates new JSONAPIDocument.
JSONAPIDocument(T, Links, Map<String, Object>) - Constructor for class com.github.jasminb.jsonapi.JSONAPIDocument: Creates new JsonApiDocument.
JSONAPIDocument(T, Links, Map<String, Object>, ObjectMapper) - Constructor for class com.github.jasminb.jsonapi.JSONAPIDocument: Creates new JsonApiDocument.
JSONAPIDocumentResponseBodyConverter<T> - Class in com.github.jasminb.jsonapi.retrofit: JSON API response body converter.
JSONAPIDocumentResponseBodyConverter(ResourceConverter, Class<?>, boolean) - Constructor for class com.github.jasminb.jsonapi.retrofit.JSONAPIDocumentResponseBodyConverter: Creates new JSONAPIDocumentResponseBodyConverter.
JSONAPIRequestBodyConverter<T> - Class in com.github.jasminb.jsonapi.retrofit: JSON API request body converter implementation.
JSONAPIRequestBodyConverter(ResourceConverter) - Constructor for class com.github.jasminb.jsonapi.retrofit.JSONAPIRequestBodyConverter: Creates new JSONAPIRequestBodyConverter.
JSONAPIResponseBodyConverter<T> - Class in com.github.jasminb.jsonapi.retrofit: JSON API response body converter.
JSONAPIResponseBodyConverter(ResourceConverter, Class<?>, boolean) - Constructor for class com.github.jasminb.jsonapi.retrofit.JSONAPIResponseBodyConverter: Creates new JSONAPIResponseBodyConverter.
JSONAPISpecConstants - Interface in com.github.jasminb.jsonapi: JSON API Spec resource constants.

L

LAST - Static variable in interface com.github.jasminb.jsonapi.JSONAPISpecConstants
Link - Class in com.github.jasminb.jsonapi: Models a JSON API Link object.
Link() - Constructor for class com.github.jasminb.jsonapi.Link: Creates new Link.
Link(String) - Constructor for class com.github.jasminb.jsonapi.Link: Creates new Link.
Link(String, Map<String, ?>) - Constructor for class com.github.jasminb.jsonapi.Link: Creates new Link.
Link.LinkSerializer - Class in com.github.jasminb.jsonapi
Links - Class in com.github.jasminb.jsonapi: JSON API spec links object.
Links - Class in com.github.jasminb.jsonapi.models.errors: JSON API Links model.
Links - Annotation Type in com.github.jasminb.jsonapi.annotations: Annotation used to configure links field in JSON API resources.
Links() - Constructor for class com.github.jasminb.jsonapi.Links: Create new Links.
Links() - Constructor for class com.github.jasminb.jsonapi.models.errors.Links
Links(Map<String, Link>) - Constructor for class com.github.jasminb.jsonapi.Links: Create new Links.
LINKS - Static variable in interface com.github.jasminb.jsonapi.JSONAPISpecConstants
LinkSerializer() - Constructor for class com.github.jasminb.jsonapi.Link.LinkSerializer
lock() - Method in class com.github.jasminb.jsonapi.ResourceCache: Locks this cache instance for thread scope that method was invoked in.
LongIdHandler - Class in com.github.jasminb.jsonapi: Handles Long as resource identifier type.
LongIdHandler() - Constructor for class com.github.jasminb.jsonapi.LongIdHandler: Creates new LongIdHandler.

M

Meta - Annotation Type in com.github.jasminb.jsonapi.annotations: Annotation used to configure meta field in JSON API resources.
META - Static variable in interface com.github.jasminb.jsonapi.JSONAPISpecConstants

N

NEXT - Static variable in interface com.github.jasminb.jsonapi.JSONAPISpecConstants

P

parseError(ObjectMapper, JsonNode, Class<T>) - Static method in class com.github.jasminb.jsonapi.ErrorUtils: Parses provided JsonNode and returns it as T.
parseError(ObjectMapper, InputStream, Class<T>) - Static method in class com.github.jasminb.jsonapi.ErrorUtils
parseErrorResponse(ObjectMapper, ResponseBody, Class<T>) - Static method in class com.github.jasminb.jsonapi.ErrorUtils: Parses provided ResponseBody and returns it as T.
path() - Method in annotation type com.github.jasminb.jsonapi.annotations.Relationship: Resource path, used to generate self link.
path() - Method in annotation type com.github.jasminb.jsonapi.annotations.Type: Resource path, used to generate self link.
PREV - Static variable in interface com.github.jasminb.jsonapi.JSONAPISpecConstants

R

readDocument(byte[], Class<T>) - Method in class com.github.jasminb.jsonapi.ResourceConverter: Reads JSON API spec document and converts it into target type.
readDocument(InputStream, Class<T>) - Method in class com.github.jasminb.jsonapi.ResourceConverter: Reads JSON API spec document and converts it into target type.
readDocumentCollection(byte[], Class<T>) - Method in class com.github.jasminb.jsonapi.ResourceConverter: Reads JSON API spec document and converts it into collection of target type objects.
readDocumentCollection(InputStream, Class<T>) - Method in class com.github.jasminb.jsonapi.ResourceConverter: Reads JSON API spec document and converts it into collection of target type objects.
readObject(byte[], Class<T>) - Method in class com.github.jasminb.jsonapi.ResourceConverter: Deprecated.
readObjectCollection(byte[], Class<T>) - Method in class com.github.jasminb.jsonapi.ResourceConverter: Deprecated.
ReflectionUtils - Class in com.github.jasminb.jsonapi: Various utility methods that simplify JAVA reflection actions.
registerType(Class<?>) - Method in class com.github.jasminb.jsonapi.ConverterConfiguration: Registers new type with this configuration instance.
registerType(Class<?>) - Method in class com.github.jasminb.jsonapi.ResourceConverter: Registers new type to be used with this converter instance.
RELATED - com.github.jasminb.jsonapi.RelType
RELATED - Static variable in interface com.github.jasminb.jsonapi.JSONAPISpecConstants
relatedPath() - Method in annotation type com.github.jasminb.jsonapi.annotations.Relationship: Resource path, used to generate related link.
Relationship - Annotation Type in com.github.jasminb.jsonapi.annotations: Annotation used to configure relationship field in JSON API resources.
RelationshipLinks - Annotation Type in com.github.jasminb.jsonapi.annotations: Relationship links annotation.
RelationshipMeta - Annotation Type in com.github.jasminb.jsonapi.annotations: Relationship meta annotation.
RelationshipResolver - Interface in com.github.jasminb.jsonapi: Relationship resolver contract.
RELATIONSHIPS - Static variable in interface com.github.jasminb.jsonapi.JSONAPISpecConstants
relType() - Method in annotation type com.github.jasminb.jsonapi.annotations.Relationship
RelType - Enum in com.github.jasminb.jsonapi: Encapsulates supported relationship types.
requestBodyConverter(Type, Annotation[], Annotation[], Retrofit) - Method in class com.github.jasminb.jsonapi.retrofit.JSONAPIConverterFactory
REQUIRE_RESOURCE_ID - com.github.jasminb.jsonapi.DeserializationFeature: This option enforces presence of the 'id' attribute in resources being parsed.
resolve() - Method in annotation type com.github.jasminb.jsonapi.annotations.Relationship
resolve(String) - Method in interface com.github.jasminb.jsonapi.RelationshipResolver: Resolve relationship data.
ResourceCache - Class in com.github.jasminb.jsonapi: Resource caching provider.
ResourceCache() - Constructor for class com.github.jasminb.jsonapi.ResourceCache
ResourceConverter - Class in com.github.jasminb.jsonapi: JSON API data converter.
ResourceConverter(ObjectMapper, Class<?>...) - Constructor for class com.github.jasminb.jsonapi.ResourceConverter
ResourceConverter(ObjectMapper, String, Class<?>...) - Constructor for class com.github.jasminb.jsonapi.ResourceConverter: Creates new ResourceConverter.
ResourceConverter(Class<?>...) - Constructor for class com.github.jasminb.jsonapi.ResourceConverter: Creates new ResourceConverter.
ResourceConverter(String, Class<?>...) - Constructor for class com.github.jasminb.jsonapi.ResourceConverter: Creates new ResourceConverter.
ResourceIdHandler - Interface in com.github.jasminb.jsonapi: Resource identifier handler.
ResourceParseException - Exception in com.github.jasminb.jsonapi.exceptions: ResourceParseException implementation.
ResourceParseException(Errors) - Constructor for exception com.github.jasminb.jsonapi.exceptions.ResourceParseException
responseBodyConverter(Type, Annotation[], Retrofit) - Method in class com.github.jasminb.jsonapi.retrofit.JSONAPIConverterFactory
RetrofitType - Class in com.github.jasminb.jsonapi.retrofit: Simple class used to simplify type management in Retrofit converter factory.
RetrofitType(Type) - Constructor for class com.github.jasminb.jsonapi.retrofit.RetrofitType: Instantiates a new Retrofit type.

S

SELF - com.github.jasminb.jsonapi.RelType
SELF - Static variable in interface com.github.jasminb.jsonapi.JSONAPISpecConstants
serialise() - Method in annotation type com.github.jasminb.jsonapi.annotations.Relationship
serialiseData() - Method in annotation type com.github.jasminb.jsonapi.annotations.Relationship
SerializationFeature - Enum in com.github.jasminb.jsonapi: Enumeration that defines list of serialization features that can be set to ResourceConverter.
SerializationSettings - Class in com.github.jasminb.jsonapi: Serialization settings.
SerializationSettings.Builder - Class in com.github.jasminb.jsonapi: Serialisation settings builder.
serialize(Link, JsonGenerator, SerializerProvider) - Method in class com.github.jasminb.jsonapi.Link.LinkSerializer
serializeId() - Method in class com.github.jasminb.jsonapi.SerializationSettings: Returns Id serialization flag.
serializeId(Boolean) - Method in class com.github.jasminb.jsonapi.SerializationSettings.Builder: Enable or disable id serialization.
serializeJSONAPIObject() - Method in class com.github.jasminb.jsonapi.SerializationSettings: Returns JSON API object serialization flag.
serializeJSONAPIObject(Boolean) - Method in class com.github.jasminb.jsonapi.SerializationSettings.Builder: Enable or disable JSON API object serialization.
serializeLinks() - Method in class com.github.jasminb.jsonapi.SerializationSettings: Returns links serialization flag.
serializeLinks(Boolean) - Method in class com.github.jasminb.jsonapi.SerializationSettings.Builder: Enable or disable links serialization.
serializeMeta() - Method in class com.github.jasminb.jsonapi.SerializationSettings: Returns meta serialization flag.
serializeMeta(Boolean) - Method in class com.github.jasminb.jsonapi.SerializationSettings.Builder: Enable or disable meta serialization.
setAbout(String) - Method in class com.github.jasminb.jsonapi.models.errors.Links
setAlternativeFactory(Converter.Factory) - Method in class com.github.jasminb.jsonapi.retrofit.JSONAPIConverterFactory: Sets alternative converter factory to use in case type is cannot be handled by this factory.
setCode(String) - Method in class com.github.jasminb.jsonapi.models.errors.Error
setDetail(String) - Method in class com.github.jasminb.jsonapi.models.errors.Error
setErrors(List<Error>) - Method in class com.github.jasminb.jsonapi.models.errors.Errors
setExt(List<String>) - Method in class com.github.jasminb.jsonapi.JsonApi
setGlobalResolver(RelationshipResolver) - Method in class com.github.jasminb.jsonapi.ResourceConverter: Registers global relationship resolver.
setHref(String) - Method in class com.github.jasminb.jsonapi.Link: Sets href.
setId(String) - Method in class com.github.jasminb.jsonapi.models.errors.Error
setJsonapi(JsonApi) - Method in class com.github.jasminb.jsonapi.models.errors.Errors
setJsonApi(JsonApi) - Method in class com.github.jasminb.jsonapi.JSONAPIDocument: Sets the JSON API object.
setLinks(Links) - Method in class com.github.jasminb.jsonapi.JSONAPIDocument: Sets links.
setLinks(Links) - Method in class com.github.jasminb.jsonapi.models.errors.Error
setMeta(JsonNode) - Method in class com.github.jasminb.jsonapi.models.errors.Error
setMeta(Map<String, ?>) - Method in class com.github.jasminb.jsonapi.JSONAPIDocument: Sets meta data.
setMeta(Map<String, ?>) - Method in class com.github.jasminb.jsonapi.Link: Sets meta.
setMeta(Map<String, Object>) - Method in class com.github.jasminb.jsonapi.JsonApi
setParameter(String) - Method in class com.github.jasminb.jsonapi.models.errors.Source
setPointer(String) - Method in class com.github.jasminb.jsonapi.models.errors.Source
setProfile(List<String>) - Method in class com.github.jasminb.jsonapi.JsonApi
setSource(Source) - Method in class com.github.jasminb.jsonapi.models.errors.Error
setStatus(String) - Method in class com.github.jasminb.jsonapi.models.errors.Error
setTitle(String) - Method in class com.github.jasminb.jsonapi.models.errors.Error
setTypeResolver(RelationshipResolver, Class<?>) - Method in class com.github.jasminb.jsonapi.ResourceConverter: Registers relationship resolver for given type.
setVersion(String) - Method in class com.github.jasminb.jsonapi.JsonApi
Source - Class in com.github.jasminb.jsonapi.models.errors
Source() - Constructor for class com.github.jasminb.jsonapi.models.errors.Source
StringIdHandler - Class in com.github.jasminb.jsonapi: Handles String as resource identifier type.
StringIdHandler() - Constructor for class com.github.jasminb.jsonapi.StringIdHandler: Creates new StringIdHandler.

T

toString() - Method in class com.github.jasminb.jsonapi.Link
toString() - Method in class com.github.jasminb.jsonapi.models.errors.Error
toString() - Method in class com.github.jasminb.jsonapi.models.errors.Errors
Type - Annotation Type in com.github.jasminb.jsonapi.annotations: Used for declaring type as a JSON API resource.
TYPE - Static variable in interface com.github.jasminb.jsonapi.JSONAPISpecConstants

U

unlock() - Method in class com.github.jasminb.jsonapi.ResourceCache: Unlocks this cache instance for thread scope that method was invoked in.
UnregisteredTypeException - Exception in com.github.jasminb.jsonapi.exceptions: UnregisteredTypeException implementation.
UnregisteredTypeException(String) - Constructor for exception com.github.jasminb.jsonapi.exceptions.UnregisteredTypeException: Constructor.

V

ValidationUtils - Class in com.github.jasminb.jsonapi: Utility methods for validating segments of JSON API resource object.
value() - Method in annotation type com.github.jasminb.jsonapi.annotations.Id
value() - Method in annotation type com.github.jasminb.jsonapi.annotations.Relationship
value() - Method in annotation type com.github.jasminb.jsonapi.annotations.RelationshipLinks
value() - Method in annotation type com.github.jasminb.jsonapi.annotations.RelationshipMeta
value() - Method in annotation type com.github.jasminb.jsonapi.annotations.Type: Resource type name.
valueOf(String) - Static method in enum com.github.jasminb.jsonapi.DeserializationFeature: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.github.jasminb.jsonapi.RelType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.github.jasminb.jsonapi.SerializationFeature: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.github.jasminb.jsonapi.DeserializationFeature: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.github.jasminb.jsonapi.RelType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.github.jasminb.jsonapi.SerializationFeature: Returns an array containing the constants of this enum type, in the order they are declared.

W

writeDocument(JSONAPIDocument<?>) - Method in class com.github.jasminb.jsonapi.ResourceConverter: Serializes provided JSONAPIDocument into JSON API Spec compatible byte representation.
writeDocument(JSONAPIDocument<?>, SerializationSettings) - Method in class com.github.jasminb.jsonapi.ResourceConverter: Serializes provided JSONAPIDocument into JSON API Spec compatible byte representation.
writeDocumentCollection(JSONAPIDocument<? extends Iterable<?>>) - Method in class com.github.jasminb.jsonapi.ResourceConverter: Serializes provided JSONAPIDocument into JSON API Spec compatible byte representation.
writeDocumentCollection(JSONAPIDocument<? extends Iterable<?>>, SerializationSettings) - Method in class com.github.jasminb.jsonapi.ResourceConverter: Serializes provided JSONAPIDocument into JSON API Spec compatible byte representation.
writeObject(Object) - Method in class com.github.jasminb.jsonapi.ResourceConverter: Deprecated.
writeObjectCollection(Iterable<T>) - Method in class com.github.jasminb.jsonapi.ResourceConverter: Deprecated.
use writeDocumentCollection instead

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