org.elasticsearch.util.base.FinalizablePhantomReference Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Show all versions of elasticsearch Show documentation
Open Source, Distributed, RESTful Search Engine
/*
* Copyright (C) 2007 Google Inc.
*
* 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.elasticsearch.util.base;
import java.lang.ref.PhantomReference;
/**
* Phantom reference with a {@code finalizeReferent()} method which a
* background thread invokes after the garbage collector reclaims the
* referent. This is a simpler alternative to using a {@link
* java.lang.ref.ReferenceQueue}.
*
* Unlike a normal phantom reference, this reference will be cleared
* automatically.
*
* @author Bob Lee
*/
public abstract class FinalizablePhantomReference
extends PhantomReference implements FinalizableReference {
/**
* Constructs a new finalizable phantom reference.
*
* @param referent to phantom reference
* @param queue that should finalize the referent
*/
protected FinalizablePhantomReference(T referent,
FinalizableReferenceQueue queue) {
super(referent, queue.queue);
queue.cleanUp();
}
}