io.hekate.codec.DataWriter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hekate-core Show documentation
Java library for cluster communications and computing.
There is a newer version: 4.1.3
/*
 * Copyright 2020 The Hekate Project
 *
 * The Hekate Project licenses this file to you 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 io.hekate.codec;

import java.io.DataOutput;
import java.io.IOException;
import java.io.OutputStream;
import java.math.BigDecimal;
import java.math.BigInteger;

/**
 * Data writer.
 *
 * @see Codec
 */
public interface DataWriter extends DataOutput {
    /**
     * Casts this writer to the {@link OutputStream} interface.
     *
     * @return This writer as {@link OutputStream}.
     */
    OutputStream asStream();

    /**
     * Returns the number of bytes written to this writer so far.
     *
     * @return Number of bytes written to this writer so far.
     */
    int size();

    /**
     * Writes {@link BigDecimal} value. The written value can be read via {@link DataReader#readBigDecimal()}.
     *
     * @param v Value.
     *
     * @throws IOException if failed to write value.
     */
    default void writeBigDecimal(BigDecimal v) throws IOException {
        CodecUtils.writeBigDecimal(v, this);
    }

    /**
     * Writes {@link BigInteger} value. The written value can be read via {@link DataReader#readBigInteger()}.
     *
     * @param v Value.
     *
     * @throws IOException if failed to write value.
     */
    default void writeBigInteger(BigInteger v) throws IOException {
        CodecUtils.writeBigInteger(v, this);
    }

    /**
     * Writes a variable-length {@code long} value. The written value can be read via {@link DataReader#readVarLong()}.
     *
     * @param v Value.
     *
     * @throws IOException if failed to write value.
     */
    default void writeVarLong(long v) throws IOException {
        CodecUtils.writeVarLong(v, this);
    }

    /**
     * Writes a variable-length {@code int} value. The written value can be read via {@link DataReader#readVarInt()}.
     *
     * @param v Value.
     *
     * @throws IOException if failed to write value.
     */
    default void writeVarInt(int v) throws IOException {
        CodecUtils.writeVarInt(v, this);
    }

    /**
     * Writes an unsigned variable-length {@code long} value. The written value can be read via {@link DataReader#readVarLongUnsigned()}.
     *
     * @param v Value.
     *
     * @throws IOException if failed to write value.
     */
    default void writeVarLongUnsigned(long v) throws IOException {
        CodecUtils.writeVarLongUnsigned(v, this);
    }

    /**
     * Writes an unsigned variable-length {@code int} value. The written value can be read via {@link DataReader#readVarIntUnsigned()}.
     *
     * @param v Value.
     *
     * @throws IOException if failed to write value.
     */
    default void writeVarIntUnsigned(int v) throws IOException {
        CodecUtils.writeVarIntUnsigned(v, this);
    }
}