com.helger.commons.io.resourceprovider

Class ReadableResourceProviderChain

java.lang.Object

com.helger.commons.io.resourceprovider.ReadableResourceProviderChain

All Implemented Interfaces:

IReadableResourceProvider

Direct Known Subclasses:

WritableResourceProviderChain

@Immutable
public class ReadableResourceProviderChain
extends Object
implements IReadableResourceProvider

A readable resource provider that chains multiple IReadableResourceProvider.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
protected ICommonsList<IReadableResourceProvider>	m_aReadingResourceProviders

Constructor Summary

Constructors

Constructor and Description
ReadableResourceProviderChain(IReadableResourceProvider... aResProviders)
ReadableResourceProviderChain(Iterable<? extends IReadableResourceProvider> aResProviders)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ICommonsList<IReadableResourceProvider>	getAllContainedReadingResourceProviders()
InputStream	getInputStream(String sName) Get the InputStream specified by the given name for reading.
IReadableResource	getReadableResource(String sName) Get the resource specified by the given name for reading.
int	hashCode()
boolean	supportsReading(String sName) Check if this resource provider can handle the resource with the passed name.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

m_aReadingResourceProviders

protected final ICommonsList<IReadableResourceProvider> m_aReadingResourceProviders

Constructor Detail

ReadableResourceProviderChain

public ReadableResourceProviderChain(@Nonnull
                                     IReadableResourceProvider... aResProviders)

ReadableResourceProviderChain

public ReadableResourceProviderChain(@Nonnull
                                     Iterable<? extends IReadableResourceProvider> aResProviders)

Method Detail

getAllContainedReadingResourceProviders

@Nonnull
 @Nonempty
 @ReturnsMutableCopy
public ICommonsList<IReadableResourceProvider> getAllContainedReadingResourceProviders()

supportsReading

public final boolean supportsReading(@Nullable
                                     String sName)

Description copied from 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.

Specified by:

supportsReading in interface IReadableResourceProvider

Parameters:

sName - The name to check. May be null.

Returns:

true if the name is not null and can be handled by this provider, false otherwise.

getReadableResource

@Nonnull
 @OverrideOnDemand
public IReadableResource getReadableResource(@Nonnull
                                                                           String sName)

Description copied from interface: IReadableResourceProvider

Get the resource specified by the given name for reading.

Specified by:

getReadableResource in interface IReadableResourceProvider

Parameters:

sName - The name of the resource to resolve.

Returns:

The readable resource. Never null.

getInputStream

@Nullable
public InputStream getInputStream(@Nonnull
                                             String sName)

Description copied from interface: IReadableResourceProvider

Get the InputStream specified by the given name for reading. This method may be called without prior call to IReadableResourceProvider.supportsReading(String).

Specified by:

getInputStream in interface IReadableResourceProvider

Parameters:

sName - The name of the resource to resolve.

Returns:

The InputStream. May be null if the underlying resource does not exist or if IReadableResourceProvider.supportsReading(String) returns false.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object