com.helger.commons.io.resourceprovider

Class WritableResourceProviderChain

java.lang.Object

com.helger.commons.io.resourceprovider.ReadableResourceProviderChain

com.helger.commons.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 and Description
protected ICommonsList<IWritableResourceProvider>	m_aWritableResourceProviders

Fields inherited from class com.helger.commons.io.resourceprovider.ReadableResourceProviderChain

m_aReadingResourceProviders

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ICommonsList<IWritableResourceProvider>	getAllContainedWritingResourceProviders()
OutputStream	getOutputStream(String sName, EAppend eAppend) Get the OutputStream specified by the given name for reading.
IWritableResource	getWritableResource(String sName) Get the resource specified by the given name for writing.
int	hashCode()
boolean	supportsWriting(String sName) Check if this resource provider can handle the resource with the passed name.
String	toString()

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

getAllContainedReadingResourceProviders, getInputStream, getReadableResource, supportsReading

Methods inherited from class java.lang.Object

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

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

getInputStream, getReadableResource, supportsReading

Field Detail

m_aWritableResourceProviders

protected final ICommonsList<IWritableResourceProvider> m_aWritableResourceProviders

Constructor Detail

WritableResourceProviderChain

public WritableResourceProviderChain(@Nonnull
                                     IReadableResourceProvider... aResProviders)

WritableResourceProviderChain

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

Method Detail

getAllContainedWritingResourceProviders

@Nonnull
 @Nonempty
 @ReturnsMutableCopy
public ICommonsList<IWritableResourceProvider> getAllContainedWritingResourceProviders()

supportsWriting

public final boolean supportsWriting(@Nullable
                                     String sName)

Description copied from interface: IWritableResourceProvider

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

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

Description copied from interface: IWritableResourceProvider

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.

getOutputStream

@Nullable
public OutputStream getOutputStream(@Nonnull
                                               String sName,
                                               @Nonnull
                                               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