com.helger.commons.io.resource

Class FileSystemResource

java.lang.Object

com.helger.commons.io.resource.FileSystemResource

All Implemented Interfaces:

IHasInputStream, IHasInputStreamAndReader, IHasOutputStream, IHasOutputStreamAndWriter, IReadableResource, IReadWriteResource, IResourceBase, IWritableResource, Serializable

@NotThreadSafe
public class FileSystemResource
extends Object
implements IReadWriteResource

Implementation of the IReadableResource and IWritableResource interfaces for file system objects.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FileSystemResource(File aFile)
FileSystemResource(File aParentFile, String sChildPath)
FileSystemResource(Path aPath)
FileSystemResource(String sFilename)
FileSystemResource(String sParentPath, String sChildPath)
FileSystemResource(URI aURI)

Method Summary

Modifier and Type	Method and Description
boolean	canExecute() Tests whether the application can execute the file denoted by this abstract pathname.
boolean	canRead() Tests whether the application can read the file denoted by this abstract pathname.
boolean	canWrite() Tests whether the application can modify the file denoted by this abstract pathname.
boolean	equals(Object o)
boolean	exists()
File	getAsFile()
URL	getAsURL()
FileInputStream	getInputStream() Get the input stream to read from the object.
FileOutputStream	getOutputStream(EAppend eAppend) Get the output stream to read from the object.
String	getPath()
FileSystemResource	getReadableCloneForPath(String sPath) Get a new resource of the same implementation type as this object but for a different path.
Reader	getReader(Charset aCharset) Get an Reader based on this input stream provider using the given charset.
String	getResourceID()
FileSystemResource	getWritableCloneForPath(String sPath) Get a new resource of the same implementation type as this object but for a different path.
Writer	getWriter(Charset aCharset, EAppend eAppend) Get an Writer based on this output stream provider using the given charset.
int	hashCode()
boolean	isReadMultiple() Check if the InputStream from IHasInputStream.getInputStream() can be acquired more than once.
boolean	isWriteMultiple() Check if the OutputStream from IHasOutputStream.getOutputStream(EAppend) can be qcquired more than once or not.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemResource

public FileSystemResource(@Nonnull
                          URI aURI)

FileSystemResource

public FileSystemResource(@Nonnull
                          String sParentPath,
                          @Nonnull
                          String sChildPath)

FileSystemResource

public FileSystemResource(@Nonnull
                          String sFilename)

FileSystemResource

public FileSystemResource(@Nonnull
                          File aParentFile,
                          String sChildPath)

FileSystemResource

public FileSystemResource(@Nonnull
                          File aFile)

FileSystemResource

public FileSystemResource(@Nonnull
                          Path aPath)

Method Detail

getResourceID

@Nonnull
public String getResourceID()

Specified by:

getResourceID in interface IResourceBase

Returns:

A non-null resource ID used e.g. for system IDs in XML resolving.

getPath

@Nonnull
public String getPath()

Specified by:

getPath in interface IResourceBase

Returns:

The requested path. Never null

getInputStream

@Nullable
public FileInputStream getInputStream()

Description copied from interface: IHasInputStream

Get the input stream to read from the object. Each time this method is called, a new InputStream needs to be created!

Specified by:

getInputStream in interface IHasInputStream

Returns:

null if resolving failed.

getReader

@Nullable
public Reader getReader(@Nonnull
                                   Charset aCharset)

Description copied from interface: IHasInputStreamAndReader

Get an Reader based on this input stream provider using the given charset.

Specified by:

getReader in interface IHasInputStreamAndReader

Parameters:

aCharset - The charset to use. May not be null.

Returns:

null if no input stream could be retrieved.

isReadMultiple

public final boolean isReadMultiple()

Description copied from interface: IHasInputStream

Check if the InputStream from IHasInputStream.getInputStream() can be acquired more than once.

Specified by:

isReadMultiple in interface IHasInputStream

Returns:

true if the input stream can be acquired more than once, false if not.

getOutputStream

@Nullable
public FileOutputStream getOutputStream(@Nonnull
                                                   EAppend eAppend)

Description copied from interface: IHasOutputStream

Get the output stream to read from the object. Each time this method is call, a new OutputStream needs to be created!

Specified by:

getOutputStream in interface IHasOutputStream

Parameters:

eAppend - appending mode. May not be null.

Returns:

null if resolving failed.

getWriter

@Nullable
public Writer getWriter(@Nonnull
                                   Charset aCharset,
                                   @Nonnull
                                   EAppend eAppend)

Description copied from interface: IHasOutputStreamAndWriter

Get an Writer based on this output stream provider using the given charset.

Specified by:

getWriter in interface IHasOutputStreamAndWriter

Parameters:

aCharset - The charset to use. May not be null.

eAppend - Appending mode. May not be null.

Returns:

null if no output stream could be retrieved.

isWriteMultiple

public final boolean isWriteMultiple()

Description copied from interface: IHasOutputStream

Check if the OutputStream from IHasOutputStream.getOutputStream(EAppend) can be qcquired more than once or not.

Specified by:

isWriteMultiple in interface IHasOutputStream

Returns:

true if the output stream can be acquired more than once, false if not.

exists

public boolean exists()

Specified by:

exists in interface IResourceBase

Returns:

true if the resource exists, false otherwise.

getAsURL

@Nullable
public URL getAsURL()

Specified by:

getAsURL in interface IResourceBase

Returns:

the URL representation of this resource. May be null if this resource cannot be represented as an URL.

getAsFile

@Nonnull
public File getAsFile()

Specified by:

getAsFile in interface IResourceBase

Returns:

the File representation of this resource. May be null if this resource cannot be represented as a file.

getReadableCloneForPath

@Nonnull
public FileSystemResource getReadableCloneForPath(@Nonnull
                                                            String sPath)

Description copied from interface: IReadableResource

Get a new resource of the same implementation type as this object but for a different path.

Specified by:

getReadableCloneForPath in interface IReadableResource

Parameters:

sPath - The new path to use. May not be null.

Returns:

The resource of the same implementation but a different path. May not be null.

getWritableCloneForPath

@Nonnull
public FileSystemResource getWritableCloneForPath(@Nonnull
                                                            String sPath)

Description copied from interface: IWritableResource

Get a new resource of the same implementation type as this object but for a different path.

Specified by:

getWritableCloneForPath in interface IWritableResource

Parameters:

sPath - The new path to use. May not be null.

Returns:

The resource of the same implementation but a different path. May not be null.

canRead

public boolean canRead()

Tests whether the application can read the file denoted by this abstract pathname.

Returns:

true if and only if the file specified by this abstract pathname exists and can be read by the application; false otherwise

canWrite

public boolean canWrite()

Tests whether the application can modify the file denoted by this abstract pathname.

Returns:

true if and only if the file system actually contains a file denoted by this abstract pathname and the application is allowed to write to the file; false otherwise.

canExecute

public boolean canExecute()

Tests whether the application can execute the file denoted by this abstract pathname.

Returns:

true if and only if the abstract pathname exists and the application is allowed to execute the file

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