com.phloc.commons.io.resource

Class FileSystemResource

java.lang.Object

com.phloc.commons.io.resource.FileSystemResource

All Implemented Interfaces:

IInputStreamAndReaderProvider, IInputStreamProvider, IOutputStreamAndWriterProvider, IOutputStreamProvider, IReadableResource, IReadWriteResource, IResourceBase, IWritableResource, Serializable

@Immutable
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(String sFilename)
FileSystemResource(String sParentPath, String sChildPath)
FileSystemResource(URI aURI)

Method Summary

Methods

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()
static URL	getAsURL(File aFile)
InputStream	getInputStream() Get the input stream to read from the object.
static InputStream	getInputStream(File aFile)
OutputStream	getOutputStream(EAppend eAppend) Get the output stream to read from the object.
static OutputStream	getOutputStream(File aFile, EAppend eAppend)
String	getPath()
FileSystemResource	getReadableCloneForPath(String sPath)
Reader	getReader(Charset aCharset) Get an Reader based on this input stream provider using the given charset.
static Reader	getReader(File aFile, Charset aCharset)
static Reader	getReader(File aFile, String sCharset) Deprecated.
Reader	getReader(String sCharset) Deprecated.
String	getResourceID()
FileSystemResource	getWritableCloneForPath(String sPath)
Writer	getWriter(Charset aCharset, EAppend eAppend) Get an Writer based on this output stream provider using the given charset.
static Writer	getWriter(File aFile, Charset aCharset, EAppend eAppend)
static Writer	getWriter(File aFile, String sCharset, EAppend eAppend) Deprecated.
Writer	getWriter(String sCharset, EAppend eAppend) Deprecated.
int	hashCode()
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)

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 static InputStream getInputStream(@Nonnull
                                  File aFile)

getReader

@Nullable
@Deprecated
public static Reader getReader(@Nonnull
                                   File aFile,
                                   @Nonnull@Nonempty
                                   String sCharset)

Deprecated.

getReader

@Nullable
public static Reader getReader(@Nonnull
                        File aFile,
                        @Nonnull
                        Charset aCharset)

getInputStream

@Nullable
public InputStream getInputStream()

Description copied from interface: IInputStreamProvider

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

Specified by:

getInputStream in interface IInputStreamProvider

Returns:

null if resolving failed.

getReader

@Nullable
@Deprecated
public Reader getReader(@Nonnull@Nonempty
                                   String sCharset)

Deprecated.

Description copied from interface: IInputStreamAndReaderProvider

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

Specified by:

getReader in interface IInputStreamAndReaderProvider

Parameters:

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

Returns:

null if no input stream could be retrieved.

getReader

@Nullable
public Reader getReader(@Nonnull
                        Charset aCharset)

Description copied from interface: IInputStreamAndReaderProvider

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

Specified by:

getReader in interface IInputStreamAndReaderProvider

Parameters:

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

Returns:

null if no input stream could be retrieved.

getOutputStream

@Nullable
public static OutputStream getOutputStream(@Nonnull
                                    File aFile,
                                    @Nonnull
                                    EAppend eAppend)

getWriter

@Nullable
@Deprecated
public static Writer getWriter(@Nonnull
                                   File aFile,
                                   @Nonnull@Nonempty
                                   String sCharset,
                                   @Nonnull
                                   EAppend eAppend)

Deprecated.

getWriter

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

getOutputStream

@Nullable
public OutputStream getOutputStream(@Nonnull
                                    EAppend eAppend)

Description copied from interface: IOutputStreamProvider

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 IOutputStreamProvider

Parameters:

eAppend - appending mode. May not be null.

Returns:

null if resolving failed.

getWriter

@Nullable
@Deprecated
public Writer getWriter(@Nonnull@Nonempty
                                   String sCharset,
                                   @Nonnull
                                   EAppend eAppend)

Deprecated.

Description copied from interface: IOutputStreamAndWriterProvider

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

Specified by:

getWriter in interface IOutputStreamAndWriterProvider

Parameters:

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

eAppend - Appending mode. May not be null.

Returns:

null if no output stream could be retrieved.

getWriter

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

Description copied from interface: IOutputStreamAndWriterProvider

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

Specified by:

getWriter in interface IOutputStreamAndWriterProvider

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.

exists

public boolean exists()

Specified by:

exists in interface IResourceBase

Returns:

true if the resource exists, false otherwise.

getAsURL

@Nullable
public static URL getAsURL(File aFile)

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)

Specified by:

getReadableCloneForPath in interface IReadableResource

getWritableCloneForPath

@Nonnull
public FileSystemResource getWritableCloneForPath(@Nonnull
                                                 String sPath)

Specified by:

getWritableCloneForPath in interface IWritableResource

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