net.openhft.chronicle.wire

Class JSONWire

java.lang.Object

net.openhft.chronicle.wire.AbstractWire

net.openhft.chronicle.wire.YamlWireOut<TextWire>

net.openhft.chronicle.wire.TextWire

net.openhft.chronicle.wire.JSONWire

All Implemented Interfaces:

DocumentWritten, MarshallableIn, MarshallableOut, RollbackIfNotCompleteNotifier, Wire, WireCommon, WireIn, WireOut

public class JSONWire
extends TextWire

Represents the JSON wire format.

This class provides functionality for managing JSON data in a wire format. It currently provides a subset of functionalities similar to the YAML wire format. The core capability of this class is to handle JSON data structures as Bytes objects, allowing for efficient manipulation and parsing.

Nested Class Summary

Nested classes/interfaces inherited from class net.openhft.chronicle.wire.TextWire

TextWire.TextValueIn

Nested classes/interfaces inherited from interface net.openhft.chronicle.wire.WireIn

WireIn.HeaderType

Nested classes/interfaces inherited from interface net.openhft.chronicle.wire.WireOut

WireOut.EndOfWire

Field Summary

Fields

Modifier and Type	Field and Description
static @NotNull net.openhft.chronicle.bytes.Bytes<byte[]>	ULL Deprecated.

Fields inherited from class net.openhft.chronicle.wire.TextWire

BINARY, lineStart, readContext, TYPE_STR, valueIn, writeContext

Fields inherited from class net.openhft.chronicle.wire.YamlWireOut

sb, TYPE, valueOut

Fields inherited from class net.openhft.chronicle.wire.AbstractWire

bytes, classLookup, commentListener, DEFAULT_USE_PADDING, parent, use8bit

Fields inherited from interface net.openhft.chronicle.wire.MarshallableIn

MARSHALLABLE_IN_INTERN_SIZE

Constructor Summary

Constructors

Constructor and Description
JSONWire() Default constructor, initializes with elastic bytes allocated on heap.
JSONWire(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes) Constructs a JSONWire with the given bytes.
JSONWire(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, boolean use8bit) Constructs a JSONWire with the given bytes and a flag for using 8-bit.

Method Summary

Modifier and Type	Method and Description
static String	asText(@NotNull Wire wire) Converts the content of the provided wire to a JSON string.
void	copyOne(@NotNull WireOut wire, boolean expectKeyValues, boolean topLevel) Copies one segment of data from this wire to the given wire output.
void	copyTo(@NotNull WireOut wire) Copies the content from the current WireIn source to the provided WireOut destination.
protected @NotNull TextWire.TextValueIn	createValueIn() Creates and returns a new instance of TextValueIn.
protected @NotNull net.openhft.chronicle.wire.JSONWire.JSONValueOut	createValueOut() Creates and returns a new instance of YamlValueOut.
protected Class<?>	defaultKeyClass() Returns the default class to be used as a key.
protected void	escape0(@NotNull CharSequence s, @NotNull net.openhft.chronicle.wire.Quotes quotes) Escapes special characters in a CharSequence as per JSON String encoding standards detailed in RFC 7159, Section 7.
static @NotNull JSONWire	from(@NotNull String text) Static method to construct a JSONWire from a string representation of JSON.
protected @NotNull net.openhft.chronicle.bytes.StopCharsTester	getStrictEscapingEndOfText() Retrieves the StopCharsTester that determines the end of text with strict escaping.
protected @NotNull net.openhft.chronicle.wire.Quotes	needsQuotes(@NotNull CharSequence s) Determines the type of quotes (if any) required for the given CharSequence s based on the YAML format's escaping requirements.
protected @NotNull StringBuilder	readField(@NotNull StringBuilder sb) Reads the field from the current position of the wire and appends it to the given StringBuilder.
@NotNull TextWire	useTextDocuments() Configures this TextWire instance to use textual document contexts for reading and writing.
boolean	useTypes() Gets the current setting for the use of types during JSON parsing.
JSONWire	useTypes(boolean outputTypes) Sets the flag to determine whether to use types during the JSON parsing or not.
ValueOut	writeEvent(Class<?> expectedType, Object eventKey) Writes an event to the stream based on the type and event key.
void	writeStartEvent() Start an event object, mostly for internal use.

Methods inherited from class net.openhft.chronicle.wire.TextWire

acquireWritingDocument, classLookup, classLookup, clear, consumeDocumentStart, consumePadding, consumePadding, consumeWhiteSpace, fromFile, getEscapingEndEventName, getEscapingEndOfText, getEscapingQuotes, getValueIn, hasMetaDataPrefix, initReadContext, isBinary, load, methodReaderBuilder, methodWriter, methodWriterBuilder, newBooleanReference, newIntArrayReference, newIntReference, newLongArrayReference, newLongReference, parseUntil, parseUntil, parseWord, peekStringIgnoreCase, read, read, read, read2, readCode, readComment, readEvent, readEventNumber, readingDocument, readingDocument, readingPeekYaml, readObject, reset, rollbackIfNotComplete, strict, strict, toString, unescape, useBinaryDocuments, useSelfDescribingMessage, writingDocument, writingIsComplete

Methods inherited from class net.openhft.chronicle.wire.YamlWireOut

acquireStringBuilder, addPadding, addTimeStamps, addTimeStamps, append, append, appendU4, bytes, dropDefault, getValueOut, trimFirstCurly, trimFirstCurly, write, write, write, writeComment, writeEndEvent, writeObject

Methods inherited from class net.openhft.chronicle.wire.AbstractWire

bytesComment, commentListener, endOfWire, enterHeader, forceNotInsideHeader, headerNumber, headerNumber, headNumberCheck, isInsideHeader, notCompleteIsNotPresent, notCompleteIsNotPresent, objectInput, objectOutput, parent, parent, pauser, pauser, readAndSetLength, readDataHeader, readFirstHeader, readFirstHeader, readMetaDataHeader, updateFirstHeader, updateFirstHeader, updateHeader, usePadding, usePadding, writeEndOfWire, writeFirstHeader

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.openhft.chronicle.wire.Wire

newYamlWireOnHeap

Methods inherited from interface net.openhft.chronicle.wire.WireIn

endEvent, hasMore, hintReadInputOrder, isEmpty, isEndEvent, isNotEmptyAfterPadding, rawReadData, read, readAlignTo, readAllAsMap, readDataHeader, readDocument, readDocument, readEventName, startEvent

Methods inherited from interface net.openhft.chronicle.wire.MarshallableIn

methodReader, readBytes, readBytes, readDocument, readMap, readText, readText

Methods inherited from interface net.openhft.chronicle.wire.WireOut

padToCacheAlign, writeAlignTo, writeAllAsMap, writeDocument, writeEventId, writeEventId, writeEventName, writeEventName, writeNotCompleteDocument, writingDocument

Methods inherited from interface net.openhft.chronicle.wire.WireCommon

newTwoLongReference

Methods inherited from interface net.openhft.chronicle.wire.MarshallableOut

builder, methodWriterBuilder, recordHistory, writeBytes, writeDocument, writeDocument, writeMap, writeMessage, writeMessage, writeText

Field Detail

ULL

@Deprecated
 @NotNull
public static final @NotNull net.openhft.chronicle.bytes.Bytes<byte[]> ULL

Deprecated.

Constructor Detail

JSONWire

public JSONWire()

Default constructor, initializes with elastic bytes allocated on heap.

JSONWire

public JSONWire(@NotNull
                @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                boolean use8bit)

Constructs a JSONWire with the given bytes and a flag for using 8-bit.

Parameters:

bytes - The bytes to be used for initializing.

use8bit - Flag indicating whether to use 8-bit representation.

JSONWire

public JSONWire(@NotNull
                @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)

Constructs a JSONWire with the given bytes.

Parameters:

bytes - The bytes to be used for initializing.

Method Detail

from

@NotNull
public static @NotNull JSONWire from(@NotNull
                                              @NotNull String text)

Static method to construct a JSONWire from a string representation of JSON.

Parameters:

text - The string containing JSON data.

Returns:

A new instance of JSONWire.

asText

public static String asText(@NotNull
                            @NotNull Wire wire)
                     throws net.openhft.chronicle.core.io.InvalidMarshallableException

Converts the content of the provided wire to a JSON string.

Parameters:

wire - The wire instance to be converted.

Returns:

The string representation of the JSON content.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If there's an error during conversion.

defaultKeyClass

protected Class<?> defaultKeyClass()

Description copied from class: TextWire

Returns the default class to be used as a key. By default, this method returns the Object class.

Overrides:

defaultKeyClass in class TextWire

Returns:

The default key class, which is Object.

useTypes

public JSONWire useTypes(boolean outputTypes)

Sets the flag to determine whether to use types during the JSON parsing or not.

This method is designed to follow the builder pattern, allowing it to be chained with other method calls on the JSONWire object.

Parameters:

outputTypes - A boolean value indicating whether to use types.

Returns:

The current instance of the JSONWire class.

useTypes

public boolean useTypes()

Gets the current setting for the use of types during JSON parsing.

Returns:

true if types are being used in the current instance, otherwise false.

useTextDocuments

@NotNull
public @NotNull TextWire useTextDocuments()

Description copied from class: TextWire

Configures this TextWire instance to use textual document contexts for reading and writing. This will replace the current read and write contexts with textual contexts.

Overrides:

useTextDocuments in class TextWire

Returns:

The current TextWire instance, allowing for method chaining.

createValueOut

@NotNull
protected @NotNull net.openhft.chronicle.wire.JSONWire.JSONValueOut createValueOut()

Description copied from class: YamlWireOut

Creates and returns a new instance of YamlValueOut.

Overrides:

createValueOut in class YamlWireOut<TextWire>

Returns:

A new YamlValueOut instance.

createValueIn

@NotNull
protected @NotNull TextWire.TextValueIn createValueIn()

Description copied from class: TextWire

Creates and returns a new instance of TextValueIn. This method is primarily intended for internal use to provide consistent access to TextValueIn instances.

Overrides:

createValueIn in class TextWire

Returns:

A new instance of TextValueIn.

copyTo

public void copyTo(@NotNull
                   @NotNull WireOut wire)
            throws net.openhft.chronicle.core.io.InvalidMarshallableException

Description copied from interface: WireIn

Copies the content from the current WireIn source to the provided WireOut destination.

Specified by:

copyTo in interface WireIn

Overrides:

copyTo in class TextWire

Parameters:

wire - The WireOut instance where the content will be copied to.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If there's an error in the marshalling process.

copyOne

public void copyOne(@NotNull
                    @NotNull WireOut wire,
                    boolean expectKeyValues,
                    boolean topLevel)
             throws net.openhft.chronicle.core.io.InvalidMarshallableException

Copies one segment of data from this wire to the given wire output. The segment copied depends on the first character encountered (e.g., '{' indicates a map). This method understands JSON structural elements and translates them appropriately.

Parameters:

wire - The wire output to copy the data to.

expectKeyValues - Flag indicating if the current position is inside a map structure.

topLevel - Flag indicating if this is the topmost level of the copy operation.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if there's a problem with copying the data.

needsQuotes

@NotNull
protected @NotNull net.openhft.chronicle.wire.Quotes needsQuotes(@NotNull
                                                                          @NotNull CharSequence s)

Description copied from class: YamlWireOut

Determines the type of quotes (if any) required for the given CharSequence s based on the YAML format's escaping requirements. This method decides between using no quotes, single quotes, or double quotes.

Overrides:

needsQuotes in class YamlWireOut<TextWire>

Parameters:

s - The CharSequence to be analyzed.

Returns:

The type of quotes required.

escape0

protected void escape0(@NotNull
                       @NotNull CharSequence s,
                       @NotNull
                       @NotNull net.openhft.chronicle.wire.Quotes quotes)

Escapes special characters in a CharSequence as per JSON String encoding standards detailed in RFC 7159, Section 7. This ensures that the resulting string can be safely embedded within a JSON string while preserving its meaning. See RFC 7159, Section 7 for more details.

Overrides:

escape0 in class YamlWireOut<TextWire>

Parameters:

s - The CharSequence to escape.

quotes - Specifies the type of quotes used in the CharSequence and guides escaping.

See Also:

RFC 7159, Section 7

writeEvent

public ValueOut writeEvent(Class<?> expectedType,
                           Object eventKey)
                    throws net.openhft.chronicle.core.io.InvalidMarshallableException

Description copied from interface: WireOut

Writes an event to the stream based on the type and event key.

Specified by:

writeEvent in interface WireOut

Overrides:

writeEvent in class YamlWireOut<TextWire>

Parameters:

expectedType - The expected type of the event to write.

eventKey - The key of the event.

Returns:

An interface to further define the output for the written value.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an error marshalling the event.

writeStartEvent

public void writeStartEvent()

Description copied from interface: WireOut

Start an event object, mostly for internal use.

Specified by:

writeStartEvent in interface WireOut

Overrides:

writeStartEvent in class YamlWireOut<TextWire>

readField

@NotNull
protected @NotNull StringBuilder readField(@NotNull
                                                    @NotNull StringBuilder sb)

Description copied from class: TextWire

Reads the field from the current position of the wire and appends it to the given StringBuilder. The method handles different encodings and escape sequences, and ensures correct parsing of field data.

Overrides:

readField in class TextWire

Parameters:

sb - The StringBuilder to which the field value should be appended.

Returns:

The updated StringBuilder containing the field value.

getStrictEscapingEndOfText

@NotNull
protected @NotNull net.openhft.chronicle.bytes.StopCharsTester getStrictEscapingEndOfText()

Description copied from class: TextWire

Retrieves the StopCharsTester that determines the end of text with strict escaping. The tester is fetched from thread-local storage and is then reset.

Overrides:

getStrictEscapingEndOfText in class TextWire

Returns:

The StopCharsTester for determining the end of text with strict escaping.