net.openhft.chronicle.wire

Class TextWire

java.lang.Object

net.openhft.chronicle.wire.AbstractWire

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

net.openhft.chronicle.wire.TextWire

All Implemented Interfaces:

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

Direct Known Subclasses:

CSVWire, JSONWire, QueryWire

public class TextWire
extends YamlWireOut<TextWire>

YAML Based wire format

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	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 net.openhft.chronicle.bytes.BytesStore	BINARY
protected long	lineStart
protected ReadDocumentContext	readContext
static @NotNull net.openhft.chronicle.bytes.Bytes<byte[]>	TYPE_STR
protected TextWire.TextValueIn	valueIn
protected WriteDocumentContext	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
TextWire(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)
TextWire(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, boolean use8bit)

Method Summary

Modifier and Type	Method and Description
DocumentContext	acquireWritingDocument(boolean metaData) Start or reuse an existing a DocumentContext, optionally call close() when done.
static String	asText(@NotNull Wire wire)
net.openhft.chronicle.core.pool.ClassLookup	classLookup() Returns the current ClassLookup implementation being used for class lookup.
void	classLookup(net.openhft.chronicle.core.pool.ClassLookup classLookup) Sets the ClassLookup implementation to be used for class lookup.
void	clear() Resets the state of the underlying Bytes stored by the wire.
protected void	consumeDocumentStart()
void	consumePadding()
void	consumePadding(int commas)
void	consumeWhiteSpace()
void	copyTo(@NotNull WireOut wire)
protected @NotNull TextWire.TextValueIn	createValueIn()
protected Class	defaultKeyClass()
static @NotNull TextWire	from(@NotNull String text)
static @NotNull TextWire	fromFile(String name)
protected @NotNull net.openhft.chronicle.bytes.StopCharsTester	getEscapingEndEventName()
protected @NotNull net.openhft.chronicle.bytes.StopCharTester	getEscapingEndOfText()
protected @Nullable net.openhft.chronicle.bytes.StopCharTester	getEscapingQuotes()
protected @NotNull net.openhft.chronicle.bytes.StopCharsTester	getStrictEscapingEndOfText()
@NotNull ValueIn	getValueIn() Obtain the value in for advanced use (typically after a call to readEvent above)
boolean	hasMetaDataPrefix()
protected void	initReadContext()
boolean	isBinary() Determine whether direct access to the underlying byte() makes sense or should it be treated as text
static <T> T	load(String filename) Loads an Object from a file
@NotNull VanillaMethodReaderBuilder	methodReaderBuilder()
<T> T	methodWriter(@NotNull Class<T> tClass, Class... additional) Proxy an interface so each message called is written for replay.
<T> @NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T>	methodWriterBuilder(@NotNull Class<T> tClass) Return a builder for a proxy an interface so each message called is written for method.
@NotNull net.openhft.chronicle.core.values.BooleanValue	newBooleanReference() Creates and returns a new BooleanValue.
@NotNull net.openhft.chronicle.core.values.IntArrayValues	newIntArrayReference() Creates and returns a new IntArrayValues.
@NotNull net.openhft.chronicle.core.values.IntValue	newIntReference() Creates and returns a new IntValue.
@NotNull net.openhft.chronicle.core.values.LongArrayValues	newLongArrayReference() Creates and returns a new LongArrayValues.
@NotNull net.openhft.chronicle.core.values.LongValue	newLongReference() Creates and returns a new LongValue.
void	parseUntil(@NotNull StringBuilder sb, @NotNull net.openhft.chronicle.bytes.StopCharsTester testers)
void	parseUntil(@NotNull StringBuilder sb, @NotNull net.openhft.chronicle.bytes.StopCharTester testers)
void	parseWord(@NotNull StringBuilder sb)
protected boolean	peekStringIgnoreCase(@NotNull String source) returns true if the next string is str
@NotNull ValueIn	read() Read the field if present, or empty string if not present.
@NotNull ValueIn	read(@NotNull StringBuilder name) Read the field if present, or empty string if not present.
@NotNull ValueIn	read(@NotNull WireKey key) Read the field if present which must match the WireKey.
protected ValueIn	read2(CharSequence keyName, int keyCode, Object defaultValue, @NotNull net.openhft.chronicle.wire.ValueInState curr, @NotNull StringBuilder sb, @NotNull CharSequence name)
protected int	readCode()
@NotNull Wire	readComment(@NotNull StringBuilder s)
<K> K	readEvent(@NotNull Class<K> expectedClass) Read a field which might be an object of any type.
long	readEventNumber()
protected @NotNull StringBuilder	readField(@NotNull StringBuilder sb)
@NotNull DocumentContext	readingDocument() equivalent to WireIn.readDocument(net.openhft.chronicle.wire.ReadMarshallable, net.openhft.chronicle.wire.ReadMarshallable) but with out the use of a lambda expression
@NotNull DocumentContext	readingDocument(long readLocation)
@NotNull String	readingPeekYaml()
@Nullable Object	readObject()
void	reset() Reset the state of the wire
boolean	strict()
TextWire	strict(boolean strict)
protected @NotNull Supplier<net.openhft.chronicle.bytes.StopCharsTester>	strictEndOfTextEscaping() Deprecated.
String	toString()
static <ACS extends Appendable & CharSequence> void	unescape(ACS sb)
@NotNull TextWire	useBinaryDocuments()
boolean	useSelfDescribingMessage(@NotNull net.openhft.chronicle.bytes.CommonMarshallable object) Should this wire write the object as a Marshallable or BytesMarshallable
@NotNull TextWire	useTextDocuments()
@NotNull DocumentContext	writingDocument(boolean metaData) Start a new DocumentContext, must always call close() when done.
boolean	writingIsComplete()

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

acquireStringBuilder, addPadding, addTimeStamps, addTimeStamps, append, append, appendU4, bytes, createValueOut, dropDefault, escape0, getValueOut, needsQuotes, trimFirstCurly, trimFirstCurly, write, write, write, writeComment, writeEndEvent, writeEvent, writeObject, writeStartEvent

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

asText, 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, methodWriter, methodWriterBuilder, recordHistory, writeBytes, writeDocument, writeDocument, writeMap, writeMessage, writeMessage, writeText

Field Detail

BINARY

public static final net.openhft.chronicle.bytes.BytesStore BINARY

TYPE_STR

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

valueIn

protected final TextWire.TextValueIn valueIn

lineStart

protected long lineStart

writeContext

protected WriteDocumentContext writeContext

readContext

protected ReadDocumentContext readContext

Constructor Detail

TextWire

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

TextWire

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

Method Detail

fromFile

@NotNull
public static @NotNull TextWire fromFile(String name)
                                           throws IOException

Throws:

IOException

from

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

asText

public static String asText(@NotNull
                            @NotNull Wire wire)

unescape

public static <ACS extends Appendable & CharSequence> void unescape(@NotNull
                                                                    ACS sb)

load

public static <T> T load(String filename)
                  throws IOException,
                         net.openhft.chronicle.core.io.InvalidMarshallableException

Loads an Object from a file

Type Parameters:

T - the type of the object to load

Parameters:

filename - the file-path containing the object

Returns:

an instance of the object created fromt the data in the file

Throws:

IOException - if the file can not be found or read

net.openhft.chronicle.core.io.InvalidMarshallableException

isBinary

public boolean isBinary()

Description copied from interface: WireCommon

Determine whether direct access to the underlying byte() makes sense or should it be treated as text

Returns:

Is this a binary protocol

strict

public boolean strict()

strict

public TextWire strict(boolean strict)

methodWriter

@NotNull
public <T> T methodWriter(@NotNull
                                   @NotNull Class<T> tClass,
                                   Class... additional)

Description copied from interface: MarshallableOut

Proxy an interface so each message called is written for replay.

Parameters:

tClass - primary interface

additional - any additional interfaces

Returns:

a proxy which implements the primary interface (additional interfaces have to be cast)

methodWriterBuilder

@NotNull
public <T> @NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T> methodWriterBuilder(@NotNull
                                                                                                    @NotNull Class<T> tClass)

Description copied from interface: MarshallableOut

Return a builder for a proxy an interface so each message called is written for method.

Parameters:

tClass - primary interface

Returns:

a builder for a proxy which implements the interface

methodReaderBuilder

@NotNull
public @NotNull VanillaMethodReaderBuilder methodReaderBuilder()

classLookup

public void classLookup(net.openhft.chronicle.core.pool.ClassLookup classLookup)

Description copied from interface: WireCommon

Sets the ClassLookup implementation to be used for class lookup.

Specified by:

classLookup in interface WireCommon

Overrides:

classLookup in class AbstractWire

Parameters:

classLookup - implementation to be used for class lookup.

classLookup

public net.openhft.chronicle.core.pool.ClassLookup classLookup()

Description copied from interface: WireCommon

Returns the current ClassLookup implementation being used for class lookup.

Specified by:

classLookup in interface WireCommon

Overrides:

classLookup in class AbstractWire

Returns:

the current ClassLookup implementation being used for class lookup

writingDocument

@NotNull
public @NotNull DocumentContext writingDocument(boolean metaData)

Description copied from interface: DocumentWritten

Start a new DocumentContext, must always call close() when done.

Parameters:

metaData - if true the document context will be used for writing meta data, otherwise data

Returns:

a document context used for witting

acquireWritingDocument

public DocumentContext acquireWritingDocument(boolean metaData)

Description copied from interface: DocumentWritten

Start or reuse an existing a DocumentContext, optionally call close() when done.

readingDocument

@NotNull
public @NotNull DocumentContext readingDocument()

Description copied from interface: WireIn

equivalent to WireIn.readDocument(net.openhft.chronicle.wire.ReadMarshallable, net.openhft.chronicle.wire.ReadMarshallable) but with out the use of a lambda expression

Returns:

the document context

initReadContext

protected void initReadContext()

useBinaryDocuments

@NotNull
public @NotNull TextWire useBinaryDocuments()

useTextDocuments

@NotNull
public @NotNull TextWire useTextDocuments()

readingDocument

@NotNull
public @NotNull DocumentContext readingDocument(long readLocation)

createValueIn

@NotNull
protected @NotNull TextWire.TextValueIn createValueIn()

toString

public String toString()

Overrides:

toString in class Object

copyTo

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

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

readEventNumber

public long readEventNumber()

Specified by:

readEventNumber in interface WireIn

Overrides:

readEventNumber in class AbstractWire

Returns:

field number or Long.MIN_VALUE if no number.

read

@NotNull
public @NotNull ValueIn read()

Description copied from interface: WireIn

Read the field if present, or empty string if not present.

readField

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

readEvent

@Nullable
public <K> K readEvent(@NotNull
                                 @NotNull Class<K> expectedClass)
                          throws net.openhft.chronicle.core.io.InvalidMarshallableException

Description copied from interface: WireIn

Read a field which might be an object of any type.

Use getValueIn() to read the value for this event

Parameters:

expectedClass - to use as a hint, or Object.class if no hint available.

Returns:

an instance of expectedClass

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

defaultKeyClass

protected Class defaultKeyClass()

getEscapingEndOfText

@NotNull
protected @NotNull net.openhft.chronicle.bytes.StopCharTester getEscapingEndOfText()

getStrictEscapingEndOfText

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

strictEndOfTextEscaping

@NotNull
 @Deprecated
protected @NotNull Supplier<net.openhft.chronicle.bytes.StopCharsTester> strictEndOfTextEscaping()

Deprecated.

getEscapingEndEventName

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

getEscapingQuotes

@Nullable
protected @Nullable net.openhft.chronicle.bytes.StopCharTester getEscapingQuotes()

consumePadding

public void consumePadding()

readingPeekYaml

@NotNull
public @NotNull String readingPeekYaml()

consumePadding

public void consumePadding(int commas)

consumeDocumentStart

protected void consumeDocumentStart()

peekStringIgnoreCase

protected boolean peekStringIgnoreCase(@NotNull
                                       @NotNull String source)

returns true if the next string is str

Parameters:

source - string

Returns:

true if the strings are the same

readCode

protected int readCode()

read

@NotNull
public @NotNull ValueIn read(@NotNull
                                      @NotNull WireKey key)

Description copied from interface: WireIn

Read the field if present which must match the WireKey.

read2

protected ValueIn read2(CharSequence keyName,
                        int keyCode,
                        Object defaultValue,
                        @NotNull
                        @NotNull net.openhft.chronicle.wire.ValueInState curr,
                        @NotNull
                        @NotNull StringBuilder sb,
                        @NotNull
                        @NotNull CharSequence name)

read

@NotNull
public @NotNull ValueIn read(@NotNull
                                      @NotNull StringBuilder name)

Description copied from interface: WireIn

Read the field if present, or empty string if not present.

getValueIn

@NotNull
public @NotNull ValueIn getValueIn()

Description copied from interface: WireIn

Obtain the value in for advanced use (typically after a call to readEvent above)

readComment

@NotNull
public @NotNull Wire readComment(@NotNull
                                          @NotNull StringBuilder s)

consumeWhiteSpace

public void consumeWhiteSpace()

clear

public void clear()

Description copied from interface: WireCommon

Resets the state of the underlying Bytes stored by the wire.

Specified by:

clear in interface WireCommon

Specified by:

clear in interface WireIn

Specified by:

clear in interface WireOut

Overrides:

clear in class AbstractWire

newLongReference

@NotNull
public @NotNull net.openhft.chronicle.core.values.LongValue newLongReference()

Description copied from interface: WireCommon

Creates and returns a new LongValue. The LongValue implementation that is returned depends on the wire implementation.

Returns:

a new LongValue

newBooleanReference

@NotNull
public @NotNull net.openhft.chronicle.core.values.BooleanValue newBooleanReference()

Description copied from interface: WireCommon

Creates and returns a new BooleanValue. The BooleanValue implementation that is returned depends on the wire implementation.

Returns:

a new BooleanValue.

useSelfDescribingMessage

public boolean useSelfDescribingMessage(@NotNull
                                        @NotNull net.openhft.chronicle.bytes.CommonMarshallable object)

Description copied from interface: WireCommon

Should this wire write the object as a Marshallable or BytesMarshallable

Returns:

use Marshallable

newIntReference

@NotNull
public @NotNull net.openhft.chronicle.core.values.IntValue newIntReference()

Description copied from interface: WireCommon

Creates and returns a new IntValue. The IntValue implementation that is returned depends on the wire implementation.

Returns:

a new IntValue.

newLongArrayReference

@NotNull
public @NotNull net.openhft.chronicle.core.values.LongArrayValues newLongArrayReference()

Description copied from interface: WireCommon

Creates and returns a new LongArrayValues. The LongArrayValues implementation that is returned depends on the wire implementation.

Returns:

a new LongArrayValues

newIntArrayReference

@NotNull
public @NotNull net.openhft.chronicle.core.values.IntArrayValues newIntArrayReference()

Description copied from interface: WireCommon

Creates and returns a new IntArrayValues. The IntArrayValues implementation that is returned depends on the wire implementation.

Returns:

a new IntArrayValues

parseWord

public void parseWord(@NotNull
                      @NotNull StringBuilder sb)

parseUntil

public void parseUntil(@NotNull
                       @NotNull StringBuilder sb,
                       @NotNull
                       @NotNull net.openhft.chronicle.bytes.StopCharTester testers)

parseUntil

public void parseUntil(@NotNull
                       @NotNull StringBuilder sb,
                       @NotNull
                       @NotNull net.openhft.chronicle.bytes.StopCharsTester testers)

readObject

@Nullable
public @Nullable Object readObject()
                                      throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

reset

public void reset()

Description copied from interface: WireCommon

Reset the state of the wire

hasMetaDataPrefix

public boolean hasMetaDataPrefix()

writingIsComplete

public boolean writingIsComplete()

Returns:

true unless there is an incomplete/chained message