org.xnio.BrokenPipeException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xnio-api Show documentation

The API JAR of the XNIO project

There is a newer version: 3.8.16.Final

/*
 * JBoss, Home of Professional Open Source.
 *
 * Copyright 2012 Red Hat, Inc. and/or its affiliates, and individual
 * contributors as indicated by the @author tags.
 *
 * 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 org.xnio;

import java.io.IOException;

/**
 * An exception that signifies that a pipe, stream, or channel was closed from the read side while the write side was
 * still writing.
 *
 * @author David M. Lloyd
 */
public class BrokenPipeException extends IOException {

    /**
     * Constructs a {@code BrokenPipeException} with no detail message. The cause is not initialized, and may
     * subsequently be initialized by a call to {@link #initCause(Throwable) initCause}.
     */
    public BrokenPipeException() {
    }

    /**
     * Constructs a {@code BrokenPipeException} with the specified detail message. The cause is not initialized, and may
     * subsequently be initialized by a call to {@link #initCause(Throwable) initCause}.
     *
     * @param msg the detail message
     */
    public BrokenPipeException(final String msg) {
        super(msg);
    }

    /**
     * Constructs a {@code BrokenPipeException} with the specified cause. The detail message is set to:
     * (cause == null ? null : cause.toString())
     * (which typically contains the class and detail message of {@code cause}).
     *
     * @param cause the cause (which is saved for later retrieval by the {@link #getCause()} method)
     */
    public BrokenPipeException(final Throwable cause) {
        super(cause);
    }

    /**
     * Constructs a {@code BrokenPipeException} with the specified detail message and cause.
     *
     * @param msg the detail message
     * @param cause the cause (which is saved for later retrieval by the {@link #getCause()} method)
     */
    public BrokenPipeException(final String msg, final Throwable cause) {
        super(msg, cause);
    }
}