Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.poi.hssf.dev
Class BiffViewer

    java.lang.Object
      org.apache.poi.hssf.dev.BiffViewer

    public final class BiffViewer

extends java.lang.Object

Utility for reading in BIFF8 records and displaying data from them.

See Also:
  `main(java.lang.String[])`

Method Summary
`static Record[]` | `createRecords(java.io.InputStream is, java.io.PrintWriter ps, org.apache.poi.hssf.dev.BiffViewer.BiffRecordListener recListener, boolean dumpInterpretedRecords)` Create an array of records from an input stream
`protected static java.io.InputStream` | `getPOIFSInputStream(NPOIFSFileSystem fs)`
`static void` | `main(java.lang.String[] args)` Method main with 1 argument just run straight biffview against given file
`protected static void` | `runBiffViewer(java.io.PrintWriter pw, java.io.InputStream is, boolean dumpInterpretedRecords, boolean dumpHex, boolean zeroAlignHexDump, boolean suppressHeader)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

### createRecords

    public static Record[] createRecords(java.io.InputStream is,
                                         java.io.PrintWriter ps,
                                         org.apache.poi.hssf.dev.BiffViewer.BiffRecordListener recListener,
                                         boolean dumpInterpretedRecords)
                                  throws RecordFormatException

  Create an array of records from an input stream

  Parameters:
    `is` - the InputStream from which the records will be obtained
    `ps` - the PrintWriter to output the record data
    `recListener` - the record listener to notify about read records
    `dumpInterpretedRecords` - if `true`, the read records will be written to the PrintWriter
  Returns:
    an array of Records created from the InputStream
  Throws:
    `RecordFormatException` - on error processing the InputStream

### main

    public static void main(java.lang.String[] args)
                     throws java.io.IOException,
                            org.apache.poi.hssf.dev.BiffViewer.CommandParseException

  Method main with 1 argument just run straight biffview against given file

  Usage:

  BiffViewer [--biffhex] [--noint] [--noescher] [--out] <fileName>

  BiffViewer --rawhex [--out] <fileName>

  --biffhex | show hex dump of each BIFF record
  --noint | do not output interpretation of BIFF records
  --out | send output to <fileName>.out
  --rawhex | output raw hex dump of whole workbook stream
  --escher | turn on deserialization of escher records (default is off)
  --noheader | do not print record header (default is on)

  Parameters:
    `args` - the command line arguments
  Throws:
    `java.io.IOException` - if the file doesn't exist or contained errors
    `CommandParseException` - if the command line contained errors
    `org.apache.poi.hssf.dev.BiffViewer.CommandParseException`

### getPOIFSInputStream

    protected static java.io.InputStream getPOIFSInputStream(NPOIFSFileSystem fs)
                                                      throws java.io.IOException,
                                                             java.io.FileNotFoundException

  Throws:
    `java.io.IOException`
    `java.io.FileNotFoundException`

### runBiffViewer

    protected static void runBiffViewer(java.io.PrintWriter pw,
                                        java.io.InputStream is,
                                        boolean dumpInterpretedRecords,
                                        boolean dumpHex,
                                        boolean zeroAlignHexDump,
                                        boolean suppressHeader)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 2017 The Apache Software Foundation or its licensors, as applicable.