Resource.java

/*
 * Copyright (c) 2002-2017 "Neo Technology,"
 * Network Engine for Objects in Lund AB [http://neotechnology.com]
 *
 * This file is part of Neo4j.
 *
 * 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.neo4j.driver.v1.util;

/**
 * A Resource is an {@link AutoCloseable} that allows introspecting if it
 * already has been closed through its {@link #isOpen()} method.
 *
 * Additionally, calling {@link AutoCloseable#close()} twice is expected to fail
 * (i.e. is not idempotent).
 * @since 1.0
 */
public interface Resource extends AutoCloseable
{
    /**
     * Detect whether this resource is still open
     *
     * @return true if the resource is open
     */
    boolean isOpen();

    /**
     * @throws IllegalStateException if already closed
     */
    @Override
    void close();
}