Wires (OpenHFT/Chronicle-Wire 2.26ea3 API)

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

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static net.openhft.chronicle.core.scoped.ScopedResource<Wire>`	`acquireBinaryWireScoped()`
`static @NotNull net.openhft.chronicle.core.scoped.ScopedResource<net.openhft.chronicle.bytes.Bytes<Void>>`	`acquireBytesScoped()`
`static boolean`	`acquireLock(@NotNull net.openhft.chronicle.bytes.BytesStore<?,?> store, long position)` Acquires a lock on the given BytesStore at the specified position.
`static net.openhft.chronicle.core.scoped.ScopedResource<StringBuilder>`	`acquireStringBuilderScoped()`
`static net.openhft.chronicle.bytes.Bytes<?>`	`asBinary(@NotNull WireIn wireIn, net.openhft.chronicle.bytes.Bytes<?> output)`
`static net.openhft.chronicle.bytes.Bytes<?>`	`asJson(@NotNull WireIn wireIn, net.openhft.chronicle.bytes.Bytes<?> output)`
`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)` Creates a BinaryWire for reading with the given input, position, and length.
`static @NotNull BinaryWire`	`binaryWireForWrite(net.openhft.chronicle.bytes.Bytes<?> in, long position, long length)` Creates a BinaryWire for writing with the given input, position, and length.
`static <T> T`	`copyTo(Object source, T target)` Copy fields from source to target by marshalling out and then in.
`static <T extends Marshallable> T`	`deepCopy(T marshallable)` Creates a deep copy of the provided marshallable object.
`static boolean`	`dtoInterface(Class<?> clazz)` Determines if the provided class is an interface and qualifies as a DTO (Data Transfer Object).
`static boolean`	`exceedsMaxLength(long length)` Checks if the given length exceeds the maximum allowed length.
`static FieldInfo`	`fieldInfo(@NotNull Class<?> aClass, String name)` Retrieves field information for a specific field of a given class.
`static @NotNull Map<String,FieldInfo>`	`fieldInfoMap(@NotNull Class<?> aClass)` Retrieves a map of field names to their information for a given class.
`static @NotNull List<FieldInfo>`	`fieldInfos(@NotNull Class<?> aClass)` Retrieves the list of field information for a given class.
`static String`	`fromAlignedSizePrefixedBlobs(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)` Converts the provided bytes, which represent aligned size-prefixed blobs, into a readable string format.
`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)` Converts the provided bytes, representing size-prefixed blobs, into a readable string format with the option to abbreviate.
`static String`	`fromSizePrefixedBlobs(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, boolean padding, boolean abbrev)` Converts the provided bytes, which represent size-prefixed blobs, into a readable string format with options for padding and abbreviation.
`static String`	`fromSizePrefixedBlobs(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, long position)` Converts the provided bytes, representing size-prefixed blobs, into a readable string format from the specified position.
`static String`	`fromSizePrefixedBlobs(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, long position, boolean padding)` Converts the provided bytes, representing size-prefixed blobs, into a readable string format from a specified position and with the option to pad.
`static String`	`fromSizePrefixedBlobs(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, long position, long length)` Creates a string representation of a specific portion of size-prefixed blob data.
`static String`	`fromSizePrefixedBlobs(@NotNull DocumentContext dc)` Converts the contents of the provided `DocumentContext` which represent size-prefixed blobs into a readable string format.
`static String`	`fromSizePrefixedBlobs(@NotNull WireIn wireIn)` Converts the contents of the provided `WireIn` which represent size-prefixed blobs into a readable string format.
`static String`	`fromSizePrefixedBlobs(@NotNull WireIn wireIn, boolean abbrev)` Converts the contents of the provided `WireIn` which represent size-prefixed blobs into a readable string format, with the option to abbreviate the output.
`static <T> T`	`getField(@NotNull Object o, String name, Class<T> tClass)` Retrieves the value of a specific field from an object and converts it to the desired type.
`static long`	`getLongField(@NotNull Object o, String name)` Retrieves the long value of a specific field from an object.
`static void`	`init()` A utility method to force the static initialization of this enum.
`static boolean`	`isData(int len)` Checks if the given length represents data and not meta-data.
`static boolean`	`isEndOfFile(int num)` Checks if a given integer represents the end of file marker.
`static boolean`	`isEquals(@NotNull Object o1, @NotNull Object o2)` Checks if two objects are of the same type and equal based on their serialized representation.
`static boolean`	`isInternal(@NotNull Object value)` Determines if the value's package name is internal to Java.
`static boolean`	`isKnownLength(int len)` Checks if the given length represents a known length (neither unknown nor meta-data).
`static boolean`	`isNotComplete(int header)` Checks if the given header is not complete or zero.
`static boolean`	`isNotInitialized(int len)` Checks if the given length is not initialized.
`static boolean`	`isReady(int header)` Checks if the given header is ready (complete and not zero).
`static boolean`	`isReadyData(int header)` Checks if the given header represents ready data (neither meta-data nor incomplete) and is not zero.
`static boolean`	`isReadyMetaData(int len)` Checks if the given length represents ready meta-data.
`static int`	`lengthOf(int len)` Extracts the length from the given length value.
`static <E> E`	`object0(ValueIn in, E using, @Nullable Class<? extends E> clazz)` Reads and validates an object from the given input.
`static <E> E`	`object0(ValueIn in, E using, @Nullable Class<? extends E> clazz, boolean bestEffort)` Deserialize an object from the provided input and validate it.
`static <E> E`	`object1(ValueIn in, E using, @Nullable Class<? extends E> clazz, boolean bestEffort)` Deserialize an object from the provided input based on the defined strategy and constraints.
`static <E> E`	`objectDate(ValueIn in, E using)` Reads a date object from the given input.
`static <E> E`	`objectMap(ValueIn in, E using, @Nullable Class<? extends E> clazz, @NotNull SerializationStrategy strategy)` Reads a map of objects from the given input, using a specified serialization strategy.
`static <E> E`	`objectSequence(ValueIn in, E using, @Nullable Class<? extends E> clazz, SerializationStrategy strategy)` Reads a sequence of objects using a specified serialization strategy.
`static <T> T`	`project(Class<T> tClass, Object source)` Projects the source object's fields into a new instance of a specified class.
`static void`	`readMarshallable(Class<?> clazz, @NotNull Object marshallable, @NotNull WireIn wire, boolean overwrite)` Reads a Marshallable object's fields from a WireIn instance using a specified class type.
`static void`	`readMarshallable(@NotNull Object marshallable, @NotNull WireIn wire, boolean overwrite)` Reads a Marshallable object's fields from a WireIn instance.
`static long`	`readWire(@NotNull WireIn wireIn, long size, @NotNull ReadMarshallable readMarshallable)` Reads data from a WireIn up to a specified size using a ReadMarshallable instance.
`static <T> T`	`recordAsYaml(Class<T> tClass, PrintStream ps)` Creates and returns a proxy of the specified interface.
`static int`	`removeMaskedTidFromHeader(int header)` Removes masked thread ID from a given header.
`static void`	`replay(String file, Object obj)` Reads the content of a specified Yaml file and replays the serialized method calls to the specified object.
`static void`	`reset(@NotNull Object o)` Resets the specified object's state to its default.
`static void`	`setField(@NotNull Object o, String name, Object value)` Sets the value of a specific field in an object.
`static void`	`setLongField(@NotNull Object o, String name, long value)` Sets the long value of a specific field in an object.
`static int`	`toIntU30(long l, @NotNull String error)` Converts a long value to an int, ensuring it falls within the 30-bit range.
`static <T> T`	`tupleFor(Class<T> tClass, String typeName)` Returns a tuple for the specified class and type name.
`static String`	`typeNameFor(net.openhft.chronicle.core.pool.ClassLookup classLookup, @NotNull Object value)` Fetches the type name for the provided object using the specified class lookup mechanism.
`static String`	`typeNameFor(@NotNull Object value)` Fetches the type name for the provided object using a default class alias pool.
`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)` Writes data to the given WireOut using the provided writer.
`static void`	`writeKey(@NotNull Object marshallable, net.openhft.chronicle.bytes.Bytes<?> bytes)` Writes the key associated with the marshallable object to the provided bytes.
`static void`	`writeMarshallable(@NotNull Object marshallable, @NotNull WireOut wire)` Writes a marshallable object's fields to a WireOut instance.
`static void`	`writeMarshallable(@NotNull Object marshallable, @NotNull WireOut wire, boolean writeDefault)` Writes a marshallable object's fields to a WireOut instance with an option to use defaults.
`static void`	`writeMarshallable(@NotNull Object marshallable, @NotNull WireOut wire, @NotNull Object previous, boolean copy)` Writes a marshallable object's fields to a WireOut instance considering previous state.

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()
```
    A utility method to force the static initialization of this enum. Calling this method ensures that the static initializer block is executed.
  - 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. This is useful when there's a need to serialize method calls in a readable Yaml format.
    
    Type Parameters:
    
    T - the type of the specified interface
    
    Parameters:
    
    tClass - the specified interface class to create a proxy of
    
    ps - the PrintStream used to write serialized method calls into, in Yaml format
    
    Returns:
    
    a proxy of the specified interface that writes to the PrintStream in Yaml
  - 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 replays the serialized method calls to the specified object. This can be used to re-execute or simulate a sequence of operations captured in the Yaml file.
    
    Parameters:
    
    file - the name of the input Yaml file containing serialized method calls
    
    obj - the target object that the method calls will be replayed on
    
    Throws:
    
    IOException - is thrown if there's an error reading the file
    
    net.openhft.chronicle.core.io.InvalidMarshallableException - is thrown if the serialized data is invalid or corrupted
  - 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)
```
    Converts the provided bytes, which represent aligned size-prefixed blobs, into a readable string format.
    
    Parameters:
    
    bytes - the bytes representing aligned size-prefixed blobs
    
    Returns:
    
    the readable string representation of the blobs
  - fromSizePrefixedBlobs
```
public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                                           boolean abbrev)
```
    Converts the provided bytes, representing size-prefixed blobs, into a readable string format with the option to abbreviate.
    
    Parameters:
    
    bytes - the bytes representing size-prefixed blobs
    
    abbrev - if true, the output string will be abbreviated
    
    Returns:
    
    the readable string representation of the blobs
  - fromSizePrefixedBlobs
```
public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                                           long position)
```
    Converts the provided bytes, representing size-prefixed blobs, into a readable string format from the specified position.
    
    Parameters:
    
    bytes - the bytes representing size-prefixed blobs
    
    position - the position in bytes from which the conversion starts
    
    Returns:
    
    the readable string representation of the blobs from the specified position
  - fromSizePrefixedBlobs
```
public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                                           long position,
                                           boolean padding)
```
    Converts the provided bytes, representing size-prefixed blobs, into a readable string format from a specified position and with the option to pad.
    
    Parameters:
    
    bytes - the bytes representing size-prefixed blobs
    
    position - the position in bytes from which the conversion starts
    
    padding - if true, the output string will have padding
    
    Returns:
    
    the readable string representation of the blobs from the specified position
  - fromSizePrefixedBlobs
```
public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                                           boolean padding,
                                           boolean abbrev)
```
    Converts the provided bytes, which represent size-prefixed blobs, into a readable string format with options for padding and abbreviation.
    
    Parameters:
    
    bytes - the bytes representing size-prefixed blobs
    
    padding - if true, the output string will have padding
    
    abbrev - if true, the output string will be abbreviated
    
    Returns:
    
    the readable string representation of the blobs
  - fromSizePrefixedBlobs
```
public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull DocumentContext dc)
```
    Converts the contents of the provided DocumentContext which represent size-prefixed blobs into a readable string format. The method supports handling of both TextWire and BinaryWire types.
    
    Parameters:
    
    dc - the DocumentContext holding the wire data
    
    Returns:
    
    the readable string representation of the blobs
  - fromSizePrefixedBlobs
```
public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull WireIn wireIn)
```
    Converts the contents of the provided WireIn which represent size-prefixed blobs into a readable string format.
    
    Parameters:
    
    wireIn - the WireIn instance holding the wire data
    
    Returns:
    
    the readable string representation of the blobs
  - fromSizePrefixedBlobs
```
public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull WireIn wireIn,
                                           boolean abbrev)
```
    Converts the contents of the provided WireIn which represent size-prefixed blobs into a readable string format, with the option to abbreviate the output.
    
    Parameters:
    
    wireIn - the WireIn instance holding the wire data
    
    abbrev - if true, the output string will be abbreviated
    
    Returns:
    
    the readable string representation of the blobs
  - asText
```
@NotNull
public static @NotNull CharSequence asText(@NotNull
                                                    @NotNull WireIn wireIn,
                                                    net.openhft.chronicle.bytes.Bytes<?> output)
```
  - 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
```
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
  - acquireStringBuilderScoped
```
public static net.openhft.chronicle.core.scoped.ScopedResource<StringBuilder> acquireStringBuilderScoped()
```
  - lengthOf
```
public static int lengthOf(int len)
```
    Extracts the length from the given length value.
    
    Parameters:
    
    len - the encoded length
    
    Returns:
    
    the decoded length
  - isReady
```
public static boolean isReady(int header)
```
    Checks if the given header is ready (complete and not zero).
    
    Parameters:
    
    header - the input header
    
    Returns:
    
    true if the header is ready, false otherwise
  - isNotComplete
```
public static boolean isNotComplete(int header)
```
    Checks if the given header is not complete or zero.
    
    Parameters:
    
    header - the input header
    
    Returns:
    
    true if the header is not complete or zero, false otherwise
  - isReadyData
```
public static boolean isReadyData(int header)
```
    Checks if the given header represents ready data (neither meta-data nor incomplete) and is not zero.
    
    Parameters:
    
    header - the input header
    
    Returns:
    
    true if the header represents ready data, false otherwise
  - isData
```
public static boolean isData(int len)
```
    Checks if the given length represents data and not meta-data.
    
    Parameters:
    
    len - the encoded length
    
    Returns:
    
    true if the length represents data, false otherwise
  - isReadyMetaData
```
public static boolean isReadyMetaData(int len)
```
    Checks if the given length represents ready meta-data.
    
    Parameters:
    
    len - the encoded length
    
    Returns:
    
    true if the length represents ready meta-data, false otherwise
  - isKnownLength
```
public static boolean isKnownLength(int len)
```
    Checks if the given length represents a known length (neither unknown nor meta-data).
    
    Parameters:
    
    len - the encoded length
    
    Returns:
    
    true if the length is known, false otherwise
  - isNotInitialized
```
public static boolean isNotInitialized(int len)
```
    Checks if the given length is not initialized.
    
    Parameters:
    
    len - the encoded length
    
    Returns:
    
    true if the length is not initialized, false otherwise
  - toIntU30
```
public static int toIntU30(long l,
                           @NotNull
                           @NotNull String error)
```
    Converts a long value to an int, ensuring it falls within the 30-bit range.
    
    Parameters:
    
    l - the input long value
    
    error - the error message template in case of an out-of-range value
    
    Returns:
    
    the converted int value
    
    Throws:
    
    IllegalStateException - if the value is out of the 30-bit range
  - acquireLock
```
public static boolean acquireLock(@NotNull
                                  @NotNull net.openhft.chronicle.bytes.BytesStore<?,?> store,
                                  long position)
```
    Acquires a lock on the given BytesStore at the specified position.
    
    Parameters:
    
    store - the byte store to lock
    
    position - the position at which to lock
    
    Returns:
    
    true if the lock was successfully acquired, false otherwise
  - exceedsMaxLength
```
public static boolean exceedsMaxLength(long length)
```
    Checks if the given length exceeds the maximum allowed length.
    
    Parameters:
    
    length - the length to check
    
    Returns:
    
    true if the length exceeds the maximum, false otherwise
  - writeData
```
public static <T extends WriteMarshallable> long writeData(@NotNull
                                                           @NotNull WireOut wireOut,
                                                           @NotNull
                                                           T writer)
                                                    throws net.openhft.chronicle.core.io.InvalidMarshallableException
```
    Writes data to the given WireOut using the provided writer. It is inlined for performance optimization.
    
    Parameters:
    
    wireOut - the destination to write data
    
    writer - the WriteMarshallable instance to write data
    
    Returns:
    
    the position after writing the data
    
    Throws:
    
    net.openhft.chronicle.core.io.InvalidMarshallableException - if marshalling fails
  - readWire
```
public static long readWire(@NotNull
                            @NotNull WireIn wireIn,
                            long size,
                            @NotNull
                            @NotNull ReadMarshallable readMarshallable)
                     throws net.openhft.chronicle.core.io.InvalidMarshallableException
```
    Reads data from a WireIn up to a specified size using a ReadMarshallable instance.
    
    Parameters:
    
    wireIn - the source from which data is read
    
    size - the maximum size of data to be read
    
    readMarshallable - the ReadMarshallable instance to interpret the data
    
    Returns:
    
    the position in the bytes after reading
    
    Throws:
    
    net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an issue during marshalling
  - acquireBytesScoped
```
@NotNull
public static @NotNull net.openhft.chronicle.core.scoped.ScopedResource<net.openhft.chronicle.bytes.Bytes<Void>> acquireBytesScoped()
```
  - acquireBinaryWireScoped
```
public static net.openhft.chronicle.core.scoped.ScopedResource<Wire> acquireBinaryWireScoped()
```
  - fromSizePrefixedBlobs
```
public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                                           long position,
                                           long length)
```
    Creates a string representation of a specific portion of size-prefixed blob data.
    
    Parameters:
    
    bytes - the source of the blob data
    
    position - the starting position for extraction
    
    length - the length of data to extract
    
    Returns:
    
    a string representation of the extracted data
  - readMarshallable
```
public static void readMarshallable(@NotNull
                                    @NotNull Object marshallable,
                                    @NotNull
                                    @NotNull WireIn wire,
                                    boolean overwrite)
                             throws net.openhft.chronicle.core.io.InvalidMarshallableException
```
    Reads a Marshallable object's fields from a WireIn instance.
    
    Parameters:
    
    marshallable - the object whose fields need to be populated
    
    wire - the source from which data will be read
    
    overwrite - a flag indicating whether existing fields should be overwritten
    
    Throws:
    
    net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an issue during the marshalling process
  - readMarshallable
```
public static void readMarshallable(Class<?> clazz,
                                    @NotNull
                                    @NotNull Object marshallable,
                                    @NotNull
                                    @NotNull WireIn wire,
                                    boolean overwrite)
                             throws net.openhft.chronicle.core.io.InvalidMarshallableException
```
    Reads a Marshallable object's fields from a WireIn instance using a specified class type.
    
    Parameters:
    
    clazz - the class type of the Marshallable object
    
    marshallable - the object whose fields need to be populated
    
    wire - the source from which data will be read
    
    overwrite - a flag indicating whether existing fields should be overwritten
    
    Throws:
    
    net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an issue during the marshalling process
  - writeMarshallable
```
public static void writeMarshallable(@NotNull
                                     @NotNull Object marshallable,
                                     @NotNull
                                     @NotNull WireOut wire)
                              throws net.openhft.chronicle.core.io.InvalidMarshallableException
```
    Writes a marshallable object's fields to a WireOut instance.
    
    Parameters:
    
    marshallable - the object whose fields are to be written
    
    wire - the target WireOut to write data to
    
    Throws:
    
    net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an error during the marshalling process
  - writeMarshallable
```
public static void writeMarshallable(@NotNull
                                     @NotNull Object marshallable,
                                     @NotNull
                                     @NotNull WireOut wire,
                                     boolean writeDefault)
                              throws net.openhft.chronicle.core.io.InvalidMarshallableException
```
    Writes a marshallable object's fields to a WireOut instance with an option to use defaults.
    
    Parameters:
    
    marshallable - the object to be written
    
    wire - the target WireOut to write data to
    
    writeDefault - indicates if default values should be written
    
    Throws:
    
    net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an error during the marshalling process
  - 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
```
    Writes a marshallable object's fields to a WireOut instance considering previous state.
    
    Parameters:
    
    marshallable - the object to be written
    
    wire - the target WireOut to write data to
    
    previous - the previous state of the marshallable object
    
    copy - indicates if the previous state should be copied
    
    Throws:
    
    net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an error during the marshalling process
  - writeKey
```
public static void writeKey(@NotNull
                            @NotNull Object marshallable,
                            net.openhft.chronicle.bytes.Bytes<?> bytes)
```
    Writes the key associated with the marshallable object to the provided bytes.
    
    Parameters:
    
    marshallable - the object whose key needs to be written
    
    bytes - the target bytes to write the key to
  - deepCopy
```
@NotNull
public static <T extends Marshallable> T deepCopy(@NotNull
                                                           T marshallable)
                                                    throws net.openhft.chronicle.core.io.InvalidMarshallableException
```
    Creates a deep copy of the provided marshallable object.
    
    Type Parameters:
    
    T - the type of marshallable object
    
    Parameters:
    
    marshallable - the object to be deeply copied
    
    Returns:
    
    a new instance that's a deep copy of the provided marshallable
    
    Throws:
    
    net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an error during the copy process
  - copyTo
```
@NotNull
public static <T> T copyTo(Object source,
                                    @NotNull
                                    T target)
                             throws net.openhft.chronicle.core.io.InvalidMarshallableException
```
    Copy fields from source to target by marshalling out and then in. Allows copying of fields by name even if there is no type relationship between the source and target
    
    Type Parameters:
    
    T - target type
    
    Parameters:
    
    source - source
    
    target - dest
    
    Returns:
    
    target
    
    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
```
    Projects the source object's fields into a new instance of a specified class.
    
    Type Parameters:
    
    T - Type of the target class
    
    Parameters:
    
    tClass - The target class type to project to
    
    source - The source object
    
    Returns:
    
    A new instance of type T with the projected fields
    
    Throws:
    
    net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an error during the projection process
  - isEquals
```
public static boolean isEquals(@NotNull
                               @NotNull Object o1,
                               @NotNull
                               @NotNull Object o2)
```
    Checks if two objects are of the same type and equal based on their serialized representation.
    
    Parameters:
    
    o1 - First object
    
    o2 - Second object
    
    Returns:
    
    true if objects are of the same type and equal, false otherwise
  - fieldInfos
```
@NotNull
public static @NotNull List<FieldInfo> fieldInfos(@NotNull
                                                           @NotNull Class<?> aClass)
```
    Retrieves the list of field information for a given class.
    
    Parameters:
    
    aClass - Class to retrieve field information for
    
    Returns:
    
    List of field information
  - fieldInfoMap
```
@NotNull
public static @NotNull Map<String,FieldInfo> fieldInfoMap(@NotNull
                                                                   @NotNull Class<?> aClass)
```
    Retrieves a map of field names to their information for a given class.
    
    Parameters:
    
    aClass - Class to retrieve field information for
    
    Returns:
    
    Map of field names to their information
  - fieldInfo
```
public static FieldInfo fieldInfo(@NotNull
                                  @NotNull Class<?> aClass,
                                  String name)
```
    Retrieves field information for a specific field of a given class.
    
    Parameters:
    
    aClass - Class to which the field belongs
    
    name - Field name
    
    Returns:
    
    Information about the field
  - isEndOfFile
```
public static boolean isEndOfFile(int num)
```
    Checks if a given integer represents the end of file marker.
    
    Parameters:
    
    num - Integer to check
    
    Returns:
    
    true if the integer represents end of file, false otherwise
  - getField
```
@Nullable
public static <T> T getField(@NotNull
                                       @NotNull Object o,
                                       String name,
                                       Class<T> tClass)
                                throws NoSuchFieldException
```
    Retrieves the value of a specific field from an object and converts it to the desired type.
    
    Type Parameters:
    
    T - Type parameter representing the desired type
    
    Parameters:
    
    o - Object to retrieve the field value from
    
    name - Field name
    
    tClass - Desired type to convert the field value to
    
    Returns:
    
    The field value converted to the desired type
    
    Throws:
    
    NoSuchFieldException - if the field doesn't exist
  - getLongField
```
public static long getLongField(@NotNull
                                @NotNull Object o,
                                String name)
                         throws NoSuchFieldException
```
    Retrieves the long value of a specific field from an object.
    
    Parameters:
    
    o - Object to retrieve the field value from
    
    name - Field name
    
    Returns:
    
    The long value of the specified field
    
    Throws:
    
    NoSuchFieldException - if the specified field doesn't exist
  - setField
```
public static void setField(@NotNull
                            @NotNull Object o,
                            String name,
                            Object value)
                     throws NoSuchFieldException
```
    Sets the value of a specific field in an object.
    
    Parameters:
    
    o - Object in which the field value will be set
    
    name - Field name
    
    value - New value to set
    
    Throws:
    
    NoSuchFieldException - if the specified field doesn't exist
  - setLongField
```
public static void setLongField(@NotNull
                                @NotNull Object o,
                                String name,
                                long value)
                         throws NoSuchFieldException
```
    Sets the long value of a specific field in an object.
    
    Parameters:
    
    o - Object in which the field value will be set
    
    name - Field name
    
    value - New long value to set
    
    Throws:
    
    NoSuchFieldException - if the specified field doesn't exist
  - reset
```
public static void reset(@NotNull
                         @NotNull Object o)
```
    Resets the specified object's state to its default. The specifics of the reset operation are determined by the associated WireMarshaller.
    
    Parameters:
    
    o - Object to be reset
  - removeMaskedTidFromHeader
```
public static int removeMaskedTidFromHeader(int header)
```
    Removes masked thread ID from a given header.
    
    Parameters:
    
    header - The header with a potentially masked thread ID
    
    Returns:
    
    The header without the masked thread ID
  - objectSequence
```
@Nullable
public static <E> E objectSequence(ValueIn in,
                                             @Nullable
                                             E using,
                                             @Nullable
                                             @Nullable Class<? extends E> clazz,
                                             SerializationStrategy strategy)
```
    Reads a sequence of objects using a specified serialization strategy.
    
    Type Parameters:
    
    E - Type parameter of the object sequence
    
    Parameters:
    
    in - ValueIn instance providing the input data
    
    using - Optional object to read the data into (can be null)
    
    clazz - Class type of the object sequence, can be null for generic Object
    
    strategy - Serialization strategy to use for reading the sequence
    
    Returns:
    
    A sequence of objects read using the provided serialization strategy
  - objectMap
```
@Nullable
public static <E> E objectMap(ValueIn in,
                                        @Nullable
                                        E using,
                                        @Nullable
                                        @Nullable Class<? extends E> clazz,
                                        @NotNull
                                        @NotNull SerializationStrategy strategy)
                                 throws net.openhft.chronicle.core.io.InvalidMarshallableException
```
    Reads a map of objects from the given input, using a specified serialization strategy.
    
    Type Parameters:
    
    E - Type parameter of the object map
    
    Parameters:
    
    in - ValueIn instance providing the input data
    
    using - Optional object to read the data into (can be null)
    
    clazz - Class type of the object map, can be null for generic Object
    
    strategy - Serialization strategy to use for reading the map
    
    Returns:
    
    A map of objects read using the provided serialization strategy
    
    Throws:
    
    net.openhft.chronicle.core.io.InvalidMarshallableException - If the deserialization process encounters an error
  - objectDate
```
@NotNull
public static <E> E objectDate(ValueIn in,
                                        @Nullable
                                        E using)
```
    Reads a date object from the given input.
    
    Type Parameters:
    
    E - Expected type (often Date) to be returned
    
    Parameters:
    
    in - ValueIn instance providing the input data
    
    using - Optional Date object to read the data into (can be null)
    
    Returns:
    
    A Date object representing the read date
  - object0
```
@Nullable
public static <E> E object0(ValueIn in,
                                      @Nullable
                                      E using,
                                      @Nullable
                                      @Nullable Class<? extends E> clazz)
                               throws net.openhft.chronicle.core.io.InvalidMarshallableException
```
    Reads and validates an object from the given input.
    
    Type Parameters:
    
    E - Type parameter of the object
    
    Parameters:
    
    in - ValueIn instance providing the input data
    
    using - Optional object to read the data into (can be null)
    
    clazz - Class type of the object, can be null for generic Object
    
    Returns:
    
    The validated object read from the input
    
    Throws:
    
    net.openhft.chronicle.core.io.InvalidMarshallableException - If the deserialization process encounters an error
  - object0
```
public static <E> E object0(ValueIn in,
                            @Nullable
                            E using,
                            @Nullable
                            @Nullable Class<? extends E> clazz,
                            boolean bestEffort)
                     throws net.openhft.chronicle.core.io.InvalidMarshallableException
```
    Deserialize an object from the provided input and validate it.
    
    Type Parameters:
    
    E - The type of the object being deserialized.
    
    Parameters:
    
    in - The input source to read the serialized data from.
    
    using - An optional object to populate with the deserialized data. Can be null.
    
    clazz - The expected class type of the deserialized object. Can be null.
    
    bestEffort - Flag to determine the effort in deserialization. If false, exceptions may be thrown for mismatches.
    
    Returns:
    
    The deserialized and validated object.
    
    Throws:
    
    net.openhft.chronicle.core.io.InvalidMarshallableException - If an error occurs during deserialization.
  - object1
```
public static <E> E object1(ValueIn in,
                            @Nullable
                            E using,
                            @Nullable
                            @Nullable Class<? extends E> clazz,
                            boolean bestEffort)
                     throws net.openhft.chronicle.core.io.InvalidMarshallableException
```
    Deserialize an object from the provided input based on the defined strategy and constraints.
    
    Type Parameters:
    
    E - The type of the object being deserialized.
    
    Parameters:
    
    in - The input source to read the serialized data from.
    
    using - An optional object to populate with the deserialized data. Can be null.
    
    clazz - The expected class type of the deserialized object. Can be null.
    
    bestEffort - Flag to determine the effort in deserialization. If false, exceptions may be thrown for mismatches.
    
    Returns:
    
    The deserialized object.
    
    Throws:
    
    net.openhft.chronicle.core.io.InvalidMarshallableException - If an error occurs during deserialization.
  - dtoInterface
```
public static boolean dtoInterface(Class<?> clazz)
```
    Determines if the provided class is an interface and qualifies as a DTO (Data Transfer Object).
    
    Parameters:
    
    clazz - The class to check.
    
    Returns:
    
    True if the class is considered a DTO interface, false otherwise.
  - typeNameFor
```
public static String typeNameFor(@NotNull
                                 @NotNull Object value)
```
    Fetches the type name for the provided object using a default class alias pool.
    
    Parameters:
    
    value - The object whose type name is to be fetched.
    
    Returns:
    
    The type name of the object.
  - typeNameFor
```
public static String typeNameFor(net.openhft.chronicle.core.pool.ClassLookup classLookup,
                                 @NotNull
                                 @NotNull Object value)
```
    Fetches the type name for the provided object using the specified class lookup mechanism.
    
    Parameters:
    
    classLookup - The class lookup mechanism to use.
    
    value - The object whose type name is to be fetched.
    
    Returns:
    
    The type name of the object.
  - tupleFor
```
@Nullable
public static <T> T tupleFor(Class<T> tClass,
                                       String typeName)
```
    Returns a tuple for the specified class and type name.
    
    Type Parameters:
    
    T - The type parameter.
    
    Parameters:
    
    tClass - The class type for which the tuple is required.
    
    typeName - The type name.
    
    Returns:
    
    A tuple of type T or null if not possible to create.
  - isInternal
```
public static boolean isInternal(@NotNull
                                 @NotNull Object value)
```
    Determines if the value's package name is internal to Java.
    
    Parameters:
    
    value - The object to check.
    
    Returns:
    
    True if the object's package name is internal, false otherwise.
  - binaryWireForRead
```
@NotNull
public static @NotNull BinaryWire binaryWireForRead(net.openhft.chronicle.bytes.Bytes<?> in,
                                                             long position,
                                                             long length)
```
    Creates a BinaryWire for reading with the given input, position, and length.
    
    Parameters:
    
    in - The input bytes.
    
    position - The starting position.
    
    length - The length of data to read.
    
    Returns:
    
    A BinaryWire configured for reading.
  - binaryWireForWrite
```
@NotNull
public static @NotNull BinaryWire binaryWireForWrite(net.openhft.chronicle.bytes.Bytes<?> in,
                                                              long position,
                                                              long length)
```
    Creates a BinaryWire for writing with the given input, position, and length.
    
    Parameters:
    
    in - The input bytes.
    
    position - The starting position.
    
    length - The length of data to write.
    
    Returns:
    
    A BinaryWire configured for writing.

Enum Wires

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Field Detail

LENGTH_MASK

NOT_COMPLETE

META_DATA

UNKNOWN_LENGTH

NOT_COMPLETE_UNKNOWN_LENGTH

END_OF_DATA

NOT_INITIALIZED

NO_BYTES

SPB_HEADER_SIZE

CLASS_STRATEGY_FUNCTIONS

GENERATE_TUPLES

Method Detail

values

valueOf

init

recordAsYaml

replay

fromSizePrefixedBlobs

fromAlignedSizePrefixedBlobs

fromSizePrefixedBlobs

fromSizePrefixedBlobs

fromSizePrefixedBlobs

fromSizePrefixedBlobs

fromSizePrefixedBlobs

fromSizePrefixedBlobs

fromSizePrefixedBlobs

asText

asBinary

asJson

acquireStringBuilderScoped

lengthOf

isReady

isNotComplete

isReadyData

isData

isReadyMetaData

isKnownLength

isNotInitialized

toIntU30

acquireLock

exceedsMaxLength

writeData

readWire

acquireBytesScoped

acquireBinaryWireScoped

fromSizePrefixedBlobs

readMarshallable

readMarshallable

writeMarshallable

writeMarshallable

writeMarshallable

writeKey

deepCopy

copyTo

project

isEquals

fieldInfos

fieldInfoMap

fieldInfo

isEndOfFile

getField

getLongField

setField

setLongField

reset

removeMaskedTidFromHeader

objectSequence

objectMap

objectDate

object0

object0

object1

dtoInterface

typeNameFor