Package com.helger.io.resourceprovider

Class WritableResourceProviderChain

java.lang.Object

com.helger.io.resourceprovider.ReadableResourceProviderChain

com.helger.io.resourceprovider.WritableResourceProviderChain

All Implemented Interfaces:

IReadableResourceProvider, IWritableResourceProvider

Direct Known Subclasses:

DefaultResourceProvider

@Immutable
public class WritableResourceProviderChain
extends ReadableResourceProviderChain
implements IWritableResourceProvider

A resource provider chain implementation of IWritableResourceProvider .

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
protected final com.helger.collection.commons.ICommonsList<IWritableResourceProvider>	m_aWritableResourceProviders

Constructor Summary

Constructors

Constructor	Description
WritableResourceProviderChain(@NonNull IReadableResourceProvider... aResProviders)	Constructor with a varargs array of resource providers.
WritableResourceProviderChain(@NonNull Iterable<? extends IReadableResourceProvider> aResProviders)	Constructor with an iterable of resource providers.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@NonNull @Nonempty com.helger.collection.commons.ICommonsList<IWritableResourceProvider>	getAllContainedWritingResourceProviders()
@Nullable OutputStream	getOutputStream(@NonNull String sName, @NonNull com.helger.base.io.EAppend eAppend)	Get the OutputStream specified by the given name for reading.
@NonNull IWritableResource	getWritableResource(@NonNull String sName)	Get the resource specified by the given name for writing.
@Nullable IWritableResource	getWritableResourceIf(@NonNull String sName, @NonNull Predicate<? super IWritableResource> aReturnFilter)	Get a writable resource matching the name and filter.
int	hashCode()
final boolean	supportsWriting(@Nullable String sName)	Check if this resource provider can handle the resource with the passed name.
String	toString()

Methods inherited from class com.helger.io.resourceprovider.ReadableResourceProviderChain

getAllContainedReadingResourceProviders, getInputStream, getReadableResource, getReadableResourceIf, readingResourceProviders, supportsReading

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.io.resourceprovider.IReadableResourceProvider

getInputStream, getReadableResource, supportsReading

Field Details

m_aWritableResourceProviders

protected final com.helger.collection.commons.ICommonsList<IWritableResourceProvider> m_aWritableResourceProviders

Constructor Details

WritableResourceProviderChain

public WritableResourceProviderChain(@NonNull IReadableResourceProvider... aResProviders)

Constructor with a varargs array of resource providers.

Parameters:

aResProviders - The resource providers to use. May neither be null nor empty. At least one must implement IWritableResourceProvider.

WritableResourceProviderChain

public WritableResourceProviderChain(@NonNull Iterable<? extends IReadableResourceProvider> aResProviders)

Constructor with an iterable of resource providers.

Parameters:

aResProviders - The resource providers to use. May neither be null nor empty. At least one must implement IWritableResourceProvider.

Method Details

getAllContainedWritingResourceProviders

@Nonempty
@ReturnsMutableCopy
public @NonNull @Nonempty com.helger.collection.commons.ICommonsList<IWritableResourceProvider> getAllContainedWritingResourceProviders()

Returns:

A copy of all contained writable resource providers. Never null.

supportsWriting

public final boolean supportsWriting(@Nullable String sName)

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:

supportsWriting in interface IWritableResourceProvider

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.

getWritableResource

@OverrideOnDemand
public @NonNull IWritableResource getWritableResource(@NonNull String sName)

Get the resource specified by the given name for writing.

Specified by:

getWritableResource in interface IWritableResourceProvider

Parameters:

sName - The name of the resource to resolve.

Returns:

The writable resource. Never null.

getWritableResourceIf

public @Nullable IWritableResource getWritableResourceIf(@NonNull String sName,
 @NonNull Predicate<? super IWritableResource> aReturnFilter)

Get a writable resource matching the name and filter.

Parameters:

sName - The name of the resource to resolve. May not be null.

aReturnFilter - The filter to apply on found resources. May not be null.

Returns:

null if no matching resource was found.

getOutputStream

public @Nullable OutputStream getOutputStream(@NonNull String sName,
 @NonNull com.helger.base.io.EAppend eAppend)

Description copied from interface: IWritableResourceProvider

Get the OutputStream specified by the given name for reading. This method may be called without prior call to IWritableResourceProvider.supportsWriting(String).

Specified by:

getOutputStream in interface IWritableResourceProvider

Parameters:

sName - The name of the resource to resolve.

eAppend - Appending mode. May not be null.

Returns:

The OutputStream. May be null if the underlying resource does not exist and cannot be created or if IWritableResourceProvider.supportsWriting(String) returns false.

equals

public boolean equals(Object o)

Overrides:

equals in class ReadableResourceProviderChain

hashCode

public int hashCode()

Overrides:

hashCode in class ReadableResourceProviderChain

toString

public String toString()

Overrides:

toString in class ReadableResourceProviderChain