com.google.gwt.dev.resource.ResourceOracle Maven / Gradle / Ivy
/*
* Copyright 2008 Google Inc.
*
* Licensed 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.
*/
package com.google.gwt.dev.resource;
import java.io.InputStream;
import java.util.Map;
import java.util.Set;
/**
* An abstraction for finding and retrieving {@link Resource}s by abstract path
* name. Intuitively, it works like a jar in that each URL is uniquely located
* somewhere in an abstract namespace. The abstract names must be constructed
* from a series of zero or more valid Java identifiers followed by the '/'
* character and finally ending in a valid filename, for example,
* com/google/gwt/blah.txt.
*
*
* The identity of the returned sets and maps will change when the underlying
* module is refreshed.
*
*/
public interface ResourceOracle {
/**
* Frees up all existing resources and transient internal state. All returned
* collections will be empty after this call until this ResourceOracle is
* refreshed.
*/
void clear();
/**
* Returns an unmodifiable set of unique abstract path names with constant
* lookup time.
*/
Set getPathNames();
/**
* Returns the resource for the given path name or null if there is no such resource.
*/
Resource getResource(String pathName);
/**
* Returns the resource input stream for the given path name or null if there
* is no such resource.
*/
InputStream getResourceAsStream(String pathName);
/**
* Returns an unmodifiable map of abstract path name to resource.
*
* @deprecated use {@link #getResource(String pathName)}, {@link #getResources()}, and
* {@link #getPathNames()} instead so that access to specific resources can be
* tracked.
*/
@Deprecated
Map getResourceMap();
/**
* Returns an unmodifiable set of unique resources with constant lookup time.
*/
Set getResources();
}