com.phloc.commons.io.IReadableResourceProvider Maven / Gradle / Ivy
/**
* Copyright (C) 2006-2015 phloc systems
* http://www.phloc.com
* office[at]phloc[dot]com
*
* 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.phloc.commons.io;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import com.phloc.commons.annotations.MustImplementEqualsAndHashcode;
/**
* Resource provider interface for readable resources.
*
* @author Philip Helger
*/
@MustImplementEqualsAndHashcode
public interface IReadableResourceProvider
{
/**
* Check if this resource provider can handle the resource with the passed
* name. If there is no real check on whether your resource provider can
* handle it, simply return true.
*
* @param sName
* The name to check. May be null.
* @return true if the name is not null and can be
* handled by this provider, false otherwise.
*/
boolean supportsReading (@Nullable String sName);
/**
* Get the resource specified by the given name for reading.
*
* @param sName
* The name of the resource to resolve.
* @return The readable resource. Never null.
*/
@Nonnull
IReadableResource getReadableResource (@Nonnull String sName);
}