org.formulacompiler.spreadsheet
Class SpreadsheetSaver.Config

java.lang.Object
  extended by org.formulacompiler.spreadsheet.SpreadsheetSaver.Config
Enclosing interface:
SpreadsheetSaver

public static class SpreadsheetSaver.Config
extends Object

Configuration data for new instances of SpreadsheetSaver.

Author:
peo
See Also:
SpreadsheetCompiler.newSpreadsheetSaver(org.formulacompiler.spreadsheet.SpreadsheetSaver.Config)

Field Summary
 OutputStream outputStream
          Mandatory stream to which the spreadsheet will be written.
 Spreadsheet spreadsheet
          Mandatory internal spreadsheet model that should be written out as a real spreadsheet file.
 InputStream templateInputStream
          Optional stream from which to load the template spreadsheet, or null.
 TimeZone timeZone
          Optional time zone to use for converting date constants, or null which signifies to use the JRE default time zone.
 String typeExtension
          Mandatory file name extension of the format in which the spreadsheet should be written (.xls, .xml, .xsd, etc.).
 
Constructor Summary
SpreadsheetSaver.Config()
           
 
Method Summary
 void validate()
          Validates the configuration.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

spreadsheet

public Spreadsheet spreadsheet
Mandatory internal spreadsheet model that should be written out as a real spreadsheet file. Normally constructed using a SpreadsheetBuilder.


typeExtension

public String typeExtension
Mandatory file name extension of the format in which the spreadsheet should be written (.xls, .xml, .xsd, etc.).


outputStream

public OutputStream outputStream
Mandatory stream to which the spreadsheet will be written.


templateInputStream

public InputStream templateInputStream
Optional stream from which to load the template spreadsheet, or null.


timeZone

public TimeZone timeZone
Optional time zone to use for converting date constants, or null which signifies to use the JRE default time zone.

See the tutorial for details.

Constructor Detail

SpreadsheetSaver.Config

public SpreadsheetSaver.Config()
Method Detail

validate

public void validate()
Validates the configuration.

Throws:
IllegalArgumentException