net.openhft.chronicle.hash.serialization.BytesInterop Maven / Gradle / Ivy

Go to download

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

Chronicle-Map

There is a newer version: 3.27ea0

/*
 *     Copyright (C) 2015  higherfrequencytrading.com
 *
 *     This program is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU Lesser General Public License as published by
 *     the Free Software Foundation, either version 3 of the License.
 *
 *     This program is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU Lesser General Public License for more details.
 *
 *     You should have received a copy of the GNU Lesser General Public License
 *     along with this program.  If not, see .
 */

package net.openhft.chronicle.hash.serialization;

import net.openhft.lang.io.Bytes;
import net.openhft.lang.model.Byteable;

/**
 * Writer for objects, which themselves are bytes sequence in some sense:
 * {@link Byteable Byteables}, {@code byte[]} arrays, other primitive arrays, "flat" objects
 * (with primitives fields only), particularly boxed primitive types.
 *
 * This interface is called "BytesInterop" because it allows to work with object as they
 * are already marshalled to {@code Bytes}: {@linkplain #startsWith(Bytes, Object) compare}
 * with other {@code Bytes}, i. e. interoperate objects and {@code Bytes}.
 *
 * @param  type of marshalled objects
 */
public interface BytesInterop extends BytesWriter {

    /**
     * Checks if the given {@code bytes} starts (from the {@code bytes}' {@linkplain
     * Bytes#position() position}) with the byte sequence the given object
     * {@linkplain #write(Bytes, Object) is serialized} to, without actual serialization.
     *
     * @param bytes the bytes to check if starts with the serialized form of the given object.
     *              {@code bytes}' is positioned at the first byte to compare. {@code bytes}' limit
     *              is unspecified. {@code bytes}' position and limit shouldn't be altered during
     *              this call.
     * @param e the object to serialize virtually and compare with the given {@code bytes}
     * @return if the given {@code bytes} starts with the given {@code e} object's serialized form
     */
    boolean startsWith(Bytes bytes, E e);

    long hash(E e);
}