ResourceLocation.java

package de.lessvoid.nifty.tools.resourceloader;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.WillNotClose;
import java.io.InputStream;
import java.net.URL;

/**
 * A location from which resources can be loaded
 *
 * @author kevin
 */
public interface ResourceLocation {
  /**
   * Get a resource as an input stream
   *
   * @param ref The reference to the resource to retrieve
   * @return A stream from which the resource can be read or
   * null if the resource can't be found in this location
   */
  @Nullable
  @WillNotClose
  public InputStream getResourceAsStream(@Nonnull String ref);

  /**
   * Get a resource as a URL
   *
   * @param ref The reference to the resource to retrieve
   * @return A stream from which the resource can be read
   */
  @Nullable
  public URL getResource(@Nonnull String ref);
}