package org.apache.commons.jcs3.engine.memory.util;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

import java.lang.ref.SoftReference;

import org.apache.commons.jcs3.engine.behavior.ICacheElement;

/**
 * This wrapper is needed for double linked lists.
 */
public class SoftReferenceElementDescriptor<K, V>
    extends MemoryElementDescriptor<K, V>
{
    /** Don't change */
    private static final long serialVersionUID = -1905161209035522460L;

    /** The CacheElement wrapped by this descriptor */
    private final SoftReference<ICacheElement<K, V>> srce;

    /**
     * Constructs a usable MemoryElementDescriptor.
     * <p>
     * @param ce
     */
    public SoftReferenceElementDescriptor( ICacheElement<K, V> ce )
    {
        super( null );
        this.srce = new SoftReference<>(ce);
    }

    /**
     * @return the ce
     */
    @Override
    public ICacheElement<K, V> getCacheElement()
    {
        if (srce != null)
        {
            return srce.get();
        }

        return null;
    }
}