org.softsmithy.lib.io

Class Files

java.lang.Object

org.softsmithy.lib.io.Files

public class Files
extends Object

A utility class for Files.
Note: The API may change in a future version!

Author:

Florian Brunner

See Also:

File

Field Summary

Fields

Modifier and Type	Field and Description
static String	GIF A file extension.
static String	JPEG A file extension.
static String	JPG A file extension.
static String	TIF A file extension.
static String	TIFF A file extension.
static String	TXT A file extension.

Method Summary

Modifier and Type	Method and Description
static boolean	delete(File file, boolean recursivly) Deletes (optionally recursivly) the specified file or directory.
static String	getExtension(File file) Gets the extension of a file
static File	getFile(File parent, String... paths) Gets a file from path names.
static File	getFile(String... paths) Gets a file from path names.
static String	getFirstName(File f) Gets the first name of a file (from start to the first point).
static String	getName(File f) Gets the name of a file (from start to the last point).
static String[]	getPathNames(File path) Gets the path names of the specified path.
static File	getRoot(File file) Get the root of an absolute file or directory.
static String[]	readLines(File file) Reads the lines from a text file.

Methods inherited from class java.lang.Object

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

Field Detail

JPEG

public static final String JPEG

A file extension. May be removed in a future version.

See Also:

Constant Field Values

JPG

public static final String JPG

A file extension. May be removed in a future version.

See Also:

Constant Field Values

GIF

public static final String GIF

A file extension. May be removed in a future version.

See Also:

Constant Field Values

TIFF

public static final String TIFF

A file extension. May be removed in a future version.

See Also:

Constant Field Values

TIF

public static final String TIF

A file extension. May be removed in a future version.

See Also:

Constant Field Values

TXT

public static final String TXT

A file extension. May be removed in a future version.

See Also:

Constant Field Values

Method Detail

getExtension

public static String getExtension(File file)

Gets the extension of a file

Parameters:

file - the file whose extension should be fetched

Returns:

the extension of the specified file

getFirstName

public static String getFirstName(File f)

Gets the first name of a file (from start to the first point).

Parameters:

f - the file whose first name should be fetched

Returns:

the first name of the specified file

getName

public static String getName(File f)

Gets the name of a file (from start to the last point).

Parameters:

f - the file whose name should be fetched

Returns:

the name of the specified file Should this method be renamed?

readLines

public static String[] readLines(File file)
                          throws FileNotFoundException,
                                 IOException

Reads the lines from a text file.

Return type may change to List<String> in future!?

Parameters:

file - the text file

Returns:

the lines read from a text file

Throws:

FileNotFoundException

IOException

delete

public static boolean delete(File file,
                             boolean recursivly)

Deletes (optionally recursivly) the specified file or directory.

Parameters:

file - the file or directory to be deleted

recursivly - If true, deletes the directory recursivly. If false or if file is not a directory, only the specified file gets deleted.

Returns:

true, if all files/ directories could be deleted, else false.

getPathNames

public static String[] getPathNames(File path)

Gets the path names of the specified path. If the path is absolute the root is NOT inclueded!

This will be always true:
path.equals(Files.getFile(Files.getRoot(path), Files.getPathNames(path))

Note: return type might change to List<String> with java v1.5

Parameters:

path - the path

Returns:

the path names. If the path is absolute the root is NOT inclueded!

getFile

public static File getFile(String... paths)

Gets a file from path names.

Parameters:

paths - the path names

Returns:

the file representing the specified path

getFile

public static File getFile(File parent,
                           String... paths)

Gets a file from path names.

Parameters:

paths - the path names

Returns:

the file representing the specified path

getRoot

public static File getRoot(File file)

Get the root of an absolute file or directory.

This will be always true:
path.equals(Files.getFile(Files.getRoot(path), Files.getPathNames(path))

Parameters:

file - a file or directory

Returns:

the root of the specified file or directory or null if it is not absolute