Dépôt officiel du code source de l'ERP OpenConcerto

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 2011 OpenConcerto, by ILM Informatique. All rights reserved.
 * 
 * The contents of this file are subject to the terms of the GNU General Public License Version 3
 * only ("GPL"). You may not use this file except in compliance with the License. You can obtain a
 * copy of the License at http://www.gnu.org/licenses/gpl-3.0.html See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each file.
 */
 
 package org.openconcerto.utils.function;

import java.util.Objects;

import net.jcip.annotations.Immutable;

/**
 * A supplier returning a constant value.
 * 
 * @author sylvain
 * @param <T> the type of results supplied by this supplier.
 * @see FunctionalSupplier#getConstant(Object)
 */
@Immutable
public final class ConstantSupplier<T> extends FunctionalSupplier<T> {
    private final T value;

    ConstantSupplier(final T value) {
        super();
        this.value = value;
    }

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

    @Override
    public int hashCode() {
        return this.value == null ? 0 : this.value.hashCode();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (getClass() != obj.getClass())
            return false;
        final ConstantSupplier<?> other = (ConstantSupplier<?>) obj;
        return Objects.equals(this.value, other.value);
    }

    @Override
    public String toString() {
        return this.getClass().getSimpleName() + " of " + this.get();
    }
}