net.openhft.chronicle.wire

Class QueryWire

java.lang.Object

net.openhft.chronicle.wire.AbstractWire

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

net.openhft.chronicle.wire.TextWire

net.openhft.chronicle.wire.QueryWire

All Implemented Interfaces:

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

public class QueryWire
extends TextWire

Parses a URL query string such as "a=1&b=2". The bytes are treated as UTF-8 text and are not percent-decoded. Extends TextWire and supplies QueryValueIn and QueryValueOut for query specific value handling.

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 inherited from class net.openhft.chronicle.wire.TextWire

BINARY, lineStart, readContext, TYPE_STR, writeContext

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

sb, TYPE

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
QueryWire(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes) Creates a QueryWire over the supplied bytes which must contain a query string, for example "key=val&flag=true".

Method Summary

Modifier and Type	Method and Description
@NotNull QueryWire	addPadding(int paddingToAdd) Adds padding to the wire.
void	consumePadding() Skips any leading whitespace from the current read position.
protected @NotNull TextWire.TextValueIn	createValueIn() Returns a reader that parses query parameter values.
protected @NotNull net.openhft.chronicle.wire.QueryWire.QueryValueOut	createValueOut() Returns a writer that formats values as query parameters.
@NotNull ValueIn	getValueIn() Obtains the value associated with a field or event for more advanced use cases.
@NotNull ValueOut	getValueOut() Retrieves the interface for defining the output of a value that will be written to the stream.
@NotNull net.openhft.chronicle.core.values.IntArrayValues	newIntArrayReference() Unsupported for query strings.
@NotNull net.openhft.chronicle.core.values.IntValue	newIntReference() Unsupported for query strings.
@NotNull net.openhft.chronicle.bytes.ref.BinaryLongArrayReference	newLongArrayReference() Unsupported for query strings.
@NotNull net.openhft.chronicle.core.values.LongValue	newLongReference() Unsupported for query strings.
protected @NotNull StringBuilder	readField(@NotNull StringBuilder sb) Reads the next field name into sb stopping at '=' or '&'.
@NotNull ValueOut	write() Query strings do not support unnamed writes.
@NotNull ValueOut	write(@NotNull CharSequence name) Starts a query parameter using the supplied key.
@NotNull ValueOut	write(@NotNull WireKey key) Starts a query parameter using the supplied key.
@NotNull QueryWire	writeComment(@NotNull CharSequence s) Writes a comment to the wire.

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

acquireWritingDocument, asText, classLookup, classLookup, clear, consumeDocumentStart, consumePadding, consumeWhiteSpace, copyTo, defaultKeyClass, from, fromFile, getEscapingEndEventName, getEscapingEndOfText, getEscapingQuotes, getStrictEscapingEndOfText, hasMetaDataPrefix, initReadContext, isBinary, load, methodReaderBuilder, methodWriter, methodWriterBuilder, newBooleanReference, parseUntil, parseUntil, parseWord, peekStringIgnoreCase, read, read, read, read2, read2, readCode, readComment, readEvent, readEventNumber, readingDocument, readingDocument, readingPeekYaml, readObject, reset, rollbackIfNotComplete, strict, strict, to8bitString, toString, toUtf8String, unescape, useBinaryDocuments, useSelfDescribingMessage, useTextDocuments, writingDocument, writingIsComplete

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

acquireStringBuilder, addTimeStamps, addTimeStamps, append, append, appendU4, bytes, dropDefault, escape0, needsQuotes, trimFirstCurly, trimFirstCurly, writeEndEvent, writeEvent, writeObject, writeStartEvent

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

bytesComment, commentListener, endOfWire, enterHeader, forceNotInsideHeader, generateTuples, generateTuples, 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

Constructor Detail

QueryWire

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

Creates a QueryWire over the supplied bytes which must contain a query string, for example "key=val&flag=true".

Parameters:

bytes - buffer holding the UTF-8 query text

Method Detail

createValueOut

@NotNull
protected @NotNull net.openhft.chronicle.wire.QueryWire.QueryValueOut createValueOut()

Returns a writer that formats values as query parameters.

Overrides:

createValueOut in class YamlWireOut<TextWire>

Returns:

A new YamlValueOut instance.

createValueIn

@NotNull
protected @NotNull TextWire.TextValueIn createValueIn()

Returns a reader that parses query parameter values.

Overrides:

createValueIn in class TextWire

Returns:

A new instance of TextValueIn.

readField

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

Reads the next field name into sb stopping at '=' or '&'. If an '&' has been consumed it is rewound.

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.

consumePadding

public void consumePadding()

Skips any leading whitespace from the current read position.

Specified by:

consumePadding in interface WireIn

Overrides:

consumePadding in class TextWire

write

@NotNull
public @NotNull ValueOut write()

Query strings do not support unnamed writes. Always throws UnsupportedOperationException.

Specified by:

write in interface WireOut

Overrides:

write in class YamlWireOut<TextWire>

Returns:

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

write

@NotNull
public @NotNull ValueOut write(@NotNull
                                        @NotNull WireKey key)

Starts a query parameter using the supplied key. The value is written when a primitive writer is invoked.

Specified by:

write in interface WireOut

Overrides:

write in class YamlWireOut<TextWire>

Parameters:

key - The WireKey to write to the stream.

Returns:

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

write

@NotNull
public @NotNull ValueOut write(@NotNull
                                        @NotNull CharSequence name)

Starts a query parameter using the supplied key. The value is written when a primitive writer is invoked.

Specified by:

write in interface WireOut

Overrides:

write in class YamlWireOut<TextWire>

Parameters:

name - The CharSequence key to write to the stream.

Returns:

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

getValueOut

@NotNull
public @NotNull ValueOut getValueOut()

Description copied from interface: WireOut

Retrieves the interface for defining the output of a value that will be written to the stream.

Specified by:

getValueOut in interface WireOut

Overrides:

getValueOut in class YamlWireOut<TextWire>

Returns:

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

getValueIn

@NotNull
public @NotNull ValueIn getValueIn()

Description copied from interface: WireIn

Obtains the value associated with a field or event for more advanced use cases. Typically used after a call to WireIn.readEvent(Class).

Specified by:

getValueIn in interface WireIn

Overrides:

getValueIn in class TextWire

Returns:

The value of the field or event, encapsulated in a ValueIn instance.

writeComment

@NotNull
public @NotNull QueryWire writeComment(@NotNull
                                                @NotNull CharSequence s)

Description copied from interface: WireOut

Writes a comment to the wire. Comments may be useful for debugging or providing context within the wire stream.

Specified by:

writeComment in interface WireOut

Overrides:

writeComment in class YamlWireOut<TextWire>

Parameters:

s - The comment to be written to the stream.

Returns:

This WireOut instance for method chaining.

addPadding

@NotNull
public @NotNull QueryWire addPadding(int paddingToAdd)

Description copied from interface: WireOut

Adds padding to the wire. This is particularly useful for aligning data.

Specified by:

addPadding in interface WireOut

Overrides:

addPadding in class YamlWireOut<TextWire>

Parameters:

paddingToAdd - The amount of padding to add.

Returns:

This WireOut instance for method chaining.

newLongReference

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

Unsupported for query strings.

Specified by:

newLongReference in interface WireCommon

Overrides:

newLongReference in class TextWire

Returns:

a new LongValue

newIntReference

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

Unsupported for query strings.

Specified by:

newIntReference in interface WireCommon

Overrides:

newIntReference in class TextWire

Returns:

a new IntValue.

newLongArrayReference

@NotNull
public @NotNull net.openhft.chronicle.bytes.ref.BinaryLongArrayReference newLongArrayReference()

Unsupported for query strings.

Specified by:

newLongArrayReference in interface WireCommon

Overrides:

newLongArrayReference in class TextWire

Returns:

a new LongArrayValues

newIntArrayReference

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

Unsupported for query strings.

Specified by:

newIntArrayReference in interface WireCommon

Overrides:

newIntArrayReference in class TextWire

Returns:

a new IntArrayValues