Index (nestedtext-min-java 0.5.1 API)

A B C D E F G H I N O R S T
All Classes and Interfaces|All Packages|Serialized Form

A

as(Class<T>) - Method in class org.loxlylabs.nestedtext.NestedText.Reader: Completes the deserialization by converting the parsed data into the specified type.
as(TypeReference<T>) - Method in class org.loxlylabs.nestedtext.NestedText.Reader: Completes the deserialization by converting the parsed data into the specified generic type.
asObject() - Method in class org.loxlylabs.nestedtext.NestedText.Reader: Returns the raw, untyped result of the parsing operation (a Map, List, or String).

B

build() - Method in class org.loxlylabs.nestedtext.NestedText.Builder: Builds an immutable NestedText instance with the configured settings.
builder() - Static method in class org.loxlylabs.nestedtext.NestedText: Create a new NestedText Builder

C

convert(Object, Class<T>) - Method in class org.loxlylabs.nestedtext.DeserializationContext: Converts a source object graph into an instance of a specified non-generic target class.
convert(Object, TypeReference<T>) - Method in class org.loxlylabs.nestedtext.DeserializationContext: Converts a source object graph into an instance of a specified generic target class.

D

DeserializationContext - Class in org.loxlylabs.nestedtext: Provides context for a deserialization operation and serves as the main entry point for data binding.
DeserializationContext(Map<Class<?>, Deserializer<?>>, Map<Class<?>, TypeMappingRules>) - Constructor for class org.loxlylabs.nestedtext.DeserializationContext: Creates a new context with the given custom deserializers.
DeserializationContext(Map<Class<?>, TypeMappingRules>) - Constructor for class org.loxlylabs.nestedtext.DeserializationContext: Creates a new context with no custom deserializers.
DeserializationException - Exception Class in org.loxlylabs.nestedtext: An exception that may be thrown when binding to a Java type.
deserialize(Object, DeserializationContext) - Method in interface org.loxlylabs.nestedtext.Deserializer: Converts a NestedText-compatible object into a Java object of type T.
Deserializer<T> - Interface in org.loxlylabs.nestedtext: Defines a custom strategy for deserializing a List, String, or Map into a specific Java type T.
dump(Object) - Method in class org.loxlylabs.nestedtext.NestedText: Dumps (serializes) a Java object into a NestedText formatted string.
dump(Object) - Static method in class org.loxlylabs.nestedtext.NestedTexts: Dumps an object to a NestedText string using default settings.
dump(Object, DumpOptions) - Method in class org.loxlylabs.nestedtext.NestedText: Dumps (serializes) a Java object into a NestedText formatted string.
DumpOptions - Record Class in org.loxlylabs.nestedtext: Options to use when dumping an Object to Minimal NestedText
DumpOptions(String, int) - Constructor for record class org.loxlylabs.nestedtext.DumpOptions: Creates an instance of a DumpOptions record class.

E

endOfLine(String) - Method in class org.loxlylabs.nestedtext.NestedText.Builder: Configures default end of line separator to use when dumping NestedText
eol() - Method in record class org.loxlylabs.nestedtext.DumpOptions: Returns the value of the eol record component.
equals(Object) - Method in record class org.loxlylabs.nestedtext.DumpOptions: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.loxlylabs.nestedtext.TypeMappingRules: Indicates whether some other object is "equal to" this one.

F

fieldsToIgnore() - Method in record class org.loxlylabs.nestedtext.TypeMappingRules: Returns the value of the fieldsToIgnore record component.
fieldsToIgnoreWhenNull() - Method in record class org.loxlylabs.nestedtext.TypeMappingRules: Returns the value of the fieldsToIgnoreWhenNull record component.
forType(Class<T>, Consumer<NestedText.TypeConfiguration<T>>) - Method in class org.loxlylabs.nestedtext.NestedText.Builder: Provides a fluent API for configuring serialization and deserialization rules for a specific class without modifying the class itself.
from(byte[]) - Method in class org.loxlylabs.nestedtext.NestedText: Loads (parses) NestedText content from a byte array.
from(byte[]) - Static method in class org.loxlylabs.nestedtext.NestedTexts: Begins a fluent deserialization operation from a byte[] source.
from(String) - Method in class org.loxlylabs.nestedtext.NestedText: Loads (parses) NestedText content from a string.
from(String) - Static method in class org.loxlylabs.nestedtext.NestedTexts: Begins a fluent deserialization operation from a String source.
from(Path) - Method in class org.loxlylabs.nestedtext.NestedText: Loads (parses) NestedText content from a path.
from(Path) - Static method in class org.loxlylabs.nestedtext.NestedTexts: Begins a fluent deserialization operation from a Path source.

G

getColumn() - Method in exception class org.loxlylabs.nestedtext.NestedTextException: Gets the column number where the parsing error occurred.
getLine() - Method in exception class org.loxlylabs.nestedtext.NestedTextException: Gets the line number where the parsing error occurred.
getType() - Method in class org.loxlylabs.nestedtext.TypeReference: Returns the generic Type.

H

hashCode() - Method in record class org.loxlylabs.nestedtext.DumpOptions: Returns a hash code value for this object.
hashCode() - Method in record class org.loxlylabs.nestedtext.TypeMappingRules: Returns a hash code value for this object.

I

ignoreField(String) - Method in class org.loxlylabs.nestedtext.NestedText.TypeConfiguration: Specifies a field to be ignored during serialization and deserialization.
ignoreFieldWhenNull(String) - Method in class org.loxlylabs.nestedtext.NestedText.TypeConfiguration: Specifies a field to be ignored during serialization when the value is null.
indentAmount() - Method in record class org.loxlylabs.nestedtext.DumpOptions: Returns the value of the indentAmount record component.
indentAmount(int) - Method in class org.loxlylabs.nestedtext.NestedText.Builder: Configures default indentation to use when dumping NestedText

N

NestedText - Class in org.loxlylabs.nestedtext: The main class for loading and dumping NestedText data.
NestedText.Builder - Class in org.loxlylabs.nestedtext: A builder class to assist in creating NestedText instances.
NestedText.Reader - Class in org.loxlylabs.nestedtext: An intermediate object used to specify the target type for the parsed NestedText data.
NestedText.Renamer - Class in org.loxlylabs.nestedtext: Helper class to complete the renameField operation.
NestedText.TypeConfiguration<T> - Class in org.loxlylabs.nestedtext: Provides a fluent API for configuring type-specific mapping rules.
NestedTextException - Exception Class in org.loxlylabs.nestedtext: The unified exception for all errors that occur within the NestedText library.
NestedTexts - Class in org.loxlylabs.nestedtext: Utility class to serialize or deserialize with default configuration.

O

org.loxlylabs.nestedtext - package org.loxlylabs.nestedtext

R

registerDeserializer(Class<T>, Deserializer<T>) - Method in class org.loxlylabs.nestedtext.NestedText.Builder: Registers a custom deserializer for deserializing a value to specific class.
registerSerializer(Class<T>, Serializer<T>) - Method in class org.loxlylabs.nestedtext.NestedText.Builder: Registers a custom serializer for serializing a specific class to a NestedText-compatible format.
renameField(String) - Method in class org.loxlylabs.nestedtext.NestedText.TypeConfiguration: Specifies a new name for a field during serialization and deserialization.
renameFromJava() - Method in record class org.loxlylabs.nestedtext.TypeMappingRules: Returns the value of the renameFromJava record component.
renameTo() - Method in record class org.loxlylabs.nestedtext.TypeMappingRules: Returns the value of the renameTo record component.

S

serialize(T) - Method in interface org.loxlylabs.nestedtext.Serializer: Converts a given value of type T into a NestedText-compatible object.
Serializer<T> - Interface in org.loxlylabs.nestedtext: A functional interface for providing a custom serialization strategy for a specific class.

T

to(String) - Method in class org.loxlylabs.nestedtext.NestedText.Renamer: Sets the target name for the field in the NestedText document.
toString() - Method in record class org.loxlylabs.nestedtext.DumpOptions: Returns a string representation of this record class.
toString() - Method in record class org.loxlylabs.nestedtext.TypeMappingRules: Returns a string representation of this record class.
TypeMappingRules - Record Class in org.loxlylabs.nestedtext: Contains the type level rules for serialization / deserialization.
TypeMappingRules() - Constructor for record class org.loxlylabs.nestedtext.TypeMappingRules: Creates a new TypeMappingRules object initializing all fields with empty collections.
TypeMappingRules(Map<String, String>, Map<String, String>, Set<String>, Set<String>) - Constructor for record class org.loxlylabs.nestedtext.TypeMappingRules: Creates a new TypeMappingRules ensuring all arguments are non-null.
TypeReference<T> - Class in org.loxlylabs.nestedtext: Used for serializing NestedText to a List<T> or a Map<K,V>
TypeReference() - Constructor for class org.loxlylabs.nestedtext.TypeReference: Constructor which captures the generic type.

A B C D E F G H I N O R S T
All Classes and Interfaces|All Packages|Serialized Form