com.helger.commons.io.resourceprovider

Class FileSystemResourceProvider

java.lang.Object

com.helger.commons.io.resourceprovider.FileSystemResourceProvider

All Implemented Interfaces:

IReadableResourceProvider, IWritableResourceProvider

@ThreadSafe
public class FileSystemResourceProvider
extends Object
implements IWritableResourceProvider

Simple resource provider that only uses files.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
FileSystemResourceProvider()
FileSystemResourceProvider(File aBasePath)
FileSystemResourceProvider(String sBasePath)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
File	getBasePath()
IReadableResource	getReadableResource(String sName) Get the resource specified by the given name for reading.
IWritableResource	getWritableResource(String sName) Get the resource specified by the given name for writing.
int	hashCode()
boolean	isCanReadRelativePaths()
FileSystemResourceProvider	setCanReadRelativePaths(boolean bCanReadRelativePaths)
boolean	supportsReading(String sName) Check if this resource provider can handle the resource with the passed name.
boolean	supportsWriting(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

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

getOutputStream

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

getInputStream

Constructor Detail

FileSystemResourceProvider

public FileSystemResourceProvider()

FileSystemResourceProvider

public FileSystemResourceProvider(@Nonnull
                                  String sBasePath)

FileSystemResourceProvider

public FileSystemResourceProvider(@Nullable
                                  File aBasePath)

Method Detail

getBasePath

@Nullable
public final File getBasePath()

isCanReadRelativePaths

public final boolean isCanReadRelativePaths()

setCanReadRelativePaths

@Nonnull
public final FileSystemResourceProvider setCanReadRelativePaths(boolean bCanReadRelativePaths)

supportsReading

public 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.

supportsWriting

public 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.

getReadableResource

@Nonnull
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.

getWritableResource

@Nonnull
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.

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