Skip navigation links

oracle.as.scheduler.cp.file
Class OutputFile

java.lang.Object
java.io.Writer
java.io.OutputStreamWriter
java.io.FileWriter
oracle.as.scheduler.cp.file.OutputFile

All Implemented Interfaces:

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

public class OutputFile

extends java.io.FileWriter

This class is the entry point for generating output files for requests. It can be used write output generated by the request. These files can then viewed by the user or sent to post-processing for further transformation or activities like printing, fax or email. A request may generate more than one output file.

Users can obtain access to the default output file by using the getOutputFile() method on the ProcessHelper class. Additional output files can be accessed by using the getOutputFile(String name) on the same class. Instantiating this class directly is forbidden and can cause undefined behavior.

Created: Tue Mar 6 17:27:21 2007

Version:

$Header: ess/src/oracle/as/scheduler/cp/file/OutputFile.java /main/4 2010/06/24 12:31:30 kenchang Exp $

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

OutputFile(java.lang.String path, java.lang.String fileName)
Creates a new OutputFile instance.

Method Summary

void	close()
java.lang.String	getFileName() Get the name of the file (without the path) that this object represents.
boolean	isWriteable() Check if the log file can be written to.
void	write(java.lang.String str) Write a not-null string to the output file
void	writeln(java.lang.String str) Write a string to the output file and also add the platform-dependent new line character/string.

Methods inherited from class java.io.OutputStreamWriter

flush, getEncoding, write, write, write

Methods inherited from class java.io.Writer

append, append, append, write

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputFile

public OutputFile(java.lang.String path,
                  java.lang.String fileName)
           throws java.io.IOException

Creates a new OutputFile instance.

Parameters:

path - the absolute path to the directory where the file should be created

fileName - the name of the file to be created

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

Method Detail

getFileName

public java.lang.String getFileName()

Get the name of the file (without the path) that this object represents.

Returns:

the file name

writeln

public void writeln(java.lang.String str)
             throws java.io.IOException

Write a string to the output file and also add the platform-dependent new line character/string.

Parameters:

str - the string to be written to the file

Throws:

java.io.IOException - if an I/O error occurs

write

public void write(java.lang.String str)
           throws java.io.IOException

Write a not-null string to the output file

Overrides:

write in class java.io.Writer

Parameters:

str - the string to be written to the file

Throws:

java.io.IOException - if an I/O error occurs

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Overrides:

close in class java.io.OutputStreamWriter

Throws:

java.io.IOException

isWriteable

public boolean isWriteable()

Check if the log file can be written to. If it has been closed already this method returns false.

Returns:

if this file is writeable.

Skip navigation links