Index
All Classes and Interfaces|All Packages|Serialized Form
A
- adapter(JsonStreamAdapter) - Method in interface io.avaje.jsonb.Jsonb.Builder
-
Explicitly set the adapter to use.
- adapter(Class<T>) - Method in interface io.avaje.jsonb.Jsonb
-
Return the JsonAdapter used to read and write json for the given class.
- adapter(Type) - Method in interface io.avaje.jsonb.Jsonb
-
Return the JsonAdapter used to read and write json for the given type.
- AdapterFactory - Interface in io.avaje.jsonb.spi
-
Factory that is service loaded to create the adapter for underlying json parsing and generation.
- add(JsonAdapter.Factory) - Method in interface io.avaje.jsonb.Jsonb.Builder
-
Add a JsonAdapter.Factory which provides JsonAdapters to use.
- add(JsonbComponent) - Method in interface io.avaje.jsonb.Jsonb.Builder
-
Add a Component which can provide multiple JsonAdapters and or configuration.
- add(Type, JsonAdapter<T>) - Method in interface io.avaje.jsonb.Jsonb.Builder
-
Add a JsonAdapter to use for the given type.
- add(Type, Jsonb.AdapterBuilder) - Method in interface io.avaje.jsonb.Jsonb.Builder
-
Add a AdapterBuilder which provides a JsonAdapter to use for the given type.
- add(String, JsonAdapter<?>, MethodHandle) - Method in interface io.avaje.jsonb.spi.ViewBuilder
-
Add a json property entry.
- addArray(String, JsonAdapter<?>, MethodHandle) - Method in interface io.avaje.jsonb.spi.ViewBuilder
-
Add a nested json array.
- allNames(PropertyNames) - Method in interface io.avaje.jsonb.JsonWriter
-
Set the property names that will be used for all json generation.
- allNames(PropertyNames) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- arrayOf(Type) - Static method in class io.avaje.jsonb.Types
-
Returns an array type whose elements are all instances of
componentType
.
B
- BEGIN_ARRAY - Enum constant in enum io.avaje.jsonb.JsonReader.Token
-
The opening of a JSON array.
- BEGIN_OBJECT - Enum constant in enum io.avaje.jsonb.JsonReader.Token
-
The opening of a JSON object.
- beginArray() - Method in interface io.avaje.jsonb.JsonReader
-
Read array begin.
- beginArray() - Method in interface io.avaje.jsonb.JsonWriter
-
Write array begin.
- beginArray() - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- beginObject() - Method in interface io.avaje.jsonb.JsonReader
-
Read begin object.
- beginObject() - Method in interface io.avaje.jsonb.JsonWriter
-
Write object begin.
- beginObject() - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- beginObject(PropertyNames) - Method in interface io.avaje.jsonb.JsonReader
-
Set the current property names.
- beginObject(PropertyNames) - Method in interface io.avaje.jsonb.JsonWriter
-
Write object being and use the already encoded property names.
- beginObject(PropertyNames) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- beginObject(String, MethodHandle) - Method in interface io.avaje.jsonb.spi.ViewBuilder
-
Begin a json object.
- beginStream() - Method in interface io.avaje.jsonb.JsonReader
-
Read the beginning of an ARRAY or x-json-stream (new line delimited json content).
- BOOLEAN - Enum constant in enum io.avaje.jsonb.JsonReader.Token
-
A JSON
true
orfalse
. - Bootstrap - Interface in io.avaje.jsonb.spi
-
Bootstrap Jsonb.
- BufferedJsonWriter - Interface in io.avaje.jsonb.spi
-
Provides a JsonWriter optimised for returning json as string content.
- bufferedWriter() - Method in interface io.avaje.jsonb.spi.JsonStreamAdapter
-
Return a JsonWriter for use for writing to json string.
- bufferedWriter() - Method in class io.avaje.jsonb.stream.JsonStream
- bufferedWriterAsBytes() - Method in interface io.avaje.jsonb.spi.JsonStreamAdapter
-
Return a JsonWriter to use for writing json to byte array.
- bufferedWriterAsBytes() - Method in class io.avaje.jsonb.stream.JsonStream
- build() - Method in interface io.avaje.jsonb.Jsonb.Builder
-
Build and return the Jsonb instance with all the given adapters and factories registered.
- build() - Method in class io.avaje.jsonb.stream.JsonStream.Builder
-
Build and return the JsonStream.
- build(Jsonb) - Method in interface io.avaje.jsonb.Jsonb.AdapterBuilder
-
Create a JsonAdapter given the Jsonb instance.
- build(ViewBuilder) - Method in interface io.avaje.jsonb.spi.ViewBuilderAware
-
Build view for the top level.
- build(ViewBuilder, String, MethodHandle) - Method in interface io.avaje.jsonb.spi.ViewBuilderAware
-
Build nested part of the view.
- builder() - Static method in interface io.avaje.jsonb.Jsonb
-
Create a new Jsonb.Builder to configure and build the Jsonb instance.
- builder() - Method in interface io.avaje.jsonb.spi.Bootstrap
-
Create and return a Builder (with an underling SPI implementation).
- builder() - Static method in class io.avaje.jsonb.stream.JsonStream
-
Return a new builder to create a JsonStream with custom configuration.
- Builder() - Constructor for class io.avaje.jsonb.stream.JsonStream.Builder
- BytesJsonWriter - Interface in io.avaje.jsonb.spi
-
JsonWriter optimised for returning json as byte array.
C
- caseInsensitiveKeys() - Element in annotation type io.avaje.jsonb.Json
-
When set to true on deserialization keys are matched insensitive to case.
- close() - Method in interface io.avaje.jsonb.JsonReader
-
Close the resources of the reader.
- close() - Method in interface io.avaje.jsonb.JsonWriter
-
Close the writer.
- close() - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- create(boolean, boolean, boolean) - Method in interface io.avaje.jsonb.spi.AdapterFactory
-
Create the adapter to use for the underlying json parsing and generation.
- create(Type, Jsonb) - Method in interface io.avaje.jsonb.JsonAdapter.Factory
-
Create and return a JsonAdapter given the type and annotations or return null.
- currentToken() - Method in interface io.avaje.jsonb.JsonReader
-
Return the current Token.
- CustomAdapter - Annotation Type in io.avaje.jsonb
-
Marks a type as a basic user-provided JsonAdapter to be registered automatically.
D
- delegate - Variable in class io.avaje.jsonb.spi.DelegateJsonWriter
- DelegateJsonWriter - Class in io.avaje.jsonb.spi
-
Provides a delegating JsonWriter.
- DelegateJsonWriter(JsonWriter) - Constructor for class io.avaje.jsonb.spi.DelegateJsonWriter
- deserialize() - Element in annotation type io.avaje.jsonb.Json.Ignore
-
Set this explicitly to true to include in deserialization.
E
- emptyArray() - Method in interface io.avaje.jsonb.JsonWriter
-
Write empty array.
- emptyArray() - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- endArray() - Method in interface io.avaje.jsonb.JsonReader
-
Read array end.
- endArray() - Method in interface io.avaje.jsonb.JsonWriter
-
Write array end.
- endArray() - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- endObject() - Method in interface io.avaje.jsonb.JsonReader
-
Read end object.
- endObject() - Method in interface io.avaje.jsonb.JsonWriter
-
Write object end.
- endObject() - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- endObject() - Method in interface io.avaje.jsonb.spi.ViewBuilder
-
End a json object.
- endStream() - Method in interface io.avaje.jsonb.JsonReader
-
Read the end of an ARRAY or x-json-stream (new line delimited json content).
- Example - Search tag in io.avaje.jsonb.Jsonb.type(Type)
- Section
- Example: - Search tag in annotation type io.avaje.jsonb.CustomAdapter
- Section
- Examples: - Search tag in annotation type io.avaje.jsonb.Json
- Section
F
- failOnUnknown(boolean) - Method in interface io.avaje.jsonb.Jsonb.Builder
-
Set failOnUnknown to true such that an exception is thrown when unknown properties are read in the json content.
- failOnUnknown(boolean) - Method in class io.avaje.jsonb.stream.JsonStream.Builder
-
Set to true to fail on unknown properties.
- field(Class<?>, String) - Method in interface io.avaje.jsonb.spi.ViewBuilder
-
Return a MethodHandle for public field access for the given class and field name.
- flush() - Method in interface io.avaje.jsonb.JsonWriter
-
Flush the writer.
- flush() - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- flush() - Method in interface io.avaje.jsonb.stream.JsonOutput
-
Flush the underlying OutputStream.
- fromJson - Search tag in interface io.avaje.jsonb.JsonType
- Section
- fromJson - Search tag in interface io.avaje.jsonb.Jsonb
- Section
- fromJson - Search tag in package io.avaje.jsonb
- Section
- fromJson(byte[]) - Method in interface io.avaje.jsonb.JsonType
-
Read the return the value from the json content.
- fromJson(JsonReader) - Method in interface io.avaje.jsonb.JsonAdapter
-
Read the type from the reader.
- fromJson(JsonReader) - Method in interface io.avaje.jsonb.JsonType
-
Read the return the value from the reader.
- fromJson(InputStream) - Method in interface io.avaje.jsonb.JsonType
-
Read the return the value from the inputStream.
- fromJson(Reader) - Method in interface io.avaje.jsonb.JsonType
-
Read the return the value from the reader.
- fromJson(String) - Method in interface io.avaje.jsonb.JsonType
-
Read the return the value from the json content.
- fromJson() example - Search tag in io.avaje.jsonb.Jsonb.type(Class<T>)
- Section
- fromObject(Object) - Method in interface io.avaje.jsonb.JsonType
-
Convert from 'object form' expecting
Map<String,Object>
for 'json object' and expectingCollection<?>
for 'json array'.
G
- Generated - Annotation Type in io.avaje.jsonb.spi
-
Marks source code that has been generated.
H
- hasNextElement() - Method in interface io.avaje.jsonb.JsonReader
-
Return true if there is a next element in an ARRAY.
- hasNextField() - Method in interface io.avaje.jsonb.JsonReader
-
Return true if there is a next field to be read in an OBJECT.
- hasNextStreamElement() - Method in interface io.avaje.jsonb.JsonReader
-
Return true if there is a next element in an ARRAY or x-json-stream (new line delimited json content).
I
- implementation() - Element in annotation type io.avaje.jsonb.Json.Import
-
When importing an Interface or abstract type use this implementation for `fromJson()`.
- Initialise using Jackson core with configuration We need to include the dependency io.avaje:avaje-jsonb-jackson to do this. This will use Jackson core JsonParser and JsonGenerator to do the underlying parsing and generation. // create the Jackson JsonFactory JsonFactory customFactory = ...; var jacksonAdapter = JacksonAdapter.builder() .serializeNulls(true) .jsonFactory(customFactory) .build(); Jsonb jsonb = Jsonb.builder() .adapter(jacksonAdapter) .build(); fromJson - Search tag in interface io.avaje.jsonb.Jsonb
- Section
- Initialise with defaults Jsonb jsonb = Jsonb.builder().build(); Initialise with some configuration Jsonb jsonb = Jsonb.builder() .serializeNulls(true) .serializeEmpty(true) .failOnUnknown(true) .build(); fromJson - Search tag in package io.avaje.jsonb
- Section
- Initialise with defaults Jsonb jsonb = Jsonb.builder().build(); Initialise with some configuration Jsonb jsonb = Jsonb.builder() .serializeNulls(true) .serializeEmpty(true) .failOnUnknown(true) .build(); Initialise using Jackson core with configuration We need to include the dependency io.avaje:avaje-jsonb-jackson to do this. This will use Jackson core JsonParser and JsonGenerator to do the underlying parsing and generation. // create the Jackson JsonFactory JsonFactory customFactory = ...; var jacksonAdapter = JacksonAdapter.builder() .serializeNulls(true) .jsonFactory(customFactory) .build(); Jsonb jsonb = Jsonb.builder() .adapter(jacksonAdapter) .build(); fromJson - Search tag in interface io.avaje.jsonb.Jsonb
- Section
- Initialise with some configuration Jsonb jsonb = Jsonb.builder() .serializeNulls(true) .serializeEmpty(true) .failOnUnknown(true) .build(); fromJson - Search tag in package io.avaje.jsonb
- Section
- Initialise with some configuration Jsonb jsonb = Jsonb.builder() .serializeNulls(true) .serializeEmpty(true) .failOnUnknown(true) .build(); Initialise using Jackson core with configuration We need to include the dependency io.avaje:avaje-jsonb-jackson to do this. This will use Jackson core JsonParser and JsonGenerator to do the underlying parsing and generation. // create the Jackson JsonFactory JsonFactory customFactory = ...; var jacksonAdapter = JacksonAdapter.builder() .serializeNulls(true) .jsonFactory(customFactory) .build(); Jsonb jsonb = Jsonb.builder() .adapter(jacksonAdapter) .build(); fromJson - Search tag in interface io.avaje.jsonb.Jsonb
- Section
- io.avaje.jsonb - module io.avaje.jsonb
- io.avaje.jsonb - package io.avaje.jsonb
-
Core API of Jsonb.
- io.avaje.jsonb.spi - package io.avaje.jsonb.spi
-
SPI for the underlying json parsing and generation.
- io.avaje.jsonb.stream - package io.avaje.jsonb.stream
-
Default stream handling provided with Jsonb.
- isGeneric() - Element in annotation type io.avaje.jsonb.CustomAdapter
-
Set to true when the adapter is for a type that uses generics.
- isGenericTypeOf(Type, Class<?>) - Static method in class io.avaje.jsonb.Types
-
Helper method to determine if the given type can be handled by an adapter
- isNullValue() - Method in interface io.avaje.jsonb.JsonReader
-
Return true if the value to be read is a null.
- isViewBuilderAware() - Method in interface io.avaje.jsonb.JsonAdapter
-
Return true if this adapter represents a json object or json array of objects that supports json views.
J
- Json - Annotation Type in io.avaje.jsonb
-
Marks a type for JSON support.
- Json.Alias - Annotation Type in io.avaje.jsonb
-
Define one or more alternative names for a property accepted during deserialization.
- Json.Ignore - Annotation Type in io.avaje.jsonb
-
Exclude the property from serialization, deserialization or both.
- Json.Import - Annotation Type in io.avaje.jsonb
-
Specify types to generate JsonAdapters for.
- Json.Import.List - Annotation Type in io.avaje.jsonb
- Json.JsonAlias - Annotation Type in io.avaje.jsonb
-
Deprecated.
- Json.MixIn - Annotation Type in io.avaje.jsonb
-
Mark this Class as a MixIn Type that can add Jsonb Annotations on the specified type.
- Json.Naming - Enum in io.avaje.jsonb
-
The naming convention that we can use for a given type.
- Json.Property - Annotation Type in io.avaje.jsonb
-
Override the json property name.
- Json.Raw - Annotation Type in io.avaje.jsonb
-
Marks a String field as containing raw JSON content.
- Json.SubType - Annotation Type in io.avaje.jsonb
-
Specify the subtypes that a given type can be represented as.
- Json.SubTypes - Annotation Type in io.avaje.jsonb
-
Container of all the concrete SubType's that an interface type or abstract type can be represented as.
- Json.Unmapped - Annotation Type in io.avaje.jsonb
-
Annotate a
Map<String,Object>
field to hold unmapped json properties. - Json.Value - Annotation Type in io.avaje.jsonb
-
Mark a method on an Enum that provides the json value.
- JsonAdapter<T> - Interface in io.avaje.jsonb
-
The core API for serialization to and from json.
- JsonAdapter.Factory - Interface in io.avaje.jsonb
-
Factory for creating a JsonAdapter.
- Jsonb - Interface in io.avaje.jsonb
-
Provides access to json adapters by type.
- Jsonb.AdapterBuilder - Interface in io.avaje.jsonb
-
Function to build a JsonAdapter that needs Jsonb.
- Jsonb.Builder - Interface in io.avaje.jsonb
-
Build the Jsonb instance adding JsonAdapter, Factory or AdapterBuilder.
- Jsonb.GeneratedComponent - Interface in io.avaje.jsonb
-
Components register JsonAdapters Jsonb.Builder
- JsonbComponent - Interface in io.avaje.jsonb
-
User defined components to register custom JsonAdapters with Jsonb.Builder.
- JsonDataException - Exception Class in io.avaje.jsonb
-
Thrown when data being parsed is not encoded as valid json or attempting to write invalid json.
- JsonDataException(String) - Constructor for exception class io.avaje.jsonb.JsonDataException
- JsonDataException(String, Throwable) - Constructor for exception class io.avaje.jsonb.JsonDataException
- JsonDataException(Throwable) - Constructor for exception class io.avaje.jsonb.JsonDataException
- JsonEofException - Exception Class in io.avaje.jsonb
-
Thrown when we hit EOF unexpectedly.
- JsonEofException(IOException) - Constructor for exception class io.avaje.jsonb.JsonEofException
- JsonEofException(String) - Constructor for exception class io.avaje.jsonb.JsonEofException
- JsonEofException(String, IOException) - Constructor for exception class io.avaje.jsonb.JsonEofException
- JsonException - Exception Class in io.avaje.jsonb
-
Thrown when the data being parsed is not encoded as valid JSON, method invocation fails for json views, or and underlying IOException occurs.
- JsonException(String) - Constructor for exception class io.avaje.jsonb.JsonException
- JsonException(String, Throwable) - Constructor for exception class io.avaje.jsonb.JsonException
- JsonException(Throwable) - Constructor for exception class io.avaje.jsonb.JsonException
- JsonIoException - Exception Class in io.avaje.jsonb
-
Thrown when underlying IOException occurred during read or write of json.
- JsonIoException(IOException) - Constructor for exception class io.avaje.jsonb.JsonIoException
- JsonIoException(String) - Constructor for exception class io.avaje.jsonb.JsonIoException
- JsonIoException(String, IOException) - Constructor for exception class io.avaje.jsonb.JsonIoException
- JsonOutput - Interface in io.avaje.jsonb.stream
-
Output that can be aware of server content chunking.
- JsonReader - Interface in io.avaje.jsonb
-
Reads json content as a stream of JSON tokens and content.
- JsonReader.Token - Enum in io.avaje.jsonb
-
A structure, name, or value type in a JSON-encoded string.
- jsonSettings() - Element in annotation type io.avaje.jsonb.Json.Import
-
Specify the Json setting to apply to the imported classes
- JsonStream - Class in io.avaje.jsonb.stream
-
Default implementation of JsonStreamAdapter provided with Jsonb.
- JsonStream() - Constructor for class io.avaje.jsonb.stream.JsonStream
-
Create with the given default configuration.
- JsonStream(boolean, boolean, boolean) - Constructor for class io.avaje.jsonb.stream.JsonStream
-
Create additionally providing the jsonFactory.
- JsonStream.Builder - Class in io.avaje.jsonb.stream
-
Used to build JsonStream with custom settings.
- JsonStreamAdapter - Interface in io.avaje.jsonb.spi
-
Provides the underlying JsonReader and JsonWriter to use.
- JsonType<T> - Interface in io.avaje.jsonb
-
Provides API to serialise a type to and from JSON.
- jsonValue(Object) - Method in interface io.avaje.jsonb.JsonWriter
-
Write a value that could be any value.
- jsonValue(Object) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- JsonView<T> - Interface in io.avaje.jsonb
-
Represents a subset of properties that can be written as json.
- JsonWriter - Interface in io.avaje.jsonb
-
Writes json content.
L
- list() - Method in interface io.avaje.jsonb.JsonType
-
Return the list type for this JsonType.
- listOf(Type) - Static method in class io.avaje.jsonb.Types
-
Returns a Type that is a List of the given element type.
- location() - Method in interface io.avaje.jsonb.JsonReader
-
Return the current location.
- LowerHyphen - Enum constant in enum io.avaje.jsonb.Json.Naming
- LowerSpace - Enum constant in enum io.avaje.jsonb.Json.Naming
- LowerUnderscore - Enum constant in enum io.avaje.jsonb.Json.Naming
M
- map() - Method in interface io.avaje.jsonb.JsonType
-
Return the map with this type as the value type and string keys.
- mapOf(Type) - Static method in class io.avaje.jsonb.Types
-
Return the Type for a Map with String keys and the given value element type.
- markIncomplete() - Method in interface io.avaje.jsonb.JsonWriter
-
Mark the generated json as not completed due to an error.
- markIncomplete() - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- Match - Enum constant in enum io.avaje.jsonb.Json.Naming
- mathTypesAsString(boolean) - Method in interface io.avaje.jsonb.Jsonb.Builder
-
Set to true for BigDecimal and BigInteger to serialise as String values rather than number values.
- MetaData - Annotation Type in io.avaje.jsonb.spi
-
For internal use, holds metadata on generated adapters for use by code generation (Java annotation processing).
- MetaData.Factory - Annotation Type in io.avaje.jsonb.spi
-
For internal use, holds metadata on generated adapters that also have factories.
- method(Class<?>, String, Class<?>) - Method in interface io.avaje.jsonb.spi.ViewBuilder
-
Return a MethodHandle for the "getter/accessor" for the given class and field name.
N
- name() - Element in annotation type io.avaje.jsonb.Json.SubType
-
The name or "discriminator value" that is used to identify the type.
- name(int) - Method in interface io.avaje.jsonb.JsonWriter
-
Set the next property name to write by position.
- name(int) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- name(String) - Method in interface io.avaje.jsonb.JsonWriter
-
Set the next property name to write.
- name(String) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- naming() - Element in annotation type io.avaje.jsonb.Json
-
Specify the naming convention to use for the properties on this type.
- newBuilder() - Static method in interface io.avaje.jsonb.Jsonb
-
Deprecated.
- newParameterizedType(Type, Type...) - Static method in class io.avaje.jsonb.Types
-
Returns a new parameterized type, applying
typeArguments
torawType
. - nextField() - Method in interface io.avaje.jsonb.JsonReader
-
Return the next field.
- NULL - Enum constant in enum io.avaje.jsonb.JsonReader.Token
-
A JSON
null
. - nullSafe() - Method in interface io.avaje.jsonb.JsonAdapter
-
Return a null safe version of this adapter.
- nullValue() - Method in interface io.avaje.jsonb.JsonWriter
-
Write null value.
- nullValue() - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- NUMBER - Enum constant in enum io.avaje.jsonb.JsonReader.Token
-
A JSON number represented in this API by a Java
double
,long
, orint
.
O
- Object toJson() - Search tag in io.avaje.jsonb.Jsonb.type(Class<T>)
- Section
- Object toJson() - Search tag in io.avaje.jsonb.Jsonb.type(Type)
- Section
- of(ServerResponse) - Static method in interface io.avaje.jsonb.stream.JsonOutput
-
Create for Nima ServerResponse.
- of(OutputStream) - Static method in interface io.avaje.jsonb.stream.JsonOutput
-
Create as a simple wrapper for OutputStream.
- of(Throwable) - Static method in exception class io.avaje.jsonb.JsonException
- optional() - Method in interface io.avaje.jsonb.JsonType
-
Return the Optional type for this JsonType.
- optionalOf(Type) - Static method in class io.avaje.jsonb.Types
-
Returns a Type that is an Optional of the given element type.
P
- path() - Method in interface io.avaje.jsonb.JsonWriter
-
Return the current path.
- path() - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- pretty(boolean) - Method in interface io.avaje.jsonb.JsonWriter
-
Set tp true to output json in pretty format.
- pretty(boolean) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- properties(String...) - Method in interface io.avaje.jsonb.Jsonb
-
Return the property names as PropertyNames.
- properties(String...) - Method in interface io.avaje.jsonb.spi.JsonStreamAdapter
-
Return PropertyNames given the names of properties.
- properties(String...) - Method in class io.avaje.jsonb.stream.JsonStream
- PropertyNames - Interface in io.avaje.jsonb.spi
-
Marker interface for IOAdapter specific property names.
R
- rawAdapter() - Method in interface io.avaje.jsonb.Jsonb
-
Raw JsonAdapter for raw json content.
- rawType(Type) - Static method in class io.avaje.jsonb.Types
-
Return the raw type for the given potentially generic type.
- rawValue(String) - Method in interface io.avaje.jsonb.JsonWriter
-
Write raw JSON content.
- rawValue(String) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- readBigInteger() - Method in interface io.avaje.jsonb.JsonReader
-
Read and return the next value as a BigInteger.
- readBinary() - Method in interface io.avaje.jsonb.JsonReader
-
Read and return the binary value from base64.
- readBoolean() - Method in interface io.avaje.jsonb.JsonReader
-
Read and return the next value as a boolean.
- readDecimal() - Method in interface io.avaje.jsonb.JsonReader
-
Read and return the next value as a BigDecimal.
- readDouble() - Method in interface io.avaje.jsonb.JsonReader
-
Read and return the next value as a double.
- reader(byte[]) - Method in interface io.avaje.jsonb.Jsonb
-
Return the JsonReader used to read the given json content in bytes.
- reader(byte[]) - Method in interface io.avaje.jsonb.spi.JsonStreamAdapter
-
Return the JsonReader given json content as bytes.
- reader(byte[]) - Method in class io.avaje.jsonb.stream.JsonStream
- reader(InputStream) - Method in interface io.avaje.jsonb.Jsonb
-
Return the JsonReader used to read the json content from the given inputStream.
- reader(InputStream) - Method in interface io.avaje.jsonb.spi.JsonStreamAdapter
-
Return the JsonReader given json string content.
- reader(InputStream) - Method in class io.avaje.jsonb.stream.JsonStream
- reader(Reader) - Method in interface io.avaje.jsonb.Jsonb
-
Return the JsonReader used to read the json content from the given reader.
- reader(Reader) - Method in interface io.avaje.jsonb.spi.JsonStreamAdapter
-
Return the JsonReader given json string content.
- reader(Reader) - Method in class io.avaje.jsonb.stream.JsonStream
- reader(String) - Method in interface io.avaje.jsonb.Jsonb
-
Return the JsonReader used to read the given json content.
- reader(String) - Method in interface io.avaje.jsonb.spi.JsonStreamAdapter
-
Return the JsonReader given json string content.
- reader(String) - Method in class io.avaje.jsonb.stream.JsonStream
- readInt() - Method in interface io.avaje.jsonb.JsonReader
-
Read and return the next value as an int.
- readLong() - Method in interface io.avaje.jsonb.JsonReader
-
Read and return the next value as a long.
- readRaw() - Method in interface io.avaje.jsonb.JsonReader
-
Read and return raw json content as a String.
- readString() - Method in interface io.avaje.jsonb.JsonReader
-
Read and return the next value as String.
- register(Jsonb.Builder) - Method in interface io.avaje.jsonb.Jsonb.GeneratedComponent
-
Register JsonAdapters with the Builder.
- register(Jsonb.Builder) - Method in interface io.avaje.jsonb.JsonbComponent
-
Register JsonAdapters with the Builder.
- result() - Method in interface io.avaje.jsonb.spi.BufferedJsonWriter
-
Return result as json string content.
- result() - Method in interface io.avaje.jsonb.spi.BytesJsonWriter
-
Return the json result as byte array.
S
- serialize() - Element in annotation type io.avaje.jsonb.Json.Ignore
-
Set this explicitly to true to include in serialization.
- serializeEmpty() - Method in interface io.avaje.jsonb.JsonWriter
-
Return true if empty collections should be serialised.
- serializeEmpty() - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- serializeEmpty(boolean) - Method in interface io.avaje.jsonb.Jsonb.Builder
-
Set to serialise empty collections or not.
- serializeEmpty(boolean) - Method in interface io.avaje.jsonb.JsonWriter
-
Set to serialise empty collections or not.
- serializeEmpty(boolean) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- serializeEmpty(boolean) - Method in class io.avaje.jsonb.stream.JsonStream.Builder
-
Set to true to serialize empty collections.
- serializeNulls() - Method in interface io.avaje.jsonb.JsonWriter
-
Return true if null values should be serialised.
- serializeNulls() - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- serializeNulls(boolean) - Method in interface io.avaje.jsonb.Jsonb.Builder
-
Set to serialise null values or not.
- serializeNulls(boolean) - Method in interface io.avaje.jsonb.JsonWriter
-
Set to serialise null values or not.
- serializeNulls(boolean) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- serializeNulls(boolean) - Method in class io.avaje.jsonb.stream.JsonStream.Builder
-
Set to true to serialize nulls.
- set() - Method in interface io.avaje.jsonb.JsonType
-
Return the set type for this JsonType.
- setOf(Type) - Static method in class io.avaje.jsonb.Types
-
Returns a Type that is a Set of the given element type.
- skipValue() - Method in interface io.avaje.jsonb.JsonReader
-
Skip the next value.
- stream() - Method in interface io.avaje.jsonb.JsonType
-
Prefer use of
JsonType.stream(JsonReader)
rather than using this stream type directly. - stream(JsonReader) - Method in interface io.avaje.jsonb.JsonType
-
Return as a Stream that will read the content as the stream is processed.
- streamArray(boolean) - Method in interface io.avaje.jsonb.JsonReader
-
Explicitly state if the streaming content contains ARRAY '[' and ']' tokens.
- streamOf(Type) - Static method in class io.avaje.jsonb.Types
-
Returns a Type that is a Stream of the given element type.
- STRING - Enum constant in enum io.avaje.jsonb.JsonReader.Token
-
A JSON string.
- subtypes() - Element in annotation type io.avaje.jsonb.Json.Import
-
Specify the Subtype information.
T
- toJson - Search tag in interface io.avaje.jsonb.JsonType
- Section
- toJson - Search tag in interface io.avaje.jsonb.Jsonb
- Section
- toJson - Search tag in package io.avaje.jsonb
- Section
- toJson(JsonWriter, T) - Method in interface io.avaje.jsonb.JsonAdapter
-
Write the value to the writer.
- toJson(Object) - Method in interface io.avaje.jsonb.Jsonb
-
Return json content for the given object.
- toJson(Object, JsonWriter) - Method in interface io.avaje.jsonb.Jsonb
-
Write to the given writer.
- toJson(Object, OutputStream) - Method in interface io.avaje.jsonb.Jsonb
-
Write to the given outputStream.
- toJson(Object, Writer) - Method in interface io.avaje.jsonb.Jsonb
-
Write to the given writer.
- toJson(T) - Method in interface io.avaje.jsonb.JsonView
-
Return as json string.
- toJson(T, JsonWriter) - Method in interface io.avaje.jsonb.JsonView
-
Write to the given writer.
- toJson(T, JsonOutput) - Method in interface io.avaje.jsonb.JsonView
-
Write to the given output.
- toJson(T, OutputStream) - Method in interface io.avaje.jsonb.JsonView
-
Write to the given outputStream.
- toJson(T, Writer) - Method in interface io.avaje.jsonb.JsonView
-
Write to the given writer.
- toJson() example - Search tag in io.avaje.jsonb.Jsonb.type(Class<T>)
- Section
- toJsonBytes(Object) - Method in interface io.avaje.jsonb.Jsonb
-
Return the value as json content in bytes form.
- toJsonBytes(T) - Method in interface io.avaje.jsonb.JsonView
-
Return the value as json content in bytes form.
- toJsonPretty(Object) - Method in interface io.avaje.jsonb.Jsonb
-
Return json content in pretty format for the given object.
- toJsonPretty(T) - Method in interface io.avaje.jsonb.JsonView
-
Return as json string in pretty format.
- type() - Element in annotation type io.avaje.jsonb.Json.SubType
-
The concrete type that extends or implements the base type.
- type(Class<T>) - Method in interface io.avaje.jsonb.Jsonb
-
Return the JsonType used to read and write json for the given class.
- type(Type) - Method in interface io.avaje.jsonb.Jsonb
-
Return the JsonType used to read and write json for the given type.
- typeArguments(Type) - Static method in class io.avaje.jsonb.Types
-
Return the generic type arguments expecting type to be a ParameterizedType.
- typeOf(Object) - Method in interface io.avaje.jsonb.Jsonb
-
Return the JsonType for the given value using the class of the value being passed in.
- typeProperty() - Element in annotation type io.avaje.jsonb.Json
-
When
@Json.SubType
is used this specifies the name of the property field that holds the type name (discriminator value). - Types - Class in io.avaje.jsonb
-
Factory methods for types.
U
- unmappedField(String) - Method in interface io.avaje.jsonb.JsonReader
-
Reading json with an unmapped field, throw an Exception if failOnUnmapped is true.
- unwrap(Class<T>) - Method in interface io.avaje.jsonb.JsonWriter
-
Unwrap the underlying generator being used.
- unwrap(Class<T>) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- unwrapOutputStream() - Method in interface io.avaje.jsonb.stream.JsonOutput
-
Return the underlying OutputStream.
- UpperCamel - Enum constant in enum io.avaje.jsonb.Json.Naming
- UpperHyphen - Enum constant in enum io.avaje.jsonb.Json.Naming
- UpperSpace - Enum constant in enum io.avaje.jsonb.Json.Naming
- UpperUnderscore - Enum constant in enum io.avaje.jsonb.Json.Naming
- Using Object.class - Search tag in io.avaje.jsonb.Jsonb.type(Class<T>)
- Section
- Using Object.class - Search tag in io.avaje.jsonb.Jsonb.type(Type)
- Section
V
- value() - Element in annotation type io.avaje.jsonb.Json.Alias
-
One or more secondary names to accept as aliases to the official name.
- value() - Element in annotation type io.avaje.jsonb.Json.Import.List
- value() - Element in annotation type io.avaje.jsonb.Json.Import
-
Specify types to generate Json Adapters for.
- value() - Element in annotation type io.avaje.jsonb.Json.JsonAlias
-
Deprecated.One or more secondary names to accept as aliases to the official name.
- value() - Element in annotation type io.avaje.jsonb.Json.MixIn
-
The concrete type to mix.
- value() - Element in annotation type io.avaje.jsonb.Json.Property
-
Specify the name for this property.
- value() - Element in annotation type io.avaje.jsonb.Json.SubTypes
- value() - Element in annotation type io.avaje.jsonb.spi.Generated
-
The name of the generator used to generate this source.
- value() - Element in annotation type io.avaje.jsonb.spi.MetaData.Factory
-
The generated JsonAdapters that have a factory.
- value() - Element in annotation type io.avaje.jsonb.spi.MetaData
-
The generated JsonAdapters.
- value(boolean) - Method in interface io.avaje.jsonb.JsonWriter
-
Write a boolean value.
- value(boolean) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- value(byte[]) - Method in interface io.avaje.jsonb.JsonWriter
-
Write binary content as base64.
- value(byte[]) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- value(double) - Method in interface io.avaje.jsonb.JsonWriter
-
Write a double value.
- value(double) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- value(int) - Method in interface io.avaje.jsonb.JsonWriter
-
Write an int value.
- value(int) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- value(long) - Method in interface io.avaje.jsonb.JsonWriter
-
Write a long value.
- value(long) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- value(Boolean) - Method in interface io.avaje.jsonb.JsonWriter
-
Write a Boolean value.
- value(Boolean) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- value(Double) - Method in interface io.avaje.jsonb.JsonWriter
-
Write a Double value.
- value(Double) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- value(Integer) - Method in interface io.avaje.jsonb.JsonWriter
-
Write an Integer value.
- value(Integer) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- value(Long) - Method in interface io.avaje.jsonb.JsonWriter
-
Write a Long value.
- value(Long) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- value(String) - Method in interface io.avaje.jsonb.JsonWriter
-
Write a string value.
- value(String) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- value(BigDecimal) - Method in interface io.avaje.jsonb.JsonWriter
-
Write a BigDecimal value.
- value(BigDecimal) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- value(BigInteger) - Method in interface io.avaje.jsonb.JsonWriter
-
Write a BigInteger value.
- value(BigInteger) - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- valueOf(String) - Static method in enum io.avaje.jsonb.Json.Naming
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.avaje.jsonb.JsonReader.Token
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum io.avaje.jsonb.Json.Naming
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.avaje.jsonb.JsonReader.Token
-
Returns an array containing the constants of this enum type, in the order they are declared.
- view(String) - Method in interface io.avaje.jsonb.JsonType
-
Build and return the view given the DSL that specifies the properties to include.
- viewBuild() - Method in interface io.avaje.jsonb.JsonAdapter
-
Return the ViewBuilder.Aware for this adapter.
- ViewBuilder - Interface in io.avaje.jsonb.spi
-
Builds a JsonView.
- ViewBuilderAware - Interface in io.avaje.jsonb.spi
-
A (non-scalar) JsonAdapter that is part of building json views.
W
- When using Jackson - Search tag in io.avaje.jsonb.JsonType.stream(JsonReader)
- Section
- write(byte[], int, int) - Method in interface io.avaje.jsonb.stream.JsonOutput
-
Write the content to the underlying output stream.
- writeLast(byte[], int, int) - Method in interface io.avaje.jsonb.stream.JsonOutput
-
Write the last content to the underlying output stream.
- writeNewLine() - Method in interface io.avaje.jsonb.JsonWriter
-
Write new line characters typically for
x-json-stream
content. - writeNewLine() - Method in class io.avaje.jsonb.spi.DelegateJsonWriter
- writer(JsonOutput) - Method in interface io.avaje.jsonb.Jsonb
-
Return the JsonWriter used to write json to the given output.
- writer(JsonOutput) - Method in interface io.avaje.jsonb.spi.JsonStreamAdapter
-
Return the JsonWriter given the output.
- writer(JsonOutput) - Method in class io.avaje.jsonb.stream.JsonStream
- writer(OutputStream) - Method in interface io.avaje.jsonb.Jsonb
-
Return the JsonWriter used to write json to the given outputStream.
- writer(OutputStream) - Method in interface io.avaje.jsonb.spi.JsonStreamAdapter
-
Return the JsonWriter given the outputStream.
- writer(OutputStream) - Method in class io.avaje.jsonb.stream.JsonStream
- writer(Writer) - Method in interface io.avaje.jsonb.Jsonb
-
Return the JsonWriter used to write json to the given writer.
- writer(Writer) - Method in interface io.avaje.jsonb.spi.JsonStreamAdapter
-
Return the JsonWriter given writer to use.
- writer(Writer) - Method in class io.avaje.jsonb.stream.JsonStream
All Classes and Interfaces|All Packages|Serialized Form
Json.Alias
.