com.ibm.as400.access
Class SpooledFileOutputStream

java.lang.Object
  java.io.OutputStream
      com.ibm.as400.access.SpooledFileOutputStream

All Implemented Interfaces:

Closeable, Flushable

public class SpooledFileOutputStream
extends OutputStream

The SpooledFileOutputStream class is used to write data into a spooled file.

Constructor and Description

SpooledFileOutputStream(AS400 system, PrintParameterList options, PrinterFile printerFile, OutputQueue outputQueue)
Constructs a SpooledFileOutputStream object.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the stream.
void	flush() Flushes the stream.
SpooledFile	getSpooledFile() Returns the spooled file that was created (or is being created) with this output stream.
void	write(byte[] data) Writes data.length bytes of data from the byte array data to the spooled file.
void	write(byte[] data, int offset, int length) Writes up to length bytes of data from the byte array data, starting at offset, to this spooled file.
void	write(int b) Writes a byte of data.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpooledFileOutputStream

public SpooledFileOutputStream(AS400 system,
                               PrintParameterList options,
                               PrinterFile printerFile,
                               OutputQueue outputQueue)
                        throws AS400Exception,
                               AS400SecurityException,
                               ErrorCompletingRequestException,
                               InterruptedException,
                               IOException

Constructs a SpooledFileOutputStream object. Use this object to create a new spooled file on the given system with the specified parameters.

Parameters:

system - The system on which to create the spooled file.

options - Optional. A print parameter list that contains a list of attributes with which to create the spooled file. The attributes set in options will override those attributes in the printer file that is used. The printer file used will be the one specified with the printerFile parameter, or if that parameter is null, it will be the default network print server printer file (QPNPSPRTF). If the output queue is specified in options, it will override any output queue passed in the outputQueue parameter. The following parameters may be set:

• ATTR_ALIGN - Align page
• ATTR_BACK_OVERLAY - Back overlay integrated file system Name
• ATTR_BKOVL_DWN - Back overlay offset down
• ATTR_BKOVL_ACR - Back overlay offset across
• ATTR_CPI - Characters per inch
• (1) ATTR_CODEPAGE - Code page
• ATTR_CONTROLCHAR - Control character
• ATTR_CONVERT_LINEDATA - Convert line data
• ATTR_CORNER_STAPLE - Corner staple
• ATTR_COPIES - Copies
• ATTR_DAYS_UNTIL_EXPIRE - Days Until File Expires
• ATTR_DBCSDATA - User-specified DBCS data
• ATTR_DBCSEXTENSN - DBCS extension characters
• ATTR_DBCSROTATE - DBCS character rotation
• ATTR_DBCSCPI - DBCS characters per inch
• ATTR_DBCSSISO - DBCS SO/SI spacing
• ATTR_DFR_WRITE - Defer write
• ATTR_PAGRTT - Degree of page rotation
• ATTR_EDGESTITCH_NUMSTAPLES - Edge Stitch Number of Staples
• ATTR_EDGESTITCH_REF - Edge Stitch Reference
• ATTR_EDGESTITCH_REFOFF - Edge Stitch Reference Offset
• ATTR_ENDPAGE - Ending page
• ATTR_EXPIRATION_DATE - Expiration Date
• (2) ATTR_FILESEP - File separators
• ATTR_FOLDREC - Fold records
• ATTR_FONTID - Font identifier
• ATTR_FORM_DEFINITION - Form definition integrated file system name
• ATTR_FORMFEED - Form feed
• ATTR_FORMTYPE - Form type
• ATTR_FRONT_OVERLAY - Front overlay integrated file system same
• ATTR_FTOVL_ACR - Front overlay offset across
• ATTR_FTOVL_DWN - Front overlay offset down
• (1) ATTR_CHAR_ID - Graphic character set
• ATTR_JUSTIFY - Hardware justification
• ATTR_HOLD - Hold spool file
• ATTR_HOLDPNDSTS - Hold Pending Status
• ATTR_IPP_ATTR_CCSID - IPP Attributes-ccsid
• ATTR_IPP_JOB_ID - IPP Job ID
• ATTR_IPP_JOB_NAME - IPP Job Name
• ATTR_IPP_JOB_NAME_NL - IPP Job Name NL
• ATTR_IPP_JOB_ORIGUSER - IPP Job Originating User Name
• ATTR_IPP_JOB_ORIGUSER_NL - IPP Job Originating User Name NL
• ATTR_IPP_PRINTER_NAME - IPP Printer Name
• ATTR_IPP_ATTR_NL - IPP Natural Language
• ATTR_LPI - Lines per inch
• ATTR_MAXRCDS - Maximum spooled output records
• ATTR_OUTPTY - Output priority
• ATTR_OUTPUT_QUEUE - Output queue integrated file system name
• ATTR_OVERFLOW - Overflow line number
• ATTR_PAGE_DEFINITION - Page definition integrated file system name
• ATTR_PAGELEN - Length of page
• ATTR_MEASMETHOD - Measurement method
• ATTR_PAGEWIDTH - Width of page
• ATTR_MULTIUP - Pages per side
• ATTR_POINTSIZE - Point size
• ATTR_FIDELITY - Print fidelity
• ATTR_DUPLEX - Print on both sides
• ATTR_PRTQUALITY - Print quality
• ATTR_PRTTEXT - Print text
• ATTR_PRINTER - Printer
• ATTR_PRTDEVTYPE - Printer device type
• ATTR_RPLUNPRT - Replace unprintable characters
• ATTR_RPLCHAR - Replacement character
• ATTR_SADDLESTITCH_NUMSTAPLES - Saddle Stitch Number of Staples
• ATTR_SADDLESTITCH_REF - Saddle Stitch Reference
• ATTR_SAVE - Save spooled file
• ATTR_SRCDRWR - Source drawer
• ATTR_SPOOL - Spool the data
• ATTR_SPOOLFILE - Spooled file name
• ATTR_SCHEDULE - Spooled output schedule
• ATTR_STARTPAGE - Starting page
• ATTR_UNITOFMEAS - Unit of measure
• ATTR_USERCMT - User comment
• ATTR_USERDATA - User data
• ATTR_SPLSCS - Spool SCS
• ATTR_USRDEFDATA - User defined data
• (3) ATTR_USRDEFOPT - User defined options
• ATTR_USER_DEFINED_OBJECT - User defined object integrated file system name

Note 1: Code page and graphical character set are dependent upon each other. If you set one you must set the other.
Note 2: The special value of *FILE is not allowed when creating a new spooled file.
Note 3: Up to 4 user-defined options may be specified.
Note 4: A page definition can be specified with *LINE data.

printerFile - Optional. The printer file that should be used to create the spooled file. This printer file must reside on the same system that the spooled file is being created on.

outputQueue - Optional. The output queue on which to create the spooled file. The output queue must reside on the same system that the spooled file is being created on.

Throws:

AS400Exception - If the system returns an error message.

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

IOException - If an error occurs while communicating with the system.

InterruptedException - If this thread is interrupted.

Method Detail

close

public void close()
           throws IOException

Closes the stream. It must be called to release any resources associated with the stream.

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException - If an error occurs while communicating with the system.

flush

public void flush()
           throws IOException

Flushes the stream. This will write any buffered output bytes.

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException - If an error occurs while communicating with the system.

getSpooledFile

public SpooledFile getSpooledFile()
                           throws IOException

Returns the spooled file that was created (or is being created) with this output stream.

Returns:

A reference to the spooled file object.

Throws:

IOException

write

public void write(int b)
           throws IOException

Writes a byte of data.

Specified by:

write in class OutputStream

Parameters:

b - The byte to be written.

Throws:

IOException - If an error occurs while communicating with the system.

write

public void write(byte[] data)
           throws IOException

Writes data.length bytes of data from the byte array data to the spooled file.

Overrides:

write in class OutputStream

Parameters:

data - The data to be written.

Throws:

IOException - If an error occurs while communicating with the system.

write

public void write(byte[] data,
                  int offset,
                  int length)
           throws IOException

Writes up to length bytes of data from the byte array data, starting at offset, to this spooled file.

Overrides:

write in class OutputStream

Parameters:

data - The data to be written.

offset - The start offset in the data.

length - The number of bytes that are written.

Throws:

IOException - If an error occurs while communicating with the system.