com.tplan.robot.util

Class BOMInputStream

java.lang.Object

java.io.InputStream

com.tplan.robot.util.BOMInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class BOMInputStream
extends InputStream

An input stream which transparently skips the leading BOM character.

Since:

5.0.3

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Constructor Summary

Constructors

Constructor and Description
BOMInputStream(InputStream inputStream)

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
byte[]	getBom() Return the BOM character retrieved from the stream.
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)

Methods inherited from class java.lang.Object

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

Constructor Detail

BOMInputStream

public BOMInputStream(InputStream inputStream)
               throws NullPointerException,
                      IOException

Throws:

NullPointerException

IOException

Method Detail

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

getBom

public byte[] getBom()

Return the BOM character retrieved from the stream.

Returns:

the bom character as a byte array.

Since:

6.2.3