net.openhft.chronicle.bytes.WriteBytesMarshallable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of chronicle-bytes Show documentation
Chronicle-Bytes
The newest version!
/*
 * Copyright (c) 2016-2022 chronicle.software
 *
 *     https://chronicle.software
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.openhft.chronicle.bytes;

import net.openhft.chronicle.core.annotation.DontChain;
import net.openhft.chronicle.core.io.ClosedIllegalStateException;
import net.openhft.chronicle.core.io.InvalidMarshallableException;
import net.openhft.chronicle.core.io.ThreadingIllegalStateException;

import java.nio.BufferOverflowException;

/**
 * An interface defining a contract for serializing data directly to a Bytes instance.
 * Objects implementing this interface can be marshalled into a sequence of bytes.
 *
 * @see net.openhft.chronicle.core.io.Validatable
 */
@FunctionalInterface
@DontChain
public interface WriteBytesMarshallable extends CommonMarshallable {

    /**
     * Serializes this object to the provided Bytes instance.
     *
     * This method is responsible for calling
     * {@link net.openhft.chronicle.core.io.Validatable#validate()} as needed to ensure
     * the validity of the state of the object before serialization.
     *
     * @param bytes the {@link BytesOut} instance to write the object's state to.
     * @throws BufferOverflowException        If there is no more space left to write in the buffer.
     * @throws InvalidMarshallableException   If the object cannot be successfully serialized.
     * @throws ClosedIllegalStateException    If the resource has been released or closed.
     * @throws ThreadingIllegalStateException If this resource was accessed by multiple threads in an unsafe way
     */
    void writeMarshallable(BytesOut bytes)
            throws IllegalStateException, BufferOverflowException, InvalidMarshallableException;
}