AbstractFaceProvider.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2015 The Gridarta Developers.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

package net.sf.gridarta.model.face;

import java.lang.ref.SoftReference;
import java.util.HashMap;
import java.util.Map;
import javax.swing.ImageIcon;
import org.apache.log4j.Category;
import org.apache.log4j.Logger;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public abstract class AbstractFaceProvider implements FaceProvider {

    @NotNull
    private static final Category LOG = Logger.getLogger(AbstractFaceProvider.class);

    @NotNull
    private final Map<String, SoftReference<ImageIcon>> cache = new HashMap<>();

    @Nullable
    @Override
    public ImageIcon getImageIconForFacename(@NotNull final String faceName, final long stretch) {
        ImageIcon icon = null;
        final String realFaceName = String.format("%s-%d", faceName, stretch);
        final SoftReference<ImageIcon> ref = cache.get(realFaceName);
        if (ref != null) {
            icon = ref.get();
        }
        if (icon == null) {
            icon = createImage(faceName, stretch);
            if (icon != null) {
                cache.put(realFaceName, new SoftReference<>(icon));
            }
        }
        return icon;
    }

    @Override
    public void reload() {
        if (LOG.isDebugEnabled()) {
            LOG.debug("Clearing image cache.");
        }
        cache.clear();
    }

    @Nullable
    protected abstract ImageIcon createImage(@NotNull String faceName, long stretch);

}