net.openhft.chronicle.wire

Class TextWire

java.lang.Object

net.openhft.chronicle.wire.AbstractWire

net.openhft.chronicle.wire.TextWire

All Implemented Interfaces:

MarshallableIn, MarshallableOut, Wire, WireCommon, WireIn, WireOut

Direct Known Subclasses:

CSVWire, JSONWire, QueryWire

public class TextWire
extends AbstractWire
implements Wire

YAML Based wire format

Nested Class Summary

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

WireIn.HeaderType

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

MarshallableOut.Padding

Field Summary

Fields

Modifier and Type	Field and Description
static net.openhft.chronicle.bytes.BytesStore	BINARY
protected long	lineStart
static net.openhft.chronicle.bytes.BytesStore	TYPE
protected net.openhft.chronicle.wire.TextWire.TextValueIn	valueIn
protected net.openhft.chronicle.wire.TextWire.TextValueOut	valueOut

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

ASSERTIONS, bytes, classLookup, parent, use8bit

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

DEFAULT_SAFE_LENGTH, TRY_WRITE_HEADER_FAILED

Constructor Summary

Constructors

Constructor and Description
TextWire(net.openhft.chronicle.bytes.Bytes bytes)
TextWire(net.openhft.chronicle.bytes.Bytes bytes, boolean use8bit)

Method Summary

Modifier and Type	Method and Description
WireOut	addPadding(int paddingToAdd)
boolean	addTimeStamps()
TextWire	addTimeStamps(boolean addTimeStamps)
void	append(CharSequence cs)
void	append(CharSequence cs, int offset, int length)
static String	asText(Wire wire)
net.openhft.chronicle.bytes.Bytes<?>	bytes()
net.openhft.chronicle.core.pool.ClassLookup	classLookup()
void	classLookup(net.openhft.chronicle.core.pool.ClassLookup classLookup) Define how classes should be looked up.
void	clear() reset the state of the current wire for reuse.
protected void	consumeDocumentStart()
void	consumePadding()
void	consumePadding(int commas)
void	consumeWhiteSpace()
void	copyTo(WireOut wire)
protected net.openhft.chronicle.wire.TextWire.TextValueIn	createValueIn()
protected net.openhft.chronicle.wire.TextWire.TextValueOut	createValueOut()
WireOut	dropDefault(boolean dropDefault)
void	endEvent()
protected void	escape0(CharSequence s, net.openhft.chronicle.wire.Quotes quotes)
static TextWire	from(String text)
static TextWire	fromFile(String name)
protected net.openhft.chronicle.bytes.StopCharsTester	getEscapingEndEventName()
protected net.openhft.chronicle.bytes.StopCharTester	getEscapingEndOfText()
protected net.openhft.chronicle.bytes.StopCharTester	getEscapingQuotes()
protected net.openhft.chronicle.bytes.StopCharsTester	getStrictEscapingEndOfText()
ValueIn	getValueIn() Obtain the value in (for internal use)
ValueOut	getValueOut() Obtain the value out
protected void	initReadContext()
<T> T	methodWriter(Class<T> tClass, Class... additional) Proxy an interface so each message called is written to a file for replay.
<T> VanillaMethodWriterBuilder<T>	methodWriterBuilder(Class<T> tClass)
protected net.openhft.chronicle.wire.Quotes	needsQuotes(CharSequence s)
net.openhft.chronicle.core.values.BooleanValue	newBooleanReference()
net.openhft.chronicle.core.values.IntValue	newIntReference()
net.openhft.chronicle.core.values.LongArrayValues	newLongArrayReference()
net.openhft.chronicle.core.values.LongValue	newLongReference()
void	parseUntil(StringBuilder sb, net.openhft.chronicle.bytes.StopCharsTester testers)
void	parseUntil(StringBuilder sb, net.openhft.chronicle.bytes.StopCharTester testers)
void	parseWord(StringBuilder sb)
protected boolean	peekStringIgnoreCase(String source) returns true if the next string is str
ValueIn	read() Read the field if present, or empty string if not present.
ValueIn	read(StringBuilder name) Read the field if present, or empty string if not present.
ValueIn	read(WireKey key) Read the field if present which must match the WireKey.
protected ValueIn	read2(CharSequence keyName, int keyCode, Object defaultValue, net.openhft.chronicle.wire.ValueInState curr, StringBuilder sb, CharSequence name)
protected int	readCode()
Wire	readComment(StringBuilder s)
<K> K	readEvent(Class<K> expectedClass) Read a field which might be an object of any type.
long	readEventNumber()
protected StringBuilder	readField(StringBuilder sb)
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
DocumentContext	readingDocument(long readLocation)
String	readingPeekYaml()
Object	readObject()
void	startEvent() Start an event object, mostly for internal use.
boolean	strict()
TextWire	strict(boolean strict)
String	toString()
static <ACS extends Appendable & CharSequence> void	unescape(ACS sb)
TextWire	useBinaryDocuments()
TextWire	useTextDocuments()
ValueOut	write() Write an empty filed marker
ValueOut	write(CharSequence name)
ValueOut	write(WireKey key) Write a key for wires that support fields.
Wire	writeComment(CharSequence s)
ValueOut	writeEvent(Class expectedType, Object eventKey)
void	writeObject(Object o)
DocumentContext	writingDocument(boolean metaData) This will increment the headerNumber as appropriate if successful

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

bytesComment, endUse, forceNotInsideHeader, headerNumber, headerNumber, headNumberCheck, isInsideHeader, notCompleteIsNotPresent, notCompleteIsNotPresent, objectInput, objectOutput, parent, parent, pauser, pauser, readAndSetLength, readDataHeader, readFirstHeader, readMetaDataHeader, startUse, tryWriteHeader, updateFirstHeader, updateHeader, writeEndOfWire, writeFirstHeader, writeHeaderOfUnknownLength

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

headerNumber

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

asText, hasMore, isEmpty, isNotEmptyAfterPadding, objectInput, rawReadData, read, readAlignTo, readAllAsMap, readAndSetLength, readDataHeader, readDataHeader, readDocument, readDocument, readEventName, readFirstHeader, readMetaDataHeader

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

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

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

objectOutput, padToCacheAlign, tryWriteHeader, updateFirstHeader, updateHeader, writeAlignTo, writeAllAsMap, writeDocument, writeEndOfWire, writeEventId, writeEventName, writeEventName, writeFirstHeader, writeHeader, writeHeaderOfUnknownLength, writeHeaderOfUnknownLength, writeNotCompleteDocument, writingDocument

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

bytesComment, endUse, headerNumber, newTwoLongReference, notCompleteIsNotPresent, notCompleteIsNotPresent, parent, parent, pauser, pauser, startUse

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

methodWriter, padToCacheAlignMode, recordHistory, writeBytes, writeDocument, writeDocument, writeMap, writeMessage, writeText

Field Detail

TYPE

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

BINARY

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

valueOut

protected final net.openhft.chronicle.wire.TextWire.TextValueOut valueOut

valueIn

protected final net.openhft.chronicle.wire.TextWire.TextValueIn valueIn

lineStart

protected long lineStart

Constructor Detail

TextWire

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

TextWire

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

Method Detail

fromFile

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

Specified by:

fromFile in interface Wire

Throws:

IOException

from

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

asText

public static String asText(@NotNull
                            Wire wire)

unescape

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

strict

public boolean strict()

strict

public TextWire strict(boolean strict)

addTimeStamps

public boolean addTimeStamps()

addTimeStamps

public TextWire addTimeStamps(boolean addTimeStamps)

methodWriter

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

Description copied from interface: MarshallableOut

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

Specified by:

methodWriter in interface MarshallableOut

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> VanillaMethodWriterBuilder<T> methodWriterBuilder(@NotNull
                                                                      Class<T> tClass)

Specified by:

methodWriterBuilder in interface MarshallableOut

classLookup

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

Description copied from interface: WireCommon

Define how classes should be looked up.

Specified by:

classLookup in interface WireCommon

Overrides:

classLookup in class AbstractWire

Parameters:

classLookup - to use

classLookup

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

Specified by:

classLookup in interface WireCommon

Overrides:

classLookup in class AbstractWire

Returns:

the current implementation for looking up classes.

writingDocument

@NotNull
public DocumentContext writingDocument(boolean metaData)

Description copied from interface: WireOut

This will increment the headerNumber as appropriate if successful

Specified by:

writingDocument in interface MarshallableOut

Specified by:

writingDocument in interface WireOut

Parameters:

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

Returns:

a document context used for witting

readingDocument

@NotNull
public 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

Specified by:

readingDocument in interface MarshallableIn

Specified by:

readingDocument in interface WireIn

Returns:

the document context

initReadContext

protected void initReadContext()

useBinaryDocuments

@NotNull
public TextWire useBinaryDocuments()

useTextDocuments

@NotNull
public TextWire useTextDocuments()

readingDocument

@NotNull
public DocumentContext readingDocument(long readLocation)

Specified by:

readingDocument in interface WireIn

createValueOut

@NotNull
protected net.openhft.chronicle.wire.TextWire.TextValueOut createValueOut()

createValueIn

@NotNull
protected net.openhft.chronicle.wire.TextWire.TextValueIn createValueIn()

toString

public String toString()

Overrides:

toString in class Object

copyTo

public void copyTo(@NotNull
                   WireOut wire)

Specified by:

copyTo in interface WireIn

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 ValueIn read()

Description copied from interface: WireIn

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

Specified by:

read in interface WireIn

readField

@NotNull
protected StringBuilder readField(@NotNull
                                           StringBuilder sb)

readEvent

@Nullable
public <K> K readEvent(@NotNull
                                 Class<K> expectedClass)

Description copied from interface: WireIn

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

Specified by:

readEvent in interface WireIn

Parameters:

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

Returns:

an instance of expectedClass

getEscapingEndOfText

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

getStrictEscapingEndOfText

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

getEscapingEndEventName

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

getEscapingQuotes

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

consumePadding

public void consumePadding()

Specified by:

consumePadding in interface WireIn

readingPeekYaml

@NotNull
public String readingPeekYaml()

Specified by:

readingPeekYaml in interface WireIn

consumePadding

public void consumePadding(int commas)

consumeDocumentStart

protected void consumeDocumentStart()

peekStringIgnoreCase

protected boolean peekStringIgnoreCase(@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 ValueIn read(@NotNull
                             WireKey key)

Description copied from interface: WireIn

Read the field if present which must match the WireKey.

Specified by:

read in interface WireIn

read2

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

read

@NotNull
public ValueIn read(@NotNull
                             StringBuilder name)

Description copied from interface: WireIn

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

Specified by:

read in interface WireIn

getValueIn

@NotNull
public ValueIn getValueIn()

Description copied from interface: WireIn

Obtain the value in (for internal use)

Specified by:

getValueIn in interface WireIn

readComment

@NotNull
public Wire readComment(@NotNull
                                 StringBuilder s)

Specified by:

readComment in interface WireIn

consumeWhiteSpace

public void consumeWhiteSpace()

clear

public void clear()

Description copied from interface: WireCommon

reset the state of the current wire for reuse.

Specified by:

clear in interface WireCommon

Specified by:

clear in interface WireIn

Specified by:

clear in interface WireOut

Overrides:

clear in class AbstractWire

bytes

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

Specified by:

bytes in interface WireCommon

Overrides:

bytes in class AbstractWire

Returns:

the underlying Bytes

write

@NotNull
public ValueOut write()

Description copied from interface: WireOut

Write an empty filed marker

Specified by:

write in interface WireOut

write

@NotNull
public ValueOut write(@NotNull
                               WireKey key)

Description copied from interface: WireOut

Write a key for wires that support fields.

Specified by:

write in interface WireOut

write

@NotNull
public ValueOut write(@NotNull
                               CharSequence name)

Specified by:

write in interface WireOut

writeEvent

public ValueOut writeEvent(Class expectedType,
                           Object eventKey)

Specified by:

writeEvent in interface WireOut

dropDefault

@NotNull
public WireOut dropDefault(boolean dropDefault)

Specified by:

dropDefault in interface WireOut

getValueOut

@NotNull
public ValueOut getValueOut()

Description copied from interface: WireOut

Obtain the value out

Specified by:

getValueOut in interface WireOut

writeComment

@NotNull
public Wire writeComment(@NotNull
                                  CharSequence s)

Specified by:

writeComment in interface WireOut

addPadding

@NotNull
public WireOut addPadding(int paddingToAdd)

Specified by:

addPadding in interface WireOut

escape0

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

needsQuotes

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

newLongReference

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

Specified by:

newLongReference in interface WireCommon

Returns:

a LongValue which appropriate for this wire.

newBooleanReference

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

Specified by:

newBooleanReference in interface WireCommon

Returns:

a BooleanValue which appropriate for this wire.

newIntReference

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

Specified by:

newIntReference in interface WireCommon

Returns:

an IntValue which appropriate for this wire.

newLongArrayReference

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

Specified by:

newLongArrayReference in interface WireCommon

Returns:

a LongArrayValue which appropriate for this wire.

parseWord

public void parseWord(@NotNull
                      StringBuilder sb)

parseUntil

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

parseUntil

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

append

public void append(@NotNull
                   CharSequence cs)

append

public void append(@NotNull
                   CharSequence cs,
                   int offset,
                   int length)

readObject

@Nullable
public Object readObject()

writeObject

public void writeObject(Object o)

startEvent

public void startEvent()

Description copied from interface: WireOut

Start an event object, mostly for internal use.

Specified by:

startEvent in interface WireOut

endEvent

public void endEvent()

Specified by:

endEvent in interface WireOut