net.openhft.chronicle.wire.KeyedMarshallable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of chronicle-wire Show documentation

Chronicle-Wire

The newest version!

/*
 * Copyright 2016-2020 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.wire;

import net.openhft.chronicle.bytes.Bytes;
import org.jetbrains.annotations.NotNull;

public interface KeyedMarshallable {

    /**
     * Writes the key of the current instance into the provided {@code Bytes} object.
     * This default implementation utilizes the {@code Wires.writeKey} method.
     *
     * @param bytes The {@code Bytes} object into which the key of the current instance is written.
     */
    @SuppressWarnings("rawtypes")
    default void writeKey(@NotNull Bytes bytes) {
        Wires.writeKey(this, bytes);
    }
}