oracle.kv.TableAccessException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of oracle-nosql-server Show documentation

NoSQL Database Server - supplies build and runtime support for the server (store) side of the Oracle NoSQL Database.

There is a newer version: 18.3.10

/*-
 * Copyright (C) 2011, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This file was distributed by Oracle as part of a version of Oracle NoSQL
 * Database made available at:
 *
 * http://www.oracle.com/technetwork/database/database-technologies/nosqldb/downloads/index.html
 *
 * Please see the LICENSE file included in the top-level directory of the
 * appropriate version of Oracle NoSQL Database for a copy of the license and
 * additional information.
 */

package oracle.kv;

import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;

/**
 * Thrown when an operation to a table cannot be completed due to limits on
 * write and possibly read access.
 * 
 * @hiddensee {@link #writeFastExternal FastExternalizable format}
 */
public class TableAccessException extends ResourceLimitException {

    private static final long serialVersionUID = 1L;

    private final boolean readAllowed;

    /**
     * Constructs an instance of TableAccessException with
     * the specified table name and detail message. If readAllowed is true
     * read operations to the table are permitted.
     *
     * @param tableName the table name
     * @param readAllowed true if the table is read-only
     * @param msg the detail message
     * 
     * @hidden For internal use only
     */
    public TableAccessException(String tableName,
                                boolean readAllowed,
                                String msg) {
        super(tableName, msg);
        assert tableName != null;
        this.readAllowed = readAllowed;
    }

    /**
     * Creates an instance from the input stream.
     *
     * @hidden For internal use only
     */
    public TableAccessException(DataInput in, short serialVersion)
        throws IOException {

        super(in, serialVersion);
        readAllowed = in.readBoolean();
    }

    /**
     * Returns true is reads are allowed.
     *
     * @return true is reads are allowed
     * 
     * @hidden For internal use only
     */
    public boolean getReadAllowed() {
        return readAllowed;
    }

    /**
     * Writes the fields of this object to the output stream.  Format:
     * 
     *  ({@link ResourceLimitException}) {@code super}
     * 
 ({@link DataOutput#writeBoolean writeBoolean})
     *      {@link #getReadAllowed readAllowed}
     * 
     *
     * @hidden For internal use only
     */
    @Override
    public void writeFastExternal(DataOutput out, short serialVersion)
        throws IOException {
        super.writeFastExternal(out, serialVersion);
        out.writeBoolean(readAllowed);
    }
}