com.staros.section

Class SectionReader

java.lang.Object

com.staros.section.SectionReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class SectionReader
extends java.lang.Object
implements java.io.Closeable

Constructor Summary

Constructors

Constructor and Description
SectionReader(java.io.InputStream in)

Method Summary

Modifier and Type	Method and Description
void	close()
void	forEach(SectionConsumer<? super Section> action) Convenient interface to iterate all sections, if any excepted with IOException, the iteration will be stopped.
Section	next() Move to next available section.

Methods inherited from class java.lang.Object

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

Constructor Detail

SectionReader

public SectionReader(java.io.InputStream in)

Method Detail

next

public Section next()
             throws java.io.IOException

Move to next available section. Possibly a SECTION_DONE, caller needs to check Section.isDone() to ensure the section is valid. next() call followed by a SECTION_DONE, will yield an EOFException. Suggest use forEach() interface to keep away from processing SECTION_DONE.

Returns:

Section object with header and stream

Throws:

java.io.IOException - except from input stream, or EOFException if already reaches SECTION_DONE

forEach

public void forEach(SectionConsumer<? super Section> action)
             throws java.io.IOException,
                    java.lang.IllegalStateException

Convenient interface to iterate all sections, if any excepted with IOException, the iteration will be stopped.

     SectionReader reader = new SectionReader(in);
     reader.forEach(x -> processSection(x));
 

Parameters:

action - the action to accept Section as argument, possibly throws IOException

Throws:

java.io.IOException - exception in read bytes from input stream

java.lang.IllegalStateException - SectionReader has been iterated with next()

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException