Wires (OpenHFT/Chronicle-Wire 2026.6 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>
```
Utility holder for low-level wire constants and helper methods.
This enum does not contain any enumeration values. It acts as a central hub for header flags and masks, static utility methods for common wire operations, and management of reusable resources such as StringBuilder pools and CachedCompiler instances.

Field Summary

Fields
Modifier and Type	Field and Description
`static List<Function<Class<?>,SerializationStrategy>>`	`CLASS_STRATEGY_FUNCTIONS` Registry of functions that determine the `SerializationStrategy` for a class.
`static int`	`END_OF_DATA` Combination of `NOT_COMPLETE` and `META_DATA` used to indicate no more data is expected, for example at end of a roll.
`static boolean`	`GENERATE_TUPLES` Flag indicating whether tuple generation is permitted via the `wire.generate.tuples` system property.
`static int`	`LENGTH_MASK` Mask for extracting the length from a 4 byte header.
`static int`	`META_DATA` Flag (`0x4000_0000`) marking the document as meta-data rather than data.
`static net.openhft.chronicle.bytes.Bytes<?>`	`NO_BYTES` Shared immutable `Bytes` instance representing an empty buffer.
`static int`	`NOT_COMPLETE` Flag (`0x8000_0000`) indicating that the following message is not yet complete.
`static int`	`NOT_COMPLETE_UNKNOWN_LENGTH` Combination of `NOT_COMPLETE` and `UNKNOWN_LENGTH` for incomplete messages of unknown size.
`static int`	`NOT_INITIALIZED` Value used for an uninitialised header (`0`).
`static int`	`SPB_HEADER_SIZE` Size in bytes of a Size-Prefixed Blob (SPB) header.
`static int`	`UNKNOWN_LENGTH` Value representing an unknown length (`0`).

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static net.openhft.chronicle.core.scoped.ScopedResource<Wire>`	`acquireBinaryWireScoped()` Obtains a pooled `BinaryWire` wrapped in a `ScopedResource` for temporary serialisation tasks.
`static @NotNull net.openhft.chronicle.core.scoped.ScopedResource<net.openhft.chronicle.bytes.Bytes<Void>>`	`acquireBytesScoped()` Provides a pooled `Bytes` instance wrapped in a `ScopedResource`.
`static boolean`	`acquireLock(@NotNull net.openhft.chronicle.bytes.BytesStore<?,?> store, long position)` Attempts to claim a 4 byte header by atomically swapping `NOT_INITIALIZED` with `NOT_COMPLETE`.
`static net.openhft.chronicle.core.scoped.ScopedResource<StringBuilder>`	`acquireStringBuilderScoped()` Obtains a `StringBuilder` from the thread-local pool wrapped in a `ScopedResource` so it is automatically returned when the scope is closed.
`static net.openhft.chronicle.bytes.Bytes<?>`	`asBinary(@NotNull WireIn wireIn, net.openhft.chronicle.bytes.Bytes<?> output)` Copies the contents of `wireIn` into `output` using a binary wire.
`static net.openhft.chronicle.bytes.Bytes<?>`	`asJson(@NotNull WireIn wireIn, net.openhft.chronicle.bytes.Bytes<?> output)` Converts `wireIn` to JSON and writes the result into `output`.
`static @NotNull CharSequence`	`asText(@NotNull WireIn wireIn, net.openhft.chronicle.bytes.Bytes<?> output)` Converts the contents of `wireIn` to a text (YAML-like) representation.
`static @NotNull BinaryWire`	`binaryWireForRead(net.openhft.chronicle.bytes.Bytes<?> in, long position, long length)` Provides a thread-local `BinaryWire` configured to read from the supplied byte store.
`static @NotNull BinaryWire`	`binaryWireForWrite(net.openhft.chronicle.bytes.Bytes<?> in, long position, long length)` Provides a thread-local `BinaryWire` configured for writing to the supplied byte store.
`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)` Dumps aligned size-prefixed blobs.
`static String`	`fromSizePrefixedBlobs(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)` Dumps a sequence of size-prefixed binary messages as a human readable string.
`static String`	`fromSizePrefixedBlobs(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, boolean abbrev)` Dumps size-prefixed blobs with optional abbreviation of long content.
`static String`	`fromSizePrefixedBlobs(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, boolean padding, boolean abbrev)` Dumps size-prefixed blobs with control over padding and abbreviation.
`static String`	`fromSizePrefixedBlobs(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, long position)` Dumps size-prefixed blobs starting at a given position.
`static String`	`fromSizePrefixedBlobs(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, long position, boolean padding)` Dumps size-prefixed blobs from a given position with optional padding.
`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)` Dumps the current document of the supplied `DocumentContext` as a sequence of size-prefixed blobs.
`static String`	`fromSizePrefixedBlobs(@NotNull WireIn wireIn)` Dumps the messages from a `WireIn` as a human readable string.
`static String`	`fromSizePrefixedBlobs(@NotNull WireIn wireIn, boolean abbrev)` Dumps the messages from a `WireIn` with optional abbreviation.
`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)` Returns `true` if the header denotes data rather than meta-data.
`static boolean`	`isEndOfFile(int num)` Returns `true` if the supplied header value denotes end of data.
`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)` Returns `true` if the header has a definite length value.
`static boolean`	`isNotComplete(int header)` Returns `true` if the header indicates an incomplete document or zero length.
`static boolean`	`isNotInitialized(int len)` Returns `true` if the header has not been initialised.
`static boolean`	`isReady(int header)` Returns `true` if the header denotes a complete document.
`static boolean`	`isReadyData(int header)` Tests whether a header represents completed data (not meta-data) and is non-zero.
`static boolean`	`isReadyMetaData(int len)` Returns `true` if the header is marked as meta-data and the document is complete.
`static int`	`lengthOf(int len)` Extracts the pure length from a 4 byte header value, removing flags such as `NOT_COMPLETE` and `META_DATA`.
`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 `l` to a 30 bit unsigned int.
`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
```
    Mask for extracting the length from a 4 byte header. Only the lower 30 bits are used for the length value.
    
    See Also:
    
    Constant Field Values
  - NOT_COMPLETE
```
public static final int NOT_COMPLETE
```
    Flag (0x8000_0000) indicating that the following message is not yet complete. Used in the length prefix of a size-prefixed blob.
    
    See Also:
    
    Constant Field Values
  - META_DATA
```
public static final int META_DATA
```
    Flag (0x4000_0000) marking the document as meta-data rather than data.
    
    See Also:
    
    Constant Field Values
  - UNKNOWN_LENGTH
```
public static final int UNKNOWN_LENGTH
```
    Value representing an unknown length (0).
    
    See Also:
    
    Constant Field Values
  - NOT_COMPLETE_UNKNOWN_LENGTH
```
public static final int NOT_COMPLETE_UNKNOWN_LENGTH
```
    Combination of NOT_COMPLETE and UNKNOWN_LENGTH for incomplete messages of unknown size.
    
    See Also:
    
    Constant Field Values
  - END_OF_DATA
```
public static final int END_OF_DATA
```
    Combination of NOT_COMPLETE and META_DATA used to indicate no more data is expected, for example at end of a roll.
    
    See Also:
    
    Constant Field Values
  - NOT_INITIALIZED
```
public static final int NOT_INITIALIZED
```
    Value used for an uninitialised header (0).
    
    See Also:
    
    Constant Field Values
  - NO_BYTES
```
public static final net.openhft.chronicle.bytes.Bytes<?> NO_BYTES
```
    Shared immutable Bytes instance representing an empty buffer.
  - SPB_HEADER_SIZE
```
public static final int SPB_HEADER_SIZE
```
    Size in bytes of a Size-Prefixed Blob (SPB) header.
    
    See Also:
    
    Constant Field Values
  - CLASS_STRATEGY_FUNCTIONS
```
public static final List<Function<Class<?>,SerializationStrategy>> CLASS_STRATEGY_FUNCTIONS
```
    Registry of functions that determine the SerializationStrategy for a class.
  - GENERATE_TUPLES
```
public static boolean GENERATE_TUPLES
```
    Flag indicating whether tuple generation is permitted via the wire.generate.tuples system property.
- 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)
```
    Dumps a sequence of size-prefixed binary messages as a human readable string. The first four bytes of each message contain the length and status flags. See the Size Prefixed Blob specification.
    
    Parameters:
    
    bytes - the bytes containing the size-prefixed data
    
    Returns:
    
    the dump in text form
  - fromAlignedSizePrefixedBlobs
```
public static String fromAlignedSizePrefixedBlobs(@NotNull
                                                  @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)
```
    Dumps aligned size-prefixed blobs. Alignment means each record may have padding between messages.
    
    Parameters:
    
    bytes - the bytes containing the aligned blobs
    
    Returns:
    
    textual dump of the messages
  - fromSizePrefixedBlobs
```
public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                                           boolean abbrev)
```
    Dumps size-prefixed blobs with optional abbreviation of long content.
    
    Parameters:
    
    bytes - the bytes containing the messages
    
    abbrev - if true long fields are abbreviated
    
    Returns:
    
    textual dump of the blobs
  - fromSizePrefixedBlobs
```
public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                                           long position)
```
    Dumps size-prefixed blobs starting at a given position.
    
    Parameters:
    
    bytes - the bytes containing the messages
    
    position - the offset in bytes to begin dumping
    
    Returns:
    
    textual dump of the remaining messages
  - fromSizePrefixedBlobs
```
public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                                           long position,
                                           boolean padding)
```
    Dumps size-prefixed blobs from a given position with optional padding.
    
    Parameters:
    
    bytes - the bytes containing the messages
    
    position - start position in bytes
    
    padding - whether message boundaries are padded
    
    Returns:
    
    textual dump of the blobs
  - fromSizePrefixedBlobs
```
public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                                           boolean padding,
                                           boolean abbrev)
```
    Dumps size-prefixed blobs with control over padding and abbreviation.
    
    Parameters:
    
    bytes - the bytes containing the messages
    
    padding - whether message boundaries are padded
    
    abbrev - whether long content should be abbreviated
    
    Returns:
    
    textual dump of the blobs
  - fromSizePrefixedBlobs
```
public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull DocumentContext dc)
```
    Dumps the current document of the supplied DocumentContext as a sequence of size-prefixed blobs. Both TextWire and BinaryWire contexts are supported.
    
    Parameters:
    
    dc - the document context whose content should be dumped
    
    Returns:
    
    textual dump of the blobs
  - fromSizePrefixedBlobs
```
public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull WireIn wireIn)
```
    Dumps the messages from a WireIn as a human readable string.
    
    Parameters:
    
    wireIn - the input wire
    
    Returns:
    
    textual dump of the blobs
  - fromSizePrefixedBlobs
```
public static String fromSizePrefixedBlobs(@NotNull
                                           @NotNull WireIn wireIn,
                                           boolean abbrev)
```
    Dumps the messages from a WireIn with optional abbreviation.
    
    Parameters:
    
    wireIn - the input wire
    
    abbrev - whether long content should be abbreviated
    
    Returns:
    
    textual dump of the blobs
  - asText
```
@NotNull
public static @NotNull CharSequence asText(@NotNull
                                                    @NotNull WireIn wireIn,
                                                    net.openhft.chronicle.bytes.Bytes<?> output)
```
    Converts the contents of wireIn to a text (YAML-like) representation.
    
    Parameters:
    
    wireIn - the source wire
    
    output - buffer to receive the text
    
    Returns:
    
    output containing the textual form
  - 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
```
    Copies the contents of wireIn into output using a binary wire.
    
    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
```
    Converts wireIn to JSON and writes the result into output.
    
    Throws:
    
    net.openhft.chronicle.core.io.InvalidMarshallableException
  - acquireStringBuilderScoped
```
public static net.openhft.chronicle.core.scoped.ScopedResource<StringBuilder> acquireStringBuilderScoped()
```
    Obtains a StringBuilder from the thread-local pool wrapped in a ScopedResource so it is automatically returned when the scope is closed.
  - lengthOf
```
public static int lengthOf(int len)
```
    Extracts the pure length from a 4 byte header value, removing flags such as NOT_COMPLETE and META_DATA.
  - isReady
```
public static boolean isReady(int header)
```
    Returns true if the header denotes a complete document.
  - isNotComplete
```
public static boolean isNotComplete(int header)
```
    Returns true if the header indicates an incomplete document or zero length.
  - isReadyData
```
public static boolean isReadyData(int header)
```
    Tests whether a header represents completed data (not meta-data) and is non-zero.
  - isData
```
public static boolean isData(int len)
```
    Returns true if the header denotes data rather than meta-data.
  - isReadyMetaData
```
public static boolean isReadyMetaData(int len)
```
    Returns true if the header is marked as meta-data and the document is complete.
  - isKnownLength
```
public static boolean isKnownLength(int len)
```
    Returns true if the header has a definite length value.
  - isNotInitialized
```
public static boolean isNotInitialized(int len)
```
    Returns true if the header has not been initialised.
  - toIntU30
```
public static int toIntU30(long l,
                           @NotNull
                           @NotNull String error)
```
    Converts l to a 30 bit unsigned int.
    
    Parameters:
    
    l - the value to convert
    
    error - error message used if l is outside 0..LENGTH_MASK
    
    Returns:
    
    l as an int
    
    Throws:
    
    IllegalStateException - if l is out of range
  - acquireLock
```
public static boolean acquireLock(@NotNull
                                  @NotNull net.openhft.chronicle.bytes.BytesStore<?,?> store,
                                  long position)
```
    Attempts to claim a 4 byte header by atomically swapping NOT_INITIALIZED with NOT_COMPLETE.
    
    Parameters:
    
    store - bytes containing the header
    
    position - offset of the header
    
    Returns:
    
    true if the lock was acquired
  - 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()
```
    Provides a pooled Bytes instance wrapped in a ScopedResource.
    
    Returns:
    
    the scoped bytes
  - acquireBinaryWireScoped
```
public static net.openhft.chronicle.core.scoped.ScopedResource<Wire> acquireBinaryWireScoped()
```
    Obtains a pooled BinaryWire wrapped in a ScopedResource for temporary serialisation tasks.
  - 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)
```
    Returns true if the supplied header value denotes end of data.
  - 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. The caller must check whether tuples are enabled before calling this method.
    
    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)
```
    Provides a thread-local BinaryWire configured to read from the supplied byte store. The returned wire shares the underlying bytes; no copy is made.
  - binaryWireForWrite
```
@NotNull
public static @NotNull BinaryWire binaryWireForWrite(net.openhft.chronicle.bytes.Bytes<?> in,
                                                              long position,
                                                              long length)
```
    Provides a thread-local BinaryWire configured for writing to the supplied byte store. The returned wire views the given bytes without copying.

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