/*
 * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package jdk.internal.misc;

import java.lang.ref.Cleaner;

public interface JavaLangRefAccess {

    /**
     * Blocks until all Reference(s) that were pending at the time this method
     * was called have been enqueued.
     *
     * @throws InterruptedException if the thread is interrupted while waiting.
     */
    void awaitPendingReferencesEnqueued() throws InterruptedException;

    /**
     * Processes next Cleanable that has been waiting in the queue maintained
     * by given {@code cleaner}.
     *
     * @return {@code true} if a Cleanable was found in the queue and
     * was processed or {@code false} if the queue was empty.
     */
    boolean cleanNextEnqueuedCleanable(Cleaner cleaner);
}