org.jboss.modules.ref.PhantomReference Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ceylon-complete Show documentation

There is a newer version: 1.3.3

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2014 Red Hat, Inc., and individual contributors
 * as indicated by the @author tags.
 *
 * 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.jboss.modules.ref;

import java.lang.ref.ReferenceQueue;

/**
 * A reapable phantom reference with an attachment.  If a {@link Reaper} is given, then it will be used to asynchronously
 * clean up the referent.
 *
 * @param  the reference value type
 * @param  the attachment type
 *
 * @see java.lang.ref.PhantomReference
 *
 * @author David M. Lloyd
 */
public class PhantomReference extends java.lang.ref.PhantomReference implements Reference, Reapable {
    private final A attachment;
    private final Reaper reaper;

    public PhantomReference(final T referent, final A attachment, final ReferenceQueue q) {
        super(referent, q);
        this.attachment = attachment;
        reaper = null;
    }

    public PhantomReference(final T referent, final A attachment, final Reaper reaper) {
        super(referent, References.ReaperThread.REAPER_QUEUE);
        this.reaper = reaper;
        this.attachment = attachment;
    }

    public A getAttachment() {
        return attachment;
    }

    public Type getType() {
        return Type.PHANTOM;
    }

    public Reaper getReaper() {
        return reaper;
    }

    public String toString() {
        return "phantom reference to " + String.valueOf(get());
    }
}