com.pega.mobile.utils.io

Class BOMInputStream

java.lang.Object

java.io.InputStream

com.pega.mobile.utils.io.BOMInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class BOMInputStream
extends InputStream

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BOMInputStream.BOM Type safe enumeration class that describes the different types of Unicode BOMs.

Constructor Summary

Constructors

Constructor and Description
BOMInputStream(InputStream inputStream) Constructs a new BOMInputStream that wraps the specified InputStream.

Method Summary

Methods

Modifier and Type	Method and Description
int	available()
void	close()
BOMInputStream.BOM	getBOM() Returns the BOM that was detected in the wrapped InputStream object.
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)
BOMInputStream	skipBOM() Skips the BOM that was found in the wrapped InputStream object.

Methods inherited from class java.lang.Object

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

Constructor Detail

BOMInputStream

public BOMInputStream(InputStream inputStream)
               throws IOException

Constructs a new BOMInputStream that wraps the specified InputStream.

Parameters:

inputStream - an InputStream.

Throws:

IOException - on reading from the specified InputStream when trying to detect the Unicode BOM.

Method Detail

getBOM

public final BOMInputStream.BOM getBOM()

Returns the BOM that was detected in the wrapped InputStream object.

Returns:

a BOM value.

skipBOM

public final BOMInputStream skipBOM()
                             throws IOException

Skips the BOM that was found in the wrapped InputStream object.

Returns:

this BOMInputStream.

Throws:

IOException - when trying to skip the BOM from the wrapped InputStream object.

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

NullPointerException

read

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

Overrides:

read in class InputStream

Throws:

IOException

NullPointerException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream