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
JSON_ONLY
RAW
READ_ANY
TEXT
YAML
YAML_ONLY

Field Summary

Fields inherited from interface net.openhft.chronicle.core.LicenceCheck

CHRONICLE_LICENSE

Method Summary

Modifier and Type	Method and Description
@Nullable Map<String,Object>	asMap(@NotNull CharSequence cs)
String	asString(Object marshallable)
<T> T	fromFile(@NotNull Class<T> expectedType, String filename)
<T> T	fromFile(String filename)
<T> @NotNull Map<String,T>	fromFileAsMap(String filename, @NotNull Class<T> tClass)
<T> T	fromString(@NotNull CharSequence cs) deserializes with an optimistic cast
<T> T	fromString(Class<T> tClass, @NotNull CharSequence cs) deserializes as a given class
boolean	isAvailable()
boolean	isText()
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> @NotNull Stream<T>	streamFromBytes(@NotNull Class<T> expectedType, net.openhft.chronicle.bytes.Bytes<?> b)
<T> @NotNull Stream<T>	streamFromFile(@NotNull Class<T> expectedType, String filename)
<T> @NotNull Stream<T>	streamFromFile(String filename)
void	toFile(@NotNull String filename, WriteMarshallable marshallable)
<T extends Marshallable> void	toFileAsMap(@NotNull String filename, @NotNull Map<String,T> map)
<T extends Marshallable> void	toFileAsMap(@NotNull String filename, @NotNull Map<String,T> map, boolean compact)
static WireType	valueOf(String name) Returns the enum constant of this type with the specified name.
static @Nullable WireType	valueOf(@Nullable 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

Methods inherited from interface net.openhft.chronicle.core.LicenceCheck

check, licenceExpiry

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

JSON_ONLY

public static final WireType JSON_ONLY

YAML

public static final WireType YAML

YAML_ONLY

public static final WireType YAML_ONLY

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 @Nullable WireType valueOf(@Nullable
                                                   @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
                                  @NotNull CharSequence cs)
                           throws net.openhft.chronicle.core.io.InvalidMarshallableException

deserializes with an optimistic cast

Type Parameters:

T - the type to expect

Parameters:

cs - text to deserialize

Returns:

the object deserialized

Throws:

ClassCastException - if the object is not a T

net.openhft.chronicle.core.io.InvalidMarshallableException

fromString

public <T> T fromString(Class<T> tClass,
                        @NotNull
                        @NotNull CharSequence cs)
                 throws net.openhft.chronicle.core.io.InvalidMarshallableException

deserializes as a given class

Parameters:

tClass - to serialize as

cs - text to deserialize

Returns:

the object deserialized

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

fromFile

@NotNull
public <T> T fromFile(String filename)
                        throws IOException,
                               net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

IOException

net.openhft.chronicle.core.io.InvalidMarshallableException

fromFile

@Nullable
public <T> T fromFile(@NotNull
                                @NotNull Class<T> expectedType,
                                String filename)
                         throws IOException,
                                net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

IOException

net.openhft.chronicle.core.io.InvalidMarshallableException

streamFromFile

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

Throws:

IOException

streamFromFile

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

Throws:

IOException

streamFromBytes

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

fromFileAsMap

@NotNull
public <T> @NotNull Map<String,T> fromFileAsMap(String filename,
                                                         @NotNull
                                                         @NotNull Class<T> tClass)
                                                  throws IOException,
                                                         net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

IOException

net.openhft.chronicle.core.io.InvalidMarshallableException

toFileAsMap

public <T extends Marshallable> void toFileAsMap(@NotNull
                                                 @NotNull String filename,
                                                 @NotNull
                                                 @NotNull Map<String,T> map)
                                          throws IOException,
                                                 net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

IOException

net.openhft.chronicle.core.io.InvalidMarshallableException

toFileAsMap

public <T extends Marshallable> void toFileAsMap(@NotNull
                                                 @NotNull String filename,
                                                 @NotNull
                                                 @NotNull Map<String,T> map,
                                                 boolean compact)
                                          throws IOException,
                                                 net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

IOException

net.openhft.chronicle.core.io.InvalidMarshallableException

toFile

public void toFile(@NotNull
                   @NotNull String filename,
                   WriteMarshallable marshallable)
            throws IOException,
                   net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

IOException

net.openhft.chronicle.core.io.InvalidMarshallableException

asMap

@Nullable
public @Nullable Map<String,Object> asMap(@NotNull
                                                    @NotNull CharSequence cs)
                                             throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

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

isText

public boolean isText()