org.plumelib.util

Class FileWriterWithName

java.lang.Object

java.io.Writer

java.io.OutputStreamWriter

java.io.FileWriter

org.plumelib.util.FileWriterWithName

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable

public final class FileWriterWithName
extends java.io.FileWriter

Just like FileWriter, but adds a getFileName() method and overrides #toString() to give the file name.

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
FileWriterWithName(java.io.File file) Constructs a FileWriterWithName object given a File object.
FileWriterWithName(java.io.File file, boolean append) Constructs a FileWriterWithName object given a File object.
FileWriterWithName(java.lang.String fileName) Constructs a FileWriterWithName object given a file name.
FileWriterWithName(java.lang.String fileName, boolean append) Constructs a FileWriterWithName object given a file name with a boolean indicating whether or not to append the data written.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFileName() Return the name of the file being written by this.
java.lang.String	toString() Return the name of the file being written by this.

Methods inherited from class java.io.OutputStreamWriter

close, flush, getEncoding, write, write, write

Methods inherited from class java.io.Writer

append, append, append, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

FileWriterWithName

public FileWriterWithName(java.lang.String fileName)
                   throws java.io.IOException

Constructs a FileWriterWithName object given a file name.

Parameters:

fileName - String The system-dependent filename.

Throws:

java.io.IOException - if the named file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

FileWriterWithName

public FileWriterWithName(java.lang.String fileName,
                          boolean append)
                   throws java.io.IOException

Constructs a FileWriterWithName object given a file name with a boolean indicating whether or not to append the data written.

Parameters:

fileName - String The system-dependent filename.

append - boolean if true, then data will be written to the end of the file rather than the beginning.

Throws:

java.io.IOException - if the named file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

FileWriterWithName

public FileWriterWithName(java.io.File file)
                   throws java.io.IOException

Constructs a FileWriterWithName object given a File object.

Parameters:

file - a File object to write to.

Throws:

java.io.IOException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

FileWriterWithName

public FileWriterWithName(java.io.File file,
                          boolean append)
                   throws java.io.IOException

Constructs a FileWriterWithName object given a File object. If the second argument is true, then bytes will be written to the end of the file rather than the beginning.

Parameters:

file - a File object to write to

append - if true, then bytes will be written to the end of the file rather than the beginning

Throws:

java.io.IOException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

Since:

1.4

Method Detail

getFileName

@Pure
public java.lang.String getFileName( FileWriterWithName this)

Return the name of the file being written by this.

Returns:

the name of the file being written by this

toString

@Pure
public java.lang.String toString( FileWriterWithName this)

Return the name of the file being written by this.

Overrides:

toString in class java.lang.Object

Returns:

the name of the file being written by this