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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jboss-modules Show documentation
There is a newer version: 2.1.5.Final
/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2010, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.jboss.modules.ref;

import java.lang.ref.ReferenceQueue;

/**
 * A reapable soft 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.SoftReference
 *
 * @author David M. Lloyd
 */
public class SoftReference extends java.lang.ref.SoftReference implements Reference, Reapable {
    private final A attachment;
    private final Reaper reaper;

    public SoftReference(final T referent) {
        this(referent, null, (ReferenceQueue) null);
    }

    public SoftReference(final T referent, final A attachment) {
        this(referent, attachment, (ReferenceQueue) null);
    }

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

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

    public Reaper getReaper() {
        return reaper;
    }

    public A getAttachment() {
        return attachment;
    }

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

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