org.apache.wicket.util.file
Class Files

java.lang.Object
  org.apache.wicket.util.file.Files

public class Files
extends Object

File utility methods.

Author:

Jonathan Locke

Method Summary

static String	basePath(String path, String extension) Strips off the given extension (probably returned from Files.extension()) from the path, yielding a base pathname.
static String	cleanupFilename(String filename) Replaces commonly unsupported characters with '_'
static void	copy(File sourceFile, File targetFile) make a copy of a file
static String	extension(String path) Gets extension from path
static String	filename(String path) Gets filename from path
static byte[]	readBytes(File file) read binary file fully
static boolean	remove(File file) Deletes a file, dealing with a particularly nasty bug on Windows.
static int	writeTo(File file, InputStream input) Writes the given input stream to the given file
static int	writeTo(File file, InputStream input, int bufSize) Writes the given input stream to the given file

Methods inherited from class java.lang.Object

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

Method Detail

basePath

public static String basePath(String path,
                              String extension)

Strips off the given extension (probably returned from Files.extension()) from the path, yielding a base pathname.

Parameters:

path - The path, possibly with an extension to strip

extension - The extension to strip, or null if no extension exists

Returns:

The path without any extension

extension

public static String extension(String path)

Gets extension from path

Parameters:

path - The path

Returns:

The extension, like "bmp" or "html", or null if none can be found

filename

public static String filename(String path)

Gets filename from path

Parameters:

path - The path

Returns:

The filename

remove

public static boolean remove(File file)

Deletes a file, dealing with a particularly nasty bug on Windows.

Parameters:

file - File to delete

Returns:

True if file was deleted

writeTo

public static final int writeTo(File file,
                                InputStream input)
                         throws IOException

Writes the given input stream to the given file

Parameters:

file - The file to write to

input - The input

Returns:

Number of bytes written

Throws:

IOException

readBytes

public static byte[] readBytes(File file)
                        throws IOException

read binary file fully

Parameters:

file - file to read

Returns:

byte array representing the content of the file

Throws:

IOException - is something went wrong

writeTo

public static final int writeTo(File file,
                                InputStream input,
                                int bufSize)
                         throws IOException

Writes the given input stream to the given file

Parameters:

file - The file to write to

input - The input

bufSize - The memory buffer size. 4096 is a good value.

Returns:

Number of bytes written

Throws:

IOException

cleanupFilename

public static final String cleanupFilename(String filename)

Replaces commonly unsupported characters with '_'

Parameters:

filename - to be cleaned

Returns:

cleaned filename

copy

public static void copy(File sourceFile,
                        File targetFile)
                 throws IOException

make a copy of a file

Parameters:

sourceFile - source file that needs to be cloned

targetFile - target file that should be a duplicate of source file

Throws:

IOException - if something went wrong