Modifier and Type	Class and Description
public static enum	FileWrapper.FileState
public static enum	FileWrapper.OpenMode

Modifier and Type	Field and Description
private final File	file
private FileInputStream	fis
private FileOutputStream	fos
private InputStreamReader	isr
private OutputStreamWriter	osw
private BufferedReader	reader
private FileWrapper.FileState	state
private BufferedWriter	writer

Access	Constructor and Description
public	FileWrapper(final File File to wrap file) Create a new FileWrapper for the given File.
public	FileWrapper(String str)
public	FileWrapper(File root, String str)

Method Summary

Modifier and Type	Method and Description
public boolean	canWrite()
public void	close() Implements java.io.Closeable.close. Close the file, and set its state to CLOSED.
public void	copyTo(FileWrapper The FileWrapper to copy data to. target, byte[] The buffer to use for copying the files. buffer) Copy this file to target using buffer to hold data.
public void	delete()
public String	getAbsoluteName()
public FileWrapper.FileState	getFileState()
public String	getName()
pack-priv boolean	isYoungerThan(FileWrapper fw) Returns true if either this FileWrapper does not exist, or if the lastModificationTime of this FileWrapper is earlier than that of fw.
public void	open(final FileWrapper.OpenMode READ or WRITE mode. mode) Open the (text) file for I/O.
public byte[]	readAll()
public String	Returns: The String just read. readLine() Read the next line from the text file.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	writeAll(byte[] data)
public void	writeLine(final String The line to write. line) Write the line to the end of the file, including a newline.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

file	back to summary
private final File file

fis	back to summary
private FileInputStream fis

fos	back to summary
private FileOutputStream fos

isr	back to summary
private InputStreamReader isr

osw	back to summary
private OutputStreamWriter osw

reader	back to summary
private BufferedReader reader

state	back to summary
private FileWrapper.FileState state

writer	back to summary
private BufferedWriter writer

Constructor Detail

FileWrapper	back to summary
public FileWrapper(final File file) Create a new FileWrapper for the given File. Represents the same file in the filesystem as the underlying File object. getBase() return the FileWrapper for the file system root. Parameters file:File File to wrap

FileWrapper

back to summary

public FileWrapper(final File file)

Create a new FileWrapper for the given File. Represents the same file in the filesystem as the underlying File object. getBase() return the FileWrapper for the file system root.

Parameters

file:File: File to wrap

FileWrapper	back to summary
public FileWrapper(String str)

FileWrapper	back to summary
public FileWrapper(File root, String str)

Method Detail

canWrite	back to summary
public boolean canWrite()

close	back to summary
public void close() Implements java.io.Closeable.close. Close the file, and set its state to CLOSED. This method does not throw any exceptions. Annotations @Override

back to summary

public void close()

Implements java.io.Closeable.close.

Close the file, and set its state to CLOSED. This method does not throw any exceptions.

Annotations

@Override

copyTo	back to summary
public void copyTo(FileWrapper target, byte[] buffer) throws IOException Copy this file to target using buffer to hold data. Does not assume we are using text files. Parameters target:FileWrapper The FileWrapper to copy data to. buffer:byte[] The buffer to use for copying the files. Exceptions IOException: for IO exceptions.

copyTo

back to summary

public void copyTo(FileWrapper target, byte[] buffer) throws IOException

Copy this file to target using buffer to hold data. Does not assume we are using text files.

Parameters

target:FileWrapper: The FileWrapper to copy data to.
buffer:byte[]: The buffer to use for copying the files.

Exceptions

IOException:: for IO exceptions.

delete	back to summary
public void delete()

getAbsoluteName	back to summary
public String getAbsoluteName()

getFileState	back to summary
public FileWrapper.FileState getFileState()

getName	back to summary
public String getName()

isYoungerThan	back to summary
pack-priv boolean isYoungerThan(FileWrapper fw) Returns true if either this FileWrapper does not exist, or if the lastModificationTime of this FileWrapper is earlier than that of fw.

open	back to summary
public void open(final FileWrapper.OpenMode mode) throws IOException Open the (text) file for I/O. There are two modes: READ. In this mode, the file is prepared for reading, starting from the beginning. end-of-file at the time the file is opened. WRITE. In this mode, the file is prepared for writing, starting at the end of the file. Parameters mode:FileWrapper.OpenMode READ or WRITE mode. Exceptions IOException: for IO exceptions.

open

back to summary

public void open(final FileWrapper.OpenMode mode) throws IOException

Open the (text) file for I/O. There are two modes:

READ. In this mode, the file is prepared for reading, starting from the beginning. end-of-file at the time the file is opened.
WRITE. In this mode, the file is prepared for writing, starting at the end of the file.

Parameters

mode:FileWrapper.OpenMode: READ or WRITE mode.

Exceptions

IOException:: for IO exceptions.

readAll	back to summary
public byte[] readAll() throws IOException

readLine	back to summary
public String readLine() throws IOException Read the next line from the text file. File state must be FileState OPEN_FOR_READ. Returns null when at the end of file. Returns:String The String just read. Exceptions IOException: for IO errors.

readLine

back to summary

public String readLine() throws IOException

Read the next line from the text file. File state must be FileState OPEN_FOR_READ. Returns null when at the end of file.

Returns:String

The String just read.

Exceptions

IOException:: for IO errors.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

writeAll	back to summary
public void writeAll(byte[] data) throws IOException

writeLine	back to summary
public void writeLine(final String line) throws IOException Write the line to the end of the file, including a newline. File state must be FileState OPEN_FOR_WRITE. Parameters line:String The line to write. Exceptions IOException: for IO errors.

writeLine

back to summary

public void writeLine(final String line) throws IOException

Write the line to the end of the file, including a newline. File state must be FileState OPEN_FOR_WRITE.

Parameters

line:String: The line to write.

Exceptions

IOException:: for IO errors.

org.glassfish.pfl.basic.tools.file back to summary

public final Enum FileWrapper.FileState

Class Inheritance

extends Enum<FileWrapper.FileState>

java.lang.Object
java.lang.Enum
org.glassfish.pfl.basic.tools.file.FileWrapper.FileState

Field Summary

Modifier and Type	Field and Description
public static final FileWrapper.FileState	CLOSED
public static final FileWrapper.FileState	OPEN_FOR_READ
public static final FileWrapper.FileState	OPEN_FOR_WRITE

Constructor Summary

Access	Constructor and Description
private	FileState()

Method Summary

Modifier and Type	Method and Description
public static FileWrapper.FileState	valueOf(String name)
public static FileWrapper.FileState[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CLOSED	back to summary
public static final FileWrapper.FileState CLOSED

OPEN_FOR_READ	back to summary
public static final FileWrapper.FileState OPEN_FOR_READ

OPEN_FOR_WRITE	back to summary
public static final FileWrapper.FileState OPEN_FOR_WRITE

Constructor Detail

FileState	back to summary
private FileState()

Method Detail

valueOf	back to summary
public static FileWrapper.FileState valueOf(String name)

values	back to summary
public static FileWrapper.FileState[] values()

org.glassfish.pfl.basic.tools.file back to summary

public final Enum FileWrapper.OpenMode

Class Inheritance

extends Enum<FileWrapper.OpenMode>

java.lang.Object
java.lang.Enum
org.glassfish.pfl.basic.tools.file.FileWrapper.OpenMode

Field Summary

Modifier and Type	Field and Description
public static final FileWrapper.OpenMode	READ
public static final FileWrapper.OpenMode	WRITE
public static final FileWrapper.OpenMode	WRITE_EMPTY

Constructor Summary

Access	Constructor and Description
private	OpenMode()

Method Summary

Modifier and Type	Method and Description
public static FileWrapper.OpenMode	valueOf(String name)
public static FileWrapper.OpenMode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

READ	back to summary
public static final FileWrapper.OpenMode READ

WRITE	back to summary
public static final FileWrapper.OpenMode WRITE

WRITE_EMPTY	back to summary
public static final FileWrapper.OpenMode WRITE_EMPTY

Constructor Detail

OpenMode	back to summary
private OpenMode()

Method Detail

valueOf	back to summary
public static FileWrapper.OpenMode valueOf(String name)

values	back to summary
public static FileWrapper.OpenMode[] values()

public Class FileWrapper

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum FileWrapper.FileState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum FileWrapper.OpenMode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail