org.apache.commons.vfs2.util

Class FileObjectUtils

java.lang.Object

org.apache.commons.vfs2.util.FileObjectUtils

public final class FileObjectUtils
extends java.lang.Object

Utility methods for FileObject.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	FileObjectUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	exists(FileObject fileObject) Null-safe call to FileObject.exists().
static AbstractFileObject	getAbstractFileObject(FileObject fileObject) Gets access to the base object even if decorated.
static java.lang.String	getContentAsString(FileObject file, java.nio.charset.Charset charset) Returns the content of a file as a String.
static java.lang.String	getContentAsString(FileObject file, java.lang.String charset) Returns the content of a file as a String.
static boolean	isInstanceOf(FileObject fileObject, java.lang.Class<?> wantedClass) Checks if the given FileObject is instance of given class argument.
static java.util.Properties	readProperties(FileObject fileObject) Reads the given file into a new Properties.
static java.util.Properties	readProperties(FileObject fileObject, java.util.Properties properties) Reads the given file into a new given Properties.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileObjectUtils

private FileObjectUtils()

Method Detail

exists

public static boolean exists(FileObject fileObject)
                      throws FileSystemException

Null-safe call to FileObject.exists().

Parameters:

fileObject - the file object to test, may be null.

Returns:

false if fileObject is null, otherwise, see FileObject.exists().

Throws:

FileSystemException - On error determining if this file exists.

Since:

2.4

getAbstractFileObject

public static AbstractFileObject getAbstractFileObject(FileObject fileObject)
                                                throws FileSystemException

Gets access to the base object even if decorated.

Parameters:

fileObject - The FileObject.

Returns:

The decorated FileObject or null.

Throws:

FileSystemException - if an error occurs.

getContentAsString

public static java.lang.String getContentAsString(FileObject file,
                                                  java.nio.charset.Charset charset)
                                           throws java.io.IOException

Returns the content of a file as a String.

Parameters:

file - The file to get the content of.

charset - The file character set, may be null.

Returns:

The content as a byte array.

Throws:

java.io.IOException - if the file content cannot be accessed.

Since:

2.4

getContentAsString

public static java.lang.String getContentAsString(FileObject file,
                                                  java.lang.String charset)
                                           throws java.io.IOException

Returns the content of a file as a String.

Parameters:

file - The file to get the content of.

charset - The file character set, may be null.

Returns:

The content as a byte array.

Throws:

java.io.IOException - if the file content cannot be accessed.

Since:

2.4

isInstanceOf

public static boolean isInstanceOf(FileObject fileObject,
                                   java.lang.Class<?> wantedClass)
                            throws FileSystemException

Checks if the given FileObject is instance of given class argument.

Parameters:

fileObject - The FileObject.

wantedClass - The Class to check.

Returns:

true if fileObject is an instance of the specified Class.

Throws:

FileSystemException - if an error occurs.

readProperties

public static java.util.Properties readProperties(FileObject fileObject)
                                           throws FileSystemException,
                                                  java.io.IOException

Reads the given file into a new Properties.

Parameters:

fileObject - the file to read

Returns:

a new Properties.

Throws:

java.io.IOException - On error getting this file's content.

FileSystemException - On error getting this file's content.

java.io.IOException - On error getting this file's content.

Since:

2.4

readProperties

public static java.util.Properties readProperties(FileObject fileObject,
                                                  java.util.Properties properties)
                                           throws FileSystemException,
                                                  java.io.IOException

Reads the given file into a new given Properties.

Parameters:

fileObject - the file to read

properties - the destination

Returns:

a new Properties.

Throws:

FileSystemException - On error getting this file's content.

java.io.IOException - On error getting this file's content.

Since:

2.4