me.lucko.helper.metadata.SoftValue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of helper Show documentation

A utility to reduce boilerplate code in Bukkit plugins.

There is a newer version: 5.6.14

/*
 * This file is part of helper, licensed under the MIT License.
 *
 *  Copyright (c) lucko (Luck) 
 *  Copyright (c) contributors
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy
 *  of this software and associated documentation files (the "Software"), to deal
 *  in the Software without restriction, including without limitation the rights
 *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *  copies of the Software, and to permit persons to whom the Software is
 *  furnished to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 *  SOFTWARE.
 */

package me.lucko.helper.metadata;

import com.google.common.base.Preconditions;

import java.lang.ref.SoftReference;

import javax.annotation.Nullable;

/**
 * Represents a value wrapped in a {@link SoftReference}
 *
 * @param  the wrapped value type
 */
public final class SoftValue implements TransientValue {

    public static  SoftValue of(T value) {
        Preconditions.checkNotNull(value, "value");
        return new SoftValue<>(value);
    }

    private final SoftReference value;

    private SoftValue(T value) {
        this.value = new SoftReference<>(value);
    }

    @Nullable
    @Override
    public T getOrNull() {
        return value.get();
    }

    @Override
    public boolean shouldExpire() {
        return value.get() == null;
    }

}