net.openhft.chronicle.wire

Class TextWire

java.lang.Object

net.openhft.chronicle.wire.TextWire

All Implemented Interfaces:

InternalWire, Wire, WireCommon, WireIn, WireOut

Direct Known Subclasses:

CSVWire, JSONWire, QueryWire

public class TextWire
extends Object
implements Wire, InternalWire

YAML Based wire format

Field Summary

Fields

Modifier and Type	Field and Description
protected net.openhft.chronicle.bytes.Bytes<?>	bytes
protected long	lineStart
static net.openhft.chronicle.bytes.BytesStore	TYPE
protected boolean	use8bit
protected net.openhft.chronicle.wire.TextWire.TextValueIn	valueIn
protected net.openhft.chronicle.wire.TextWire.TextValueOut	valueOut

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)
void	append(CharSequence cs)
void	append(CharSequence cs, int offset, int length)
static String	asText(Wire wire)
net.openhft.chronicle.bytes.Bytes<?>	bytes()
void	clear()
void	copyTo(WireOut wire)
protected net.openhft.chronicle.wire.TextWire.TextValueIn	createValueIn()
protected net.openhft.chronicle.wire.TextWire.TextValueOut	createValueOut()
static TextWire	from(String text)
static TextWire	fromFile(String name)
ValueIn	getValueIn() Obtain the value in (for internal use)
ValueOut	getValueOut() Obtain the value out
boolean	hasMore()
boolean	isReady()
protected net.openhft.chronicle.wire.Quotes	needsQuotes(CharSequence s)
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)
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.
Wire	readComment(StringBuilder s)
protected StringBuilder	readField(StringBuilder sb)
DocumentContext	readingDocument()
DocumentContext	readingDocument(long readLocation)
Object	readObject()
void	setReady(boolean ready)
String	toString()
static <ACS extends Appendable & CharSequence> void	unescape(ACS sb)
ValueOut	write() Write an empty filed marker
ValueOut	write(WireKey key) Write a key for wires that support fields.
Wire	writeComment(CharSequence s)
void	writeObject(Object o)
DocumentContext	writingDocument(boolean metaData)

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.WireIn

rawReadData, readAlignTo, readDocument, readDocument, readEventName

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

writeAlignTo, writeDocument, writeEventName, writeNotReadyDocument

Field Detail

TYPE

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

valueOut

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

valueIn

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

use8bit

protected final boolean use8bit

bytes

protected net.openhft.chronicle.bytes.Bytes<?> bytes

lineStart

protected long lineStart

Constructor Detail

TextWire

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

TextWire

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

Method Detail

fromFile

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)

writingDocument

public DocumentContext writingDocument(boolean metaData)

Specified by:

writingDocument in interface WireOut

readingDocument

public DocumentContext readingDocument()

Specified by:

readingDocument in interface WireIn

readingDocument

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

isReady

public boolean isReady()

Specified by:

isReady in interface WireIn

setReady

public void setReady(boolean ready)

Specified by:

setReady in interface InternalWire

copyTo

public void copyTo(@NotNull
                   WireOut wire)

Specified by:

copyTo in interface WireIn

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)

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

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

clear

public void clear()

Specified by:

clear in interface WireIn

bytes

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

Specified by:

bytes in interface WireCommon

Returns:

the underlying Bytes

hasMore

public boolean hasMore()

Specified by:

hasMore in interface WireIn

Returns:

if there is more data to be read in this document.

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

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

needsQuotes

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.

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(StringBuilder sb)

parseUntil

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

parseUntil

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

append

public void append(CharSequence cs)

append

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

readObject

public Object readObject()

writeObject

public void writeObject(Object o)