net.openhft.chronicle.wire

Enum WireType

java.lang.Object

java.lang.Enum<WireType>

net.openhft.chronicle.wire.WireType

All Implemented Interfaces:

Serializable, Comparable<WireType>, Function<net.openhft.chronicle.bytes.Bytes,Wire>, net.openhft.chronicle.core.LicenceCheck

public enum WireType
extends Enum<WireType>
implements Function<net.openhft.chronicle.bytes.Bytes,Wire>, net.openhft.chronicle.core.LicenceCheck

A selection of prebuilt wire types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BINARY Use this ONLY if intend to use Delta and Binary.
BINARY_LIGHT Use this when only need to use Binary (does not support DeltaWire)
COMPRESSED_BINARY
CSV
DEFAULT_ZERO_BINARY
DELTA_BINARY
FIELDLESS_BINARY
JSON
RAW
READ_ANY
TEXT

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	asMap(CharSequence cs)
String	asString(Object marshallable)
<T> T	fromFile(Class<T> expectedType, String filename)
<T> T	fromFile(String filename)
<T> Map<String,T>	fromFileAsMap(String filename, Class<T> tClass)
<T> T	fromString(CharSequence cs)
<T> T	fromString(Class<T> tClass, CharSequence cs)
boolean	isAvailable()
void	licenceCheck()
Supplier<net.openhft.chronicle.core.values.BooleanValue>	newBooleanReference()
Supplier<net.openhft.chronicle.core.values.IntValue>	newIntReference()
Supplier<net.openhft.chronicle.core.values.LongArrayValues>	newLongArrayReference()
Supplier<net.openhft.chronicle.core.values.LongValue>	newLongReference()
Supplier<net.openhft.chronicle.core.values.TwoLongValue>	newTwoLongReference()
<T> Stream<T>	streamFromBytes(Class<T> expectedType, net.openhft.chronicle.bytes.Bytes b)
<T> Stream<T>	streamFromFile(Class<T> expectedType, String filename)
<T> Stream<T>	streamFromFile(String filename)
void	toFile(String filename, WriteMarshallable marshallable)
<T extends Marshallable> void	toFileAsMap(String filename, Map<String,T> map)
<T extends Marshallable> void	toFileAsMap(String filename, Map<String,T> map, boolean compact)
static WireType	valueOf(String name) Returns the enum constant of this type with the specified name.
static WireType	valueOf(Wire wire)
static WireType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

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

Methods inherited from interface java.util.function.Function

andThen, apply, compose, identity

Enum Constant Detail

TEXT

public static final WireType TEXT

BINARY

public static final WireType BINARY

Use this ONLY if intend to use Delta and Binary. Otherwise, use BINARY_LIGHT

BINARY_LIGHT

public static final WireType BINARY_LIGHT

Use this when only need to use Binary (does not support DeltaWire)

DEFAULT_ZERO_BINARY

public static final WireType DEFAULT_ZERO_BINARY

DELTA_BINARY

public static final WireType DELTA_BINARY

FIELDLESS_BINARY

public static final WireType FIELDLESS_BINARY

COMPRESSED_BINARY

public static final WireType COMPRESSED_BINARY

JSON

public static final WireType JSON

RAW

public static final WireType RAW

CSV

public static final WireType CSV

READ_ANY

public static final WireType READ_ANY

Method Detail

values

public static WireType[] 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 (WireType c : WireType.values())
    System.out.println(c);

Returns:

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

valueOf

public static WireType 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

valueOf

@Nullable
public static WireType valueOf(@Nullable
                                         Wire wire)

newIntReference

public Supplier<net.openhft.chronicle.core.values.IntValue> newIntReference()

newBooleanReference

public Supplier<net.openhft.chronicle.core.values.BooleanValue> newBooleanReference()

newLongReference

public Supplier<net.openhft.chronicle.core.values.LongValue> newLongReference()

newTwoLongReference

public Supplier<net.openhft.chronicle.core.values.TwoLongValue> newTwoLongReference()

newLongArrayReference

public Supplier<net.openhft.chronicle.core.values.LongArrayValues> newLongArrayReference()

asString

public String asString(Object marshallable)

fromString

@Nullable
public <T> T fromString(@NotNull
                                  CharSequence cs)

fromString

public <T> T fromString(Class<T> tClass,
                        @NotNull
                        CharSequence cs)

fromFile

@NotNull
public <T> T fromFile(String filename)
                        throws IOException

Throws:

IOException

fromFile

@Nullable
public <T> T fromFile(@NotNull
                                Class<T> expectedType,
                                String filename)
                         throws IOException

Throws:

IOException

streamFromFile

@NotNull
public <T> Stream<T> streamFromFile(String filename)
                                      throws IOException

Throws:

IOException

streamFromFile

@NotNull
public <T> Stream<T> streamFromFile(@NotNull
                                             Class<T> expectedType,
                                             String filename)
                                      throws IOException

Throws:

IOException

streamFromBytes

@NotNull
public <T> Stream<T> streamFromBytes(@NotNull
                                              Class<T> expectedType,
                                              net.openhft.chronicle.bytes.Bytes b)

fromFileAsMap

@NotNull
public <T> Map<String,T> fromFileAsMap(String filename,
                                                @NotNull
                                                Class<T> tClass)
                                         throws IOException

Throws:

IOException

toFileAsMap

public <T extends Marshallable> void toFileAsMap(@NotNull
                                                 String filename,
                                                 @NotNull
                                                 Map<String,T> map)
                                          throws IOException

Throws:

IOException

toFileAsMap

public <T extends Marshallable> void toFileAsMap(@NotNull
                                                 String filename,
                                                 @NotNull
                                                 Map<String,T> map,
                                                 boolean compact)
                                          throws IOException

Throws:

IOException

toFile

public void toFile(@NotNull
                   String filename,
                   WriteMarshallable marshallable)
            throws IOException

Throws:

IOException

asMap

@Nullable
public Map<String,Object> asMap(@NotNull
                                          CharSequence cs)

licenceCheck

public void licenceCheck()

Specified by:

licenceCheck in interface net.openhft.chronicle.core.LicenceCheck

isAvailable

public boolean isAvailable()

Specified by:

isAvailable in interface net.openhft.chronicle.core.LicenceCheck