net.openhft.chronicle.hash.serialization.BytesWriter Maven / Gradle / Ivy
/*
* Copyright 2012-2018 Chronicle Map Contributors
*
* 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.hash.serialization;
import net.openhft.chronicle.bytes.Bytes;
import net.openhft.chronicle.hash.ChronicleHashBuilder;
import net.openhft.chronicle.map.ChronicleMapBuilder;
import net.openhft.chronicle.wire.Marshallable;
import org.jetbrains.annotations.NotNull;
/**
* Serializer of objects to bytes, pairing {@link BytesReader}.
*
*
Read {@code
* BytesWriter} and {@code BytesReader} and
* custom
* serialization checklist sections in the Chronicle Map tutorial for more information on this
* interface, how to implement and use it properly.
*
* @param the type of objects serialized
* @see BytesReader
* @see ChronicleHashBuilder#keyMarshallers(BytesReader, BytesWriter)
* @see ChronicleMapBuilder#valueMarshallers(BytesReader, BytesWriter)
*/
public interface BytesWriter extends Marshallable {
/**
* Serializes the given object to the given {@code out}.
*
*
Implementation of this method should increment the {@linkplain Bytes#writePosition()
* position} of the given {@code out} by the number of bytes written. The given object should be
* written into these range between the initial {@code bytes}' position and the position after
* this method call returns. Bytes outside of this range shouldn't be written. Any bytes
* shouldn't be read from {@code out}.
*
* @param out the {@code Bytes} to write the given object to
* @param toWrite the object to serialize
*/
void write(Bytes out, @NotNull T toWrite);
}