Package org.dellroad.msrp.msg

Class BoundaryInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.dellroad.msrp.msg.BoundaryInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class BoundaryInputStream
extends FilterInputStream

Reads from an underlying InputStream until an MSRP end-line boundary is encountered.

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
BoundaryInputStream(InputStream input, String transactionId)	Constructor.

Method Summary

Modifier and Type	Method	Description
int	available()
byte	getFlagByte()	Get the flag byte that was found in the boundary string.
void	mark(int readlimit)	Mark this instance.
boolean	markSupported()	Determine if mark/reset is supported by this instance.
int	read()	Read the next byte.
int	read(byte[] b, int off, int len)
void	reset()	Reset this instance.
long	skip(long n)

Methods inherited from class java.io.FilterInputStream

close, read

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Detail

BoundaryInputStream

public BoundaryInputStream(InputStream input,
                           String transactionId)

Constructor.

Parameters:

input - underlying input

transactionId - transaction ID

Throws:

IllegalArgumentException - if input is null

IllegalArgumentException - if transactionId is null or invalid

Method Detail

read

public int read()
         throws IOException

Read the next byte.

Overrides:

read in class FilterInputStream

Returns:

next byte prior to boundary, or -1 if the boundary has been seen

Throws:

EOFException - if EOF is detected before the boundary is seen

IOException - if an I/O error occurs

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class FilterInputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class FilterInputStream

Throws:

IOException

mark

public void mark(int readlimit)

Mark this instance. This operation is not supported by BoundaryInputStream.

Overrides:

mark in class FilterInputStream

Throws:

UnsupportedOperationException - always

reset

public void reset()

Reset this instance. This operation is not supported by BoundaryInputStream.

Overrides:

reset in class FilterInputStream

Throws:

UnsupportedOperationException - always

markSupported

public boolean markSupported()

Determine if mark/reset is supported by this instance. Mark/reset is not supported by BoundaryInputStream.

Overrides:

markSupported in class FilterInputStream

Returns:

false always

getFlagByte

public byte getFlagByte()

Get the flag byte that was found in the boundary string.

If this instance's read() method has not yet returned -1, then the return value from this method is undefined.

Returns:

boundary flag byte