step.io
Class StepEncodedInput

java.lang.Object
  |
  +--step.io.StepEncodedInput

All Implemented Interfaces:

StepRecordInput

public class StepEncodedInput

extends Object

implements StepRecordInput

An input stream for reading StepRecord objects.

See Also:

StepRecord, Encoder, StepEncodedOutput

Nested Class Summary

class	StepEncodedInput.MetaContext
class	StepEncodedInput.RecordContext
class	StepEncodedInput.SizeContext

Constructor Summary

StepEncodedInput(InputStream input)

Method Summary

void	close() Close this input stream.
(package private) static boolean	ignoreUnknownRecords()
StepRecord	readRecord() Read the next STEP record from this input stream.
(package private) static boolean	verbose()
(package private) static int	zipBufferSize()

Methods inherited from class java.lang.Object

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

Constructor Detail

StepEncodedInput

public StepEncodedInput(InputStream input)
                 throws IOException

Method Detail

readRecord

public StepRecord readRecord()
                      throws IOException,
                             ClassNotFoundException

Description copied from interface: StepRecordInput

Read the next STEP record from this input stream.

NOTE: The input stream may contain meta-information about the data sequence. Often, such records are interpreted and discarded without passing to the client of the input stream.

Specified by:

readRecord in interface StepRecordInput

Returns:

the next (relevant) record from the input stream, or null if the end of input has been reached.

Throws:

IOException - if an internal I/O failure occurred.

ClassNotFoundException - if the definition and/or factory for the record could not be obtained.

close

public void close()
           throws IOException

Description copied from interface: StepRecordInput

Close this input stream.

Specified by:

close in interface StepRecordInput

IOException

ignoreUnknownRecords

static boolean ignoreUnknownRecords()

verbose

static boolean verbose()

zipBufferSize

static int zipBufferSize()