OptionalDataException.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF 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 java.io;

/**
 * Signals that the {@link ObjectInputStream} class encountered a primitive type
 * ({@code int}, {@code char} etc.) instead of an object instance in the input
 * stream.
 *
 * @see ObjectInputStream#available()
 * @see ObjectInputStream#readObject()
 * @see ObjectInputStream#skipBytes(int)
 */
public class OptionalDataException extends ObjectStreamException {

    private static final long serialVersionUID = -8011121865681257820L;

    /**
     * {@code true} indicates that there is no more primitive data available.
     */
    public boolean eof;

    /**
     * The number of bytes of primitive data (int, char, long etc.) that are
     * available.
     */
    public int length;

    /**
     * Constructs a new {@code OptionalDataException} with its stack trace
     * filled in.
     */
    OptionalDataException() {
    }

    /**
     * Constructs a new {@code OptionalDataException} with its stack trace and
     * detail message filled in.
     *
     * @param detailMessage
     *            the detail message for this exception.
     */
    OptionalDataException(String detailMessage) {
        super(detailMessage);
    }
}