net.openhft.chronicle.wire

Enum Wires

java.lang.Object

java.lang.Enum<Wires>

net.openhft.chronicle.wire.Wires

All Implemented Interfaces:

Serializable, Comparable<Wires>

public enum Wires
extends Enum<Wires>

Field Summary

Fields

Modifier and Type	Field and Description
static List<Function<Class,SerializationStrategy>>	CLASS_STRATEGY_FUNCTIONS
static int	END_OF_DATA
static boolean	GENERATE_TUPLES
static int	LENGTH_MASK
static int	META_DATA
static net.openhft.chronicle.bytes.Bytes<?>	NO_BYTES
static int	NOT_COMPLETE
static int	NOT_COMPLETE_UNKNOWN_LENGTH
static int	NOT_INITIALIZED
static int	SPB_HEADER_SIZE
static int	UNKNOWN_LENGTH

Method Summary

Modifier and Type	Method and Description
static @NotNull net.openhft.chronicle.bytes.Bytes<?>	acquireAnotherBytes() Deprecated. Use acquireBytesScoped() instead
static @NotNull Wire	acquireBinaryWire() Deprecated. Use acquireBinaryWireScoped() instead
static net.openhft.chronicle.core.scoped.ScopedResource<Wire>	acquireBinaryWireScoped()
static @NotNull net.openhft.chronicle.bytes.Bytes<?>	acquireBytes() Deprecated. Use acquireBytesScoped() instead
static @NotNull net.openhft.chronicle.core.scoped.ScopedResource<net.openhft.chronicle.bytes.Bytes<?>>	acquireBytesScoped()
static boolean	acquireLock(@NotNull net.openhft.chronicle.bytes.BytesStore store, long position)
static StringBuilder	acquireStringBuilder() Deprecated. Use acquireStringBuilderScoped() instead
static net.openhft.chronicle.core.scoped.ScopedResource<StringBuilder>	acquireStringBuilderScoped()
static @NotNull net.openhft.chronicle.bytes.Bytes	asBinary(@NotNull WireIn wireIn) Deprecated. Use asBinary(WireIn, Bytes) instead
static net.openhft.chronicle.bytes.Bytes<?>	asBinary(@NotNull WireIn wireIn, net.openhft.chronicle.bytes.Bytes<?> output)
static @NotNull net.openhft.chronicle.bytes.Bytes	asJson(@NotNull WireIn wireIn) Deprecated. Use asJson(WireIn, Bytes) instead
static net.openhft.chronicle.bytes.Bytes<?>	asJson(@NotNull WireIn wireIn, net.openhft.chronicle.bytes.Bytes<?> output)
static @NotNull CharSequence	asText(@NotNull WireIn wireIn) Deprecated. Use asText(WireIn, Bytes) instead
static @NotNull CharSequence	asText(@NotNull WireIn wireIn, net.openhft.chronicle.bytes.Bytes<?> output)
static @NotNull BinaryWire	binaryWireForRead(net.openhft.chronicle.bytes.Bytes<?> in, long position, long length)
static @NotNull BinaryWire	binaryWireForWrite(net.openhft.chronicle.bytes.Bytes<?> in, long position, long length)
static <T> T	copyTo(Object source, T target)
static <T extends Marshallable> T	deepCopy(T marshallable)
static boolean	dtoInterface(Class clazz)
static boolean	exceedsMaxLength(long length)
static FieldInfo	fieldInfo(@NotNull Class aClass, String name)
static @NotNull Map<String,FieldInfo>	fieldInfoMap(@NotNull Class aClass)
static @NotNull List<FieldInfo>	fieldInfos(@NotNull Class aClass)
static String	fromAlignedSizePrefixedBlobs(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)
static String	fromSizePrefixedBlobs(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes) This decodes some Bytes where the first 4-bytes is the length.
static String	fromSizePrefixedBlobs(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, boolean abbrev)
static String	fromSizePrefixedBlobs(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, boolean padding, boolean abbrev)
static String	fromSizePrefixedBlobs(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, long position)
static String	fromSizePrefixedBlobs(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, long position, boolean padding)
static String	fromSizePrefixedBlobs(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, long position, long length)
static String	fromSizePrefixedBlobs(@NotNull DocumentContext dc)
static String	fromSizePrefixedBlobs(@NotNull WireIn wireIn)
static String	fromSizePrefixedBlobs(@NotNull WireIn wireIn, boolean abbrev)
static <T> T	getField(@NotNull Object o, String name, Class<T> tClass)
static long	getLongField(@NotNull Object o, String name)
static void	init()
static boolean	isData(int len)
static boolean	isEndOfFile(int num)
static boolean	isEquals(@NotNull Object o1, @NotNull Object o2)
static boolean	isInternal(@NotNull Object value)
static boolean	isKnownLength(int len)
static boolean	isNotComplete(int header)
static boolean	isNotInitialized(int len)
static boolean	isReady(int header)
static boolean	isReadyData(int header)
static boolean	isReadyMetaData(int len)
static int	lengthOf(int len)
static <E> E	object0(ValueIn in, E using, @Nullable Class clazz)
static <E> E	object0(ValueIn in, E using, @Nullable Class clazz, boolean bestEffort)
static <E> E	object1(ValueIn in, E using, @Nullable Class clazz, boolean bestEffort)
static <E> E	objectDate(ValueIn in, E using)
static <E> E	objectMap(ValueIn in, E using, @Nullable Class clazz, @NotNull SerializationStrategy<E> strategy)
static <E> E	objectSequence(ValueIn in, E using, @Nullable Class clazz, SerializationStrategy<E> strategy)
static <T> T	project(Class<T> tClass, Object source)
static void	readMarshallable(Class<?> clazz, @NotNull Object marshallable, @NotNull WireIn wire, boolean overwrite)
static void	readMarshallable(@NotNull Object marshallable, @NotNull WireIn wire, boolean overwrite)
static long	readWire(@NotNull WireIn wireIn, long size, @NotNull ReadMarshallable readMarshallable)
static <T> T	recordAsYaml(Class<T> tClass, PrintStream ps) Creates and returns a proxy of the specified interface.
static int	removeMaskedTidFromHeader(int header)
static void	replay(String file, Object obj) Reads the content of a specified Yaml file and feeds it to the specified object.
static void	reset(@NotNull Object o)
static void	setField(@NotNull Object o, String name, Object value)
static void	setLongField(@NotNull Object o, String name, long value)
static int	toIntU30(long l, @NotNull String error)
static <T> T	tupleFor(Class<T> tClass, String typeName)
static String	typeNameFor(net.openhft.chronicle.core.pool.ClassLookup classLookup, @NotNull Object value)
static String	typeNameFor(@NotNull Object value)
static Wires	valueOf(String name) Returns the enum constant of this type with the specified name.
static Wires[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static <T extends WriteMarshallable> long	writeData(@NotNull WireOut wireOut, T writer)
static void	writeKey(@NotNull Object marshallable, net.openhft.chronicle.bytes.Bytes<?> bytes)
static void	writeMarshallable(@NotNull Object marshallable, @NotNull WireOut wire)
static void	writeMarshallable(@NotNull Object marshallable, @NotNull WireOut wire, boolean writeDefault)
static void	writeMarshallable(@NotNull Object marshallable, @NotNull WireOut wire, @NotNull Object previous, boolean copy)

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

LENGTH_MASK

public static final int LENGTH_MASK

See Also:

Constant Field Values

NOT_COMPLETE

public static final int NOT_COMPLETE

See Also:

Constant Field Values

META_DATA

public static final int META_DATA

See Also:

Constant Field Values

UNKNOWN_LENGTH

public static final int UNKNOWN_LENGTH

See Also:

Constant Field Values

NOT_COMPLETE_UNKNOWN_LENGTH

public static final int NOT_COMPLETE_UNKNOWN_LENGTH

See Also:

Constant Field Values

END_OF_DATA

public static final int END_OF_DATA

See Also:

Constant Field Values

NOT_INITIALIZED

public static final int NOT_INITIALIZED

See Also:

Constant Field Values

NO_BYTES

public static final net.openhft.chronicle.bytes.Bytes<?> NO_BYTES

SPB_HEADER_SIZE

public static final int SPB_HEADER_SIZE

See Also:

Constant Field Values

CLASS_STRATEGY_FUNCTIONS

public static final List<Function<Class,SerializationStrategy>> CLASS_STRATEGY_FUNCTIONS

GENERATE_TUPLES

public static boolean GENERATE_TUPLES

Method Detail

values

public static Wires[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Wires c : Wires.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Wires valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

init

public static void init()

recordAsYaml

public static <T> T recordAsYaml(Class<T> tClass,
                                 PrintStream ps)

Creates and returns a proxy of the specified interface. The proxy writes inputs into the specified PrintStream in Yaml format.

Type Parameters:

T - type of the specified interface

Parameters:

tClass - the specified interface

ps - the PrintStream used to write output data into as Yaml format

Returns:

a proxy of the specified interface

replay

public static void replay(String file,
                          Object obj)
                   throws IOException,
                          net.openhft.chronicle.core.io.InvalidMarshallableException

Reads the content of a specified Yaml file and feeds it to the specified object.

Parameters:

file - name of the input Yaml file

obj - the object that replays the data in the specified file

Throws:

IOException - is thrown if an IO operation fails

net.openhft.chronicle.core.io.InvalidMarshallableException

fromSizePrefixedBlobs

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

This decodes some Bytes where the first 4-bytes is the length. e.g. Wire.writeDocument wrote it. Size Prefixed Blob

Parameters:

bytes - to decode

Returns:

as String

fromAlignedSizePrefixedBlobs

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

fromSizePrefixedBlobs

public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                                           boolean abbrev)

fromSizePrefixedBlobs

public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                                           long position)

fromSizePrefixedBlobs

public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                                           long position,
                                           boolean padding)

fromSizePrefixedBlobs

public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                                           boolean padding,
                                           boolean abbrev)

fromSizePrefixedBlobs

public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull DocumentContext dc)

fromSizePrefixedBlobs

public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull WireIn wireIn)

fromSizePrefixedBlobs

public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull WireIn wireIn,
                                           boolean abbrev)

asText

@Deprecated
 @NotNull
public static @NotNull CharSequence asText(@NotNull
                                                                 @NotNull WireIn wireIn)

Deprecated. Use asText(WireIn, Bytes) instead

asText

@NotNull
public static @NotNull CharSequence asText(@NotNull
                                                    @NotNull WireIn wireIn,
                                                    net.openhft.chronicle.bytes.Bytes<?> output)

asBinary

@Deprecated
 @NotNull
public static @NotNull net.openhft.chronicle.bytes.Bytes asBinary(@NotNull
                                                                                        @NotNull WireIn wireIn)
                                                                                 throws net.openhft.chronicle.core.io.InvalidMarshallableException

Deprecated. Use asBinary(WireIn, Bytes) instead

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

asBinary

public static net.openhft.chronicle.bytes.Bytes<?> asBinary(@NotNull
                                                            @NotNull WireIn wireIn,
                                                            net.openhft.chronicle.bytes.Bytes<?> output)
                                                     throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

asJson

@Deprecated
 @NotNull
public static @NotNull net.openhft.chronicle.bytes.Bytes asJson(@NotNull
                                                                                      @NotNull WireIn wireIn)
                                                                               throws net.openhft.chronicle.core.io.InvalidMarshallableException

Deprecated. Use asJson(WireIn, Bytes) instead

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

asJson

public static net.openhft.chronicle.bytes.Bytes<?> asJson(@NotNull
                                                          @NotNull WireIn wireIn,
                                                          net.openhft.chronicle.bytes.Bytes<?> output)
                                                   throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

acquireStringBuilder

@Deprecated
public static StringBuilder acquireStringBuilder()

Deprecated. Use acquireStringBuilderScoped() instead

acquireStringBuilderScoped

public static net.openhft.chronicle.core.scoped.ScopedResource<StringBuilder> acquireStringBuilderScoped()

lengthOf

public static int lengthOf(int len)

isReady

public static boolean isReady(int header)

isNotComplete

public static boolean isNotComplete(int header)

isReadyData

public static boolean isReadyData(int header)

isData

public static boolean isData(int len)

isReadyMetaData

public static boolean isReadyMetaData(int len)

isKnownLength

public static boolean isKnownLength(int len)

isNotInitialized

public static boolean isNotInitialized(int len)

toIntU30

public static int toIntU30(long l,
                           @NotNull
                           @NotNull String error)

acquireLock

public static boolean acquireLock(@NotNull
                                  @NotNull net.openhft.chronicle.bytes.BytesStore store,
                                  long position)

exceedsMaxLength

public static boolean exceedsMaxLength(long length)

writeData

public static <T extends WriteMarshallable> long writeData(@NotNull
                                                           @NotNull WireOut wireOut,
                                                           @NotNull
                                                           T writer)
                                                    throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

readWire

public static long readWire(@NotNull
                            @NotNull WireIn wireIn,
                            long size,
                            @NotNull
                            @NotNull ReadMarshallable readMarshallable)
                     throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

acquireBytes

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

Deprecated. Use acquireBytesScoped() instead

acquireBytesScoped

@NotNull
public static @NotNull net.openhft.chronicle.core.scoped.ScopedResource<net.openhft.chronicle.bytes.Bytes<?>> acquireBytesScoped()

acquireBinaryWire

@Deprecated
 @NotNull
public static @NotNull Wire acquireBinaryWire()

Deprecated. Use acquireBinaryWireScoped() instead

acquireBinaryWireScoped

public static net.openhft.chronicle.core.scoped.ScopedResource<Wire> acquireBinaryWireScoped()

acquireAnotherBytes

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

Deprecated. Use acquireBytesScoped() instead

Returns:

fromSizePrefixedBlobs

public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                                           long position,
                                           long length)

readMarshallable

public static void readMarshallable(@NotNull
                                    @NotNull Object marshallable,
                                    @NotNull
                                    @NotNull WireIn wire,
                                    boolean overwrite)
                             throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

readMarshallable

public static void readMarshallable(Class<?> clazz,
                                    @NotNull
                                    @NotNull Object marshallable,
                                    @NotNull
                                    @NotNull WireIn wire,
                                    boolean overwrite)
                             throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

writeMarshallable

public static void writeMarshallable(@NotNull
                                     @NotNull Object marshallable,
                                     @NotNull
                                     @NotNull WireOut wire)
                              throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

writeMarshallable

public static void writeMarshallable(@NotNull
                                     @NotNull Object marshallable,
                                     @NotNull
                                     @NotNull WireOut wire,
                                     boolean writeDefault)
                              throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

writeMarshallable

public static void writeMarshallable(@NotNull
                                     @NotNull Object marshallable,
                                     @NotNull
                                     @NotNull WireOut wire,
                                     @NotNull
                                     @NotNull Object previous,
                                     boolean copy)
                              throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

writeKey

public static void writeKey(@NotNull
                            @NotNull Object marshallable,
                            net.openhft.chronicle.bytes.Bytes<?> bytes)

deepCopy

@NotNull
public static <T extends Marshallable> T deepCopy(@NotNull
                                                           T marshallable)
                                                    throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

copyTo

@NotNull
public static <T> T copyTo(Object source,
                                    @NotNull
                                    T target)
                             throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

project

@NotNull
public static <T> T project(Class<T> tClass,
                                     Object source)
                              throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

isEquals

public static boolean isEquals(@NotNull
                               @NotNull Object o1,
                               @NotNull
                               @NotNull Object o2)

fieldInfos

@NotNull
public static @NotNull List<FieldInfo> fieldInfos(@NotNull
                                                           @NotNull Class aClass)

fieldInfoMap

@NotNull
public static @NotNull Map<String,FieldInfo> fieldInfoMap(@NotNull
                                                                   @NotNull Class aClass)

fieldInfo

public static FieldInfo fieldInfo(@NotNull
                                  @NotNull Class aClass,
                                  String name)

isEndOfFile

public static boolean isEndOfFile(int num)

getField

@Nullable
public static <T> T getField(@NotNull
                                       @NotNull Object o,
                                       String name,
                                       Class<T> tClass)
                                throws NoSuchFieldException

Throws:

NoSuchFieldException

getLongField

public static long getLongField(@NotNull
                                @NotNull Object o,
                                String name)
                         throws NoSuchFieldException

Throws:

NoSuchFieldException

setField

public static void setField(@NotNull
                            @NotNull Object o,
                            String name,
                            Object value)
                     throws NoSuchFieldException

Throws:

NoSuchFieldException

setLongField

public static void setLongField(@NotNull
                                @NotNull Object o,
                                String name,
                                long value)
                         throws NoSuchFieldException

Throws:

NoSuchFieldException

reset

public static void reset(@NotNull
                         @NotNull Object o)

removeMaskedTidFromHeader

public static int removeMaskedTidFromHeader(int header)

objectSequence

@Nullable
public static <E> E objectSequence(ValueIn in,
                                             @Nullable
                                             E using,
                                             @Nullable
                                             @Nullable Class clazz,
                                             SerializationStrategy<E> strategy)

objectMap

@Nullable
public static <E> E objectMap(ValueIn in,
                                        @Nullable
                                        E using,
                                        @Nullable
                                        @Nullable Class clazz,
                                        @NotNull
                                        @NotNull SerializationStrategy<E> strategy)
                                 throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

objectDate

@NotNull
public static <E> E objectDate(ValueIn in,
                                        @Nullable
                                        E using)

object0

@Nullable
public static <E> E object0(ValueIn in,
                                      @Nullable
                                      E using,
                                      @Nullable
                                      @Nullable Class clazz)
                               throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

object0

public static <E> E object0(ValueIn in,
                            @Nullable
                            E using,
                            @Nullable
                            @Nullable Class clazz,
                            boolean bestEffort)
                     throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

object1

public static <E> E object1(ValueIn in,
                            @Nullable
                            E using,
                            @Nullable
                            @Nullable Class clazz,
                            boolean bestEffort)
                     throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

dtoInterface

public static boolean dtoInterface(Class clazz)

typeNameFor

public static String typeNameFor(@NotNull
                                 @NotNull Object value)

typeNameFor

public static String typeNameFor(net.openhft.chronicle.core.pool.ClassLookup classLookup,
                                 @NotNull
                                 @NotNull Object value)

tupleFor

@Nullable
public static <T> T tupleFor(Class<T> tClass,
                                       String typeName)

isInternal

public static boolean isInternal(@NotNull
                                 @NotNull Object value)

binaryWireForRead

@NotNull
public static @NotNull BinaryWire binaryWireForRead(net.openhft.chronicle.bytes.Bytes<?> in,
                                                             long position,
                                                             long length)

binaryWireForWrite

@NotNull
public static @NotNull BinaryWire binaryWireForWrite(net.openhft.chronicle.bytes.Bytes<?> in,
                                                              long position,
                                                              long length)