com.swirlds.common.io.exceptions.InvalidStreamPosition Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swirlds-common Show documentation

Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.

There is a newer version: 0.56.6

Show newest version

/*
 * Copyright (C) 2019-2024 Hedera Hashgraph, LLC
 *
 * 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 com.swirlds.common.io.exceptions;

import java.io.IOException;

public class InvalidStreamPosition extends IOException {

    /**
     * Constructs an {@code IOException} with {@code null}
     * as its error detail message.
     */
    public InvalidStreamPosition() {}

    /**
     * Constructs an {@code IOException} with the specified detail message.
     *
     * @param message
     * 		The detail message (which is saved for later retrieval
     * 		by the {@link #getMessage()} method)
     */
    public InvalidStreamPosition(final String message) {
        super(message);
    }

    /**
     * Constructs an {@code IOException} with the specified detail message
     * and cause.
     *
     *  Note that the detail message associated with {@code cause} is
     * not automatically incorporated into this exception's detail
     * message.
     *
     * @param message
     * 		The detail message (which is saved for later retrieval
     * 		by the {@link #getMessage()} method)
     * @param cause
     * 		The cause (which is saved for later retrieval by the
     *        {@link #getCause()} method).  (A null value is permitted,
     * 		and indicates that the cause is nonexistent or unknown.)
     * @since 1.6
     */
    public InvalidStreamPosition(final String message, final Throwable cause) {
        super(message, cause);
    }

    /**
     * Constructs an {@code IOException} with the specified cause and a
     * detail message of {@code (cause==null ? null : cause.toString())}
     * (which typically contains the class and detail message of {@code cause}).
     * This constructor is useful for IO exceptions that are little more
     * than wrappers for other throwables.
     *
     * @param cause
     * 		The cause (which is saved for later retrieval by the
     *        {@link #getCause()} method).  (A null value is permitted,
     * 		and indicates that the cause is nonexistent or unknown.)
     * @since 1.6
     */
    public InvalidStreamPosition(final Throwable cause) {
        super(cause);
    }

    public InvalidStreamPosition(final long expectedValue, final long actualValue) {
        super(String.format("Invalid value %d read from the stream, expected %d instead.", actualValue, expectedValue));
    }

    public InvalidStreamPosition(final String markerName, final long expectedValue, final long actualValue) {
        super(String.format(
                "Invalid value %d read from the stream, expected %d (%s) instead.",
                actualValue, expectedValue, markerName));
    }
}