Index

A B C D E F G H I J K L M N O P Q S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

A

Architecture - Section in package dev.toonformat.jtoon

Architecture Benefits - Section in package dev.toonformat.jtoon.decoder

Architecture Benefits - Section in package dev.toonformat.jtoon.encoder

ArrayDecoder - Section in package dev.toonformat.jtoon.decoder

ArrayEncoder - Section in package dev.toonformat.jtoon.encoder

ArrayEncoder - Class in dev.toonformat.jtoon.encoder

Handles encoding of JSON arrays to TOON format.

Array Format Detection - Section in package dev.toonformat.jtoon.decoder

B

BACKSLASH - Static variable in class dev.toonformat.jtoon.util.Constants

Backslash escape character.

Basic Encoding - Section in package dev.toonformat.jtoon

C

CLOSE_BRACE - Static variable in class dev.toonformat.jtoon.util.Constants

Closing brace character for objects.

CLOSE_BRACKET - Static variable in class dev.toonformat.jtoon.util.Constants

Closing bracket character for arrays.

COLON - Static variable in class dev.toonformat.jtoon.util.Constants

Colon separator character used in key-value pairs.

COMMA - Enum constant in enum class dev.toonformat.jtoon.Delimiter

Comma delimiter (,) - default option

COMMA - Static variable in class dev.toonformat.jtoon.util.Constants

Comma delimiter character.

Constants - Section in package dev.toonformat.jtoon.util

Constants - Class in dev.toonformat.jtoon.util

Constants used throughout the JToon encoding process.

Core Component - Section in package dev.toonformat.jtoon.normalizer

Core Components - Section in package dev.toonformat.jtoon

Core Components - Section in package dev.toonformat.jtoon.decoder

Core Components - Section in package dev.toonformat.jtoon.encoder

Core Components - Section in package dev.toonformat.jtoon.util

Custom Options - Section in package dev.toonformat.jtoon

D

decode(String) - Static method in class dev.toonformat.jtoon.JToon

Decodes a TOON-formatted string to Java objects using default options.

decode(String, DecodeOptions) - Static method in class dev.toonformat.jtoon.decoder.ValueDecoder

Decodes a TOON-formatted string to a Java object.

decode(String, DecodeOptions) - Static method in class dev.toonformat.jtoon.JToon

Decodes a TOON-formatted string to Java objects using custom options.

DecodeOptions - Record Class in dev.toonformat.jtoon

Configuration options for decoding TOON format to Java objects.

DecodeOptions() - Constructor for record class dev.toonformat.jtoon.DecodeOptions

Creates DecodeOptions with default values.

DecodeOptions(int, Delimiter, boolean, PathExpansion) - Constructor for record class dev.toonformat.jtoon.DecodeOptions

Creates an instance of a DecodeOptions record class.

decodeToJson(String) - Static method in class dev.toonformat.jtoon.JToon

Decodes a TOON-formatted string directly to a JSON string using default options.

decodeToJson(String, DecodeOptions) - Static method in class dev.toonformat.jtoon.decoder.ValueDecoder

Decodes a TOON-formatted string directly to a JSON string using custom options.

decodeToJson(String, DecodeOptions) - Static method in class dev.toonformat.jtoon.JToon

Decodes a TOON-formatted string directly to a JSON string using custom options.

Decoding Process - Section in package dev.toonformat.jtoon.decoder

DEFAULT - Static variable in record class dev.toonformat.jtoon.DecodeOptions

Default decoding options: 2 spaces indent, comma delimiter, strict validation, path expansion off

DEFAULT - Static variable in record class dev.toonformat.jtoon.EncodeOptions

Default encoding options: 2 spaces indent, comma delimiter, no length marker

delimiter() - Method in record class dev.toonformat.jtoon.DecodeOptions

Returns the value of the delimiter record component.

delimiter() - Method in record class dev.toonformat.jtoon.EncodeOptions

Returns the value of the delimiter record component.

delimiter() - Method in record class dev.toonformat.jtoon.encoder.HeaderFormatter.HeaderConfig

Returns the value of the delimiter record component.

Delimiter - Enum Class in dev.toonformat.jtoon

Delimiter options for tabular array rows and inline primitive arrays.

Delimiter Awareness - Section in package dev.toonformat.jtoon.decoder

Delimiter-Aware Validation - Section in package dev.toonformat.jtoon.util

Delimiter Options - Section in package dev.toonformat.jtoon

Delimiter Parsing - Section in package dev.toonformat.jtoon.decoder

Delimiter Support - Section in package dev.toonformat.jtoon.encoder

Depth Tracking - Section in package dev.toonformat.jtoon.decoder

Design Principles - Section in package dev.toonformat.jtoon

Design Principles - Section in package dev.toonformat.jtoon.normalizer

Design Principles - Section in package dev.toonformat.jtoon.util

detectTabularHeader(ArrayNode) - Static method in class dev.toonformat.jtoon.encoder.TabularArrayEncoder

Detects if an array can be encoded in tabular format.

dev.toonformat.jtoon - package dev.toonformat.jtoon

JToon - Token-Oriented Object Notation encoder for Java.

dev.toonformat.jtoon.decoder - package dev.toonformat.jtoon.decoder

Decoding engine for converting TOON format to Java objects.

dev.toonformat.jtoon.encoder - package dev.toonformat.jtoon.encoder

Encoding engine for converting normalized JsonNode values to TOON format.

dev.toonformat.jtoon.normalizer - package dev.toonformat.jtoon.normalizer

Java object normalization to Jackson JsonNode representation.

dev.toonformat.jtoon.util - package dev.toonformat.jtoon.util

Utility classes for string validation, escaping, and shared constants.

DOUBLE_QUOTE - Static variable in class dev.toonformat.jtoon.util.Constants

Double quote character used for string literals.

E

encode(Object) - Static method in class dev.toonformat.jtoon.JToon

Encodes a Java object to JToon format using default options.

encode(Object, EncodeOptions) - Static method in class dev.toonformat.jtoon.JToon

Encodes a Java object to JToon format using custom options.

encodeArray(String, ArrayNode, LineWriter, int, EncodeOptions) - Static method in class dev.toonformat.jtoon.encoder.ArrayEncoder

Main entry point for array encoding.

encodeArrayOfObjectsAsTabular(String, ArrayNode, List, LineWriter, int, EncodeOptions) - Static method in class dev.toonformat.jtoon.encoder.TabularArrayEncoder

Encodes an array of objects as a tabular structure.

encodeJson(String) - Static method in class dev.toonformat.jtoon.JToon

Encodes a plain JSON string to TOON format using default options.

encodeJson(String, EncodeOptions) - Static method in class dev.toonformat.jtoon.JToon

Encodes a plain JSON string to TOON format using custom options.

encodeKey(String) - Static method in class dev.toonformat.jtoon.encoder.PrimitiveEncoder

Encodes an object key, quoting if necessary.

encodeKeyValuePair(String, JsonNode, LineWriter, int, EncodeOptions) - Static method in class dev.toonformat.jtoon.encoder.ObjectEncoder

Encodes a key-value pair in an object.

encodeObject(ObjectNode, LineWriter, int, EncodeOptions) - Static method in class dev.toonformat.jtoon.encoder.ObjectEncoder

Encodes an ObjectNode to TOON format.

encodeObjectAsListItem(ObjectNode, LineWriter, int, EncodeOptions) - Static method in class dev.toonformat.jtoon.encoder.ListItemEncoder

Encodes an object as a list item.

EncodeOptions - Record Class in dev.toonformat.jtoon

Configuration options for encoding data to JToon format.

EncodeOptions() - Constructor for record class dev.toonformat.jtoon.EncodeOptions

Creates EncodeOptions with default values.

EncodeOptions(int, Delimiter, boolean) - Constructor for record class dev.toonformat.jtoon.EncodeOptions

Creates an instance of a EncodeOptions record class.

encodePrimitive(JsonNode, String) - Static method in class dev.toonformat.jtoon.encoder.PrimitiveEncoder

Encodes a primitive JsonNode value.

encodeStringLiteral(String, String) - Static method in class dev.toonformat.jtoon.encoder.PrimitiveEncoder

Encodes a string literal, quoting if necessary.

encodeValue(JsonNode, EncodeOptions) - Static method in class dev.toonformat.jtoon.encoder.ValueEncoder

Encodes a normalized JsonNode value to TOON format.

Encoding Pipeline - Section in package dev.toonformat.jtoon

Encoding Pipeline - Section in package dev.toonformat.jtoon

Encoding Process - Section in package dev.toonformat.jtoon.encoder

equals(Object) - Method in record class dev.toonformat.jtoon.DecodeOptions

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class dev.toonformat.jtoon.EncodeOptions

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class dev.toonformat.jtoon.encoder.HeaderFormatter.HeaderConfig

Indicates whether some other object is "equal to" this one.

Error Handling - Section in package dev.toonformat.jtoon.decoder

escape(String) - Static method in class dev.toonformat.jtoon.util.StringEscaper

Escapes special characters in a string.

Escaped Strings - Section in package dev.toonformat.jtoon.decoder

Example: - Section in package dev.toonformat.jtoon.util

expandPaths() - Method in record class dev.toonformat.jtoon.DecodeOptions

Returns the value of the expandPaths record component.

F

FALSE_LITERAL - Static variable in class dev.toonformat.jtoon.util.Constants

String representation of boolean false value.

fields() - Method in record class dev.toonformat.jtoon.encoder.HeaderFormatter.HeaderConfig

Returns the value of the fields record component.

format(int, String, List, String, boolean) - Static method in class dev.toonformat.jtoon.encoder.HeaderFormatter

Legacy method for backward compatibility.

format(HeaderFormatter.HeaderConfig) - Static method in class dev.toonformat.jtoon.encoder.HeaderFormatter

Formats a header for arrays and tables.

Format Features - Section in package dev.toonformat.jtoon

formatHeader(int, String, List, String, boolean) - Static method in class dev.toonformat.jtoon.encoder.PrimitiveEncoder

Formats a header for arrays and tables.

formatInlineArray(ArrayNode, String, String, boolean) - Static method in class dev.toonformat.jtoon.encoder.ArrayEncoder

Formats an inline primitive array with header and values.

G

getValue() - Method in enum class dev.toonformat.jtoon.Delimiter

Returns the string representation of this delimiter.

Graceful Degradation - Section in package dev.toonformat.jtoon.normalizer

H

hashCode() - Method in record class dev.toonformat.jtoon.DecodeOptions

Returns a hash code value for this object.

hashCode() - Method in record class dev.toonformat.jtoon.EncodeOptions

Returns a hash code value for this object.

hashCode() - Method in record class dev.toonformat.jtoon.encoder.HeaderFormatter.HeaderConfig

Returns a hash code value for this object.

HeaderConfig(int, String, List, String, boolean) - Constructor for record class dev.toonformat.jtoon.encoder.HeaderFormatter.HeaderConfig

Creates an instance of a HeaderConfig record class.

HeaderFormatter - Section in package dev.toonformat.jtoon.encoder

HeaderFormatter - Class in dev.toonformat.jtoon.encoder

Formats headers for arrays and tables in TOON format.

HeaderFormatter.HeaderConfig - Record Class in dev.toonformat.jtoon.encoder

Configuration for header formatting.

I

indent() - Method in record class dev.toonformat.jtoon.DecodeOptions

Returns the value of the indent record component.

indent() - Method in record class dev.toonformat.jtoon.EncodeOptions

Returns the value of the indent record component.

Indentation-Based Structure - Section in package dev.toonformat.jtoon

isArrayOfArrays(JsonNode) - Static method in class dev.toonformat.jtoon.encoder.ArrayEncoder

Checks if an array contains only arrays.

isArrayOfObjects(JsonNode) - Static method in class dev.toonformat.jtoon.encoder.ArrayEncoder

Checks if an array contains only objects.

isArrayOfPrimitives(JsonNode) - Static method in class dev.toonformat.jtoon.encoder.ArrayEncoder

Checks if an array contains only primitive values.

isSafeUnquoted(String, String) - Static method in class dev.toonformat.jtoon.util.StringValidator

Checks if a string can be safely written without quotes.

isValidUnquotedKey(String) - Static method in class dev.toonformat.jtoon.util.StringValidator

Checks if a key can be used without quotes.

J

joinEncodedValues(List, String) - Static method in class dev.toonformat.jtoon.encoder.PrimitiveEncoder

Joins encoded primitive values with the specified delimiter.

JsonNormalizer - Section in package dev.toonformat.jtoon.normalizer

JsonNormalizer - Class in dev.toonformat.jtoon.normalizer

Normalizes Java objects to Jackson JsonNode representation.

JToon - Class in dev.toonformat.jtoon

Main entry point for encoding and decoding TOON (Token-Oriented Object Notation) format.

K

key() - Method in record class dev.toonformat.jtoon.encoder.HeaderFormatter.HeaderConfig

Returns the value of the key record component.

L

length() - Method in record class dev.toonformat.jtoon.encoder.HeaderFormatter.HeaderConfig

Returns the value of the length record component.

lengthMarker() - Method in record class dev.toonformat.jtoon.EncodeOptions

Returns the value of the lengthMarker record component.

lengthMarker() - Method in record class dev.toonformat.jtoon.encoder.HeaderFormatter.HeaderConfig

Returns the value of the lengthMarker record component.

Length Markers - Section in package dev.toonformat.jtoon

Lenient Mode - Section in package dev.toonformat.jtoon.decoder

LineWriter - Section in package dev.toonformat.jtoon.encoder

LineWriter - Class in dev.toonformat.jtoon.encoder

Line writer that accumulates indented lines for building the final output.

LineWriter(int) - Constructor for class dev.toonformat.jtoon.encoder.LineWriter

Creates a LineWriter with the specified indentation size.

LIST_ITEM_MARKER - Static variable in class dev.toonformat.jtoon.util.Constants

Marker used to indicate list items in TOON format.

LIST_ITEM_PREFIX - Static variable in class dev.toonformat.jtoon.util.Constants

Prefix used for list items in TOON format.

List Arrays - Section in package dev.toonformat.jtoon.decoder

ListItemEncoder - Section in package dev.toonformat.jtoon.encoder

ListItemEncoder - Class in dev.toonformat.jtoon.encoder

Handles encoding of objects as list items in non-uniform arrays.

LLM-Safe Output - Section in package dev.toonformat.jtoon.normalizer

M

Maintainability - Section in package dev.toonformat.jtoon.decoder

Maintainability - Section in package dev.toonformat.jtoon.encoder

MAPPER - Static variable in class dev.toonformat.jtoon.normalizer.JsonNormalizer

Shared ObjectMapper instance configured for JSON normalization.

N

normalize(Object) - Static method in class dev.toonformat.jtoon.normalizer.JsonNormalizer

Normalizes any Java object to a JsonNode.

NULL_LITERAL - Static variable in class dev.toonformat.jtoon.util.Constants

String representation of null value.

Number Normalization - Section in package dev.toonformat.jtoon.normalizer

O

ObjectDecoder - Section in package dev.toonformat.jtoon.decoder

ObjectEncoder - Section in package dev.toonformat.jtoon.encoder

ObjectEncoder - Class in dev.toonformat.jtoon.encoder

Handles encoding of JSON objects to TOON format.

OFF - Enum constant in enum class dev.toonformat.jtoon.PathExpansion

Off mode: treats dotted keys as literal keys.

OPEN_BRACE - Static variable in class dev.toonformat.jtoon.util.Constants

Opening brace character for objects.

OPEN_BRACKET - Static variable in class dev.toonformat.jtoon.util.Constants

Opening bracket character for arrays.

Overview - Section in package dev.toonformat.jtoon

Overview - Section in package dev.toonformat.jtoon.decoder

Overview - Section in package dev.toonformat.jtoon.encoder

Overview - Section in package dev.toonformat.jtoon.normalizer

Overview - Section in package dev.toonformat.jtoon.util

P

parse(String) - Static method in class dev.toonformat.jtoon.normalizer.JsonNormalizer

Parses a JSON string into a JsonNode using the shared ObjectMapper.

Parsing Strategy - Section in package dev.toonformat.jtoon.decoder

Parsing Strategy: - Section in class dev.toonformat.jtoon.decoder.ValueDecoder

PathExpansion - Enum Class in dev.toonformat.jtoon

Path expansion mode for decoding dotted keys.

Pattern Matching - Section in package dev.toonformat.jtoon.decoder

Performance Considerations - Section in package dev.toonformat.jtoon

Performance Optimization - Section in package dev.toonformat.jtoon.util

PIPE - Enum constant in enum class dev.toonformat.jtoon.Delimiter

Pipe delimiter (|)

Primitive Arrays - Section in package dev.toonformat.jtoon.decoder

PrimitiveDecoder - Section in package dev.toonformat.jtoon.decoder

PrimitiveEncoder - Section in package dev.toonformat.jtoon.encoder

PrimitiveEncoder - Class in dev.toonformat.jtoon.encoder

Encodes primitive values and object keys for TOON format.

Public API - Section in package dev.toonformat.jtoon

push(int, String) - Method in class dev.toonformat.jtoon.encoder.LineWriter

Adds a line with the specified depth and content.

Q

Quoted Keys - Section in package dev.toonformat.jtoon.decoder

S

SAFE - Enum constant in enum class dev.toonformat.jtoon.PathExpansion

Safe mode: expands dotted keys like "a.b.c" into nested objects.

See Also - Section in package dev.toonformat.jtoon

Single Responsibility - Section in package dev.toonformat.jtoon.decoder

Single Responsibility - Section in package dev.toonformat.jtoon.encoder

Smart Quoting - Section in package dev.toonformat.jtoon

SPACE - Static variable in class dev.toonformat.jtoon.util.Constants

Space character.

Special Java Types - Section in package dev.toonformat.jtoon.normalizer

Special Parsing Cases - Section in package dev.toonformat.jtoon.decoder

strict() - Method in record class dev.toonformat.jtoon.DecodeOptions

Returns the value of the strict record component.

Strict Mode (default) - Section in package dev.toonformat.jtoon.decoder

StringEscaper - Section in package dev.toonformat.jtoon.util

StringEscaper - Class in dev.toonformat.jtoon.util

Handles string escaping for TOON format.

StringValidator - Section in package dev.toonformat.jtoon.util

StringValidator - Class in dev.toonformat.jtoon.util

Validates strings for safe unquoted usage in TOON format.

T

TAB - Enum constant in enum class dev.toonformat.jtoon.Delimiter

Tab delimiter (\t)

TabularArrayEncoder - Section in package dev.toonformat.jtoon.encoder

TabularArrayEncoder - Class in dev.toonformat.jtoon.encoder

Detects and encodes uniform arrays of objects in efficient tabular format.

Tabular Arrays - Section in package dev.toonformat.jtoon

Tabular Arrays - Section in package dev.toonformat.jtoon

Tabular Arrays - Section in package dev.toonformat.jtoon.decoder

Tabular Format Optimization - Section in package dev.toonformat.jtoon.encoder

Temporal Types - Section in package dev.toonformat.jtoon.normalizer

Testing - Section in package dev.toonformat.jtoon.util

Thread Safety - Section in package dev.toonformat.jtoon

Thread Safety - Section in package dev.toonformat.jtoon.normalizer

Thread Safety - Section in package dev.toonformat.jtoon.util

toString() - Method in record class dev.toonformat.jtoon.DecodeOptions

Returns a string representation of this record class.

toString() - Method in enum class dev.toonformat.jtoon.Delimiter

toString() - Method in record class dev.toonformat.jtoon.EncodeOptions

Returns a string representation of this record class.

toString() - Method in record class dev.toonformat.jtoon.encoder.HeaderFormatter.HeaderConfig

Returns a string representation of this record class.

toString() - Method in class dev.toonformat.jtoon.encoder.LineWriter

Joins all accumulated lines with newlines.

TRUE_LITERAL - Static variable in class dev.toonformat.jtoon.util.Constants

String representation of boolean true value.

Type Conversions - Section in package dev.toonformat.jtoon

Type Conversions - Section in package dev.toonformat.jtoon.normalizer

U

unescape(String) - Static method in class dev.toonformat.jtoon.util.StringEscaper

Unescapes a string and removes surrounding quotes if present.

Usage Example - Section in package dev.toonformat.jtoon.normalizer

Usage Examples - Section in package dev.toonformat.jtoon

Utility Classes - Section in package dev.toonformat.jtoon

Utility Class Pattern - Section in package dev.toonformat.jtoon.util

V

validateString(String) - Static method in class dev.toonformat.jtoon.util.StringEscaper

Validates a quoted string for invalid escape sequences and unterminated strings.

ValueDecoder - Section in package dev.toonformat.jtoon.decoder

ValueDecoder - Class in dev.toonformat.jtoon.decoder

Main decoder for converting TOON-formatted strings to Java objects.

ValueEncoder - Section in package dev.toonformat.jtoon.encoder

ValueEncoder - Class in dev.toonformat.jtoon.encoder

Core encoding orchestrator for converting JsonNode values to TOON format.

valueOf(String) - Static method in enum class dev.toonformat.jtoon.Delimiter

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class dev.toonformat.jtoon.PathExpansion

Returns the enum constant of this class with the specified name.

values() - Static method in enum class dev.toonformat.jtoon.Delimiter

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

values() - Static method in enum class dev.toonformat.jtoon.PathExpansion

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

W

withDelimiter(Delimiter) - Static method in record class dev.toonformat.jtoon.DecodeOptions

Creates DecodeOptions with custom delimiter, using default indent and strict mode.

withDelimiter(Delimiter) - Static method in record class dev.toonformat.jtoon.EncodeOptions

Creates EncodeOptions with custom delimiter, using default indent and length marker.

withIndent(int) - Static method in record class dev.toonformat.jtoon.DecodeOptions

Creates DecodeOptions with custom indent, using default delimiter and strict mode.

withIndent(int) - Static method in record class dev.toonformat.jtoon.EncodeOptions

Creates EncodeOptions with custom indent, using default delimiter and length marker.

withLengthMarker(boolean) - Static method in record class dev.toonformat.jtoon.EncodeOptions

Creates EncodeOptions with custom length marker, using default indent and delimiter.

withStrict(boolean) - Static method in record class dev.toonformat.jtoon.DecodeOptions

Creates DecodeOptions with custom strict mode, using default indent and delimiter.

writeTabularRows(ArrayNode, List, LineWriter, int, EncodeOptions) - Static method in class dev.toonformat.jtoon.encoder.TabularArrayEncoder

Writes rows of tabular data by extracting values in header order.

A B C D E F G H I J K L M N O P Q S T U V W
All Classes and Interfaces|All Packages|Constant Field Values