org.interledger.stream.StreamConnectionClosedException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of stream-core Show documentation
Core libraries for implementing the STREAM protocol.
There is a newer version: 1.3.1
package org.interledger.stream;

import java.util.Objects;

/**
 * A checked exception thrown when a Connection's sequence is too large or too small. This exception is checked so that
 * callers are forced to handle the error condition if a method throws it.
 */
public class StreamConnectionClosedException extends Exception {

  private final StreamConnectionId streamConnectionId;

  /**
   * Constructs a new runtime exception with {@code null} as its detail message.  The cause is not initialized, and may
   * subsequently be initialized by a call to {@link #initCause}.
   *
   * @param streamConnectionId A {@link StreamConnectionId} that uniquely identifies the {@link StreamConnection} that
   *                           emitted this exception.
   */
  public StreamConnectionClosedException(StreamConnectionId streamConnectionId) {
    super();
    this.streamConnectionId = Objects.requireNonNull(streamConnectionId);
  }

  /**
   * Constructs a new runtime exception with the specified detail message. The cause is not initialized, and may
   * subsequently be initialized by a call to {@link #initCause}.
   *
   * @param message            the detail message. The detail message is saved for later retrieval by the {@link
   *                           #getMessage()} method.
   * @param streamConnectionId A {@link StreamConnectionId} that uniquely identifies the {@link StreamConnection} that
   *                           emitted this exception.
   */
  public StreamConnectionClosedException(String message, StreamConnectionId streamConnectionId) {
    super(message);
    this.streamConnectionId = Objects.requireNonNull(streamConnectionId);
  }

  /**
   * Constructs a new runtime exception with the specified detail message and cause.
   *
   * Note that the detail message associated with {@code cause} is not
   * automatically incorporated in this runtime 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.)
   * @param streamConnectionId A {@link StreamConnectionId} that uniquely identifies the {@link StreamConnection} that
   *                           emitted this exception.
   *
   * @since 1.4
   */
  public StreamConnectionClosedException(String message, Throwable cause,
      StreamConnectionId streamConnectionId) {
    super(message, cause);
    this.streamConnectionId = Objects.requireNonNull(streamConnectionId);
  }

  /**
   * Constructs a new runtime exception with the specified cause and a detail message of (cause==null ? null :
   * cause.toString()) (which typically contains the class and detail message of
   * cause).  This constructor is useful for runtime 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.)
   * @param streamConnectionId A {@link StreamConnectionId} that uniquely identifies the {@link StreamConnection} that
   *                           emitted this exception.
   *
   * @since 1.4
   */
  public StreamConnectionClosedException(Throwable cause, StreamConnectionId streamConnectionId) {
    super(cause);
    this.streamConnectionId = Objects.requireNonNull(streamConnectionId);
  }

  /**
   * Constructs a new runtime exception with the specified detail message, cause, suppression enabled or disabled, and
   * writable stack trace enabled or disabled.
   *
   * @param message            the detail message.
   * @param cause              the cause.  (A {@code null} value is permitted, and indicates that the cause is
   *                           nonexistent or unknown.)
   * @param enableSuppression  whether or not suppression is enabled or disabled
   * @param writableStackTrace whether or not the stack trace should be writable
   * @param streamConnectionId A {@link StreamConnectionId} that uniquely identifies the {@link StreamConnection} that
   *                           emitted this exception.
   *
   * @since 1.7
   */
  protected StreamConnectionClosedException(String message, Throwable cause, boolean enableSuppression,
      boolean writableStackTrace, StreamConnectionId streamConnectionId) {
    super(message, cause, enableSuppression, writableStackTrace);
    this.streamConnectionId = Objects.requireNonNull(streamConnectionId);
  }

  /**
   * Returns a short description of this throwable. The result is the concatenation of:
   * 
   *  the {@linkplain Class#getName() name} of the class of this object
   * 
 ": " (a colon and a space)
   * 
 the result of invoking this object's {@link #getLocalizedMessage} method
   * 
 the result of invoking the {@link StreamConnectionId#value()} method
   * 
   * If {@code getLocalizedMessage} returns {@code null}, then just
   * the class name is returned.
   *
   * @return a string representation of this throwable.
   */
  public String toString() {
    String str = getClass().getName();
    String message = getLocalizedMessage() + " streamConnectionId=" + streamConnectionId.value();
    return (message != null) ? (str + ": " + message) : str;
  }
}