com.threerings.resource.KnownAvailabilityResourceBundle Maven / Gradle / Ivy

Go to download
//
// Nenya library - tools for developing networked games
// Copyright (C) 2002-2012 Three Rings Design, Inc., All Rights Reserved
// https://github.com/threerings/nenya
//
// This library 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 library 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 library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

package com.threerings.resource;

import java.util.Set;

/**
 * Keeps a set of known resources and allows implementors to ask if a resource is in it before
 * performing a potentially expensive failed lookup.
 */
public abstract class KnownAvailabilityResourceBundle extends ResourceBundle
{
    public KnownAvailabilityResourceBundle (Set availableResources)
    {
        _rsrcs = availableResources;
    }

    /**
     * Returns whether we believe the path to be available. If we have no list, we assume
     * everything may be available.
     */
    protected boolean isPossiblyAvailable (String path)
    {
        return _rsrcs == null || _rsrcs.contains(path);
    }

    /** All the resources included in this bundle. */
    protected Set _rsrcs;
}