com.helger.commons.charset

Class CharsetHelper.InputStreamAndCharset

java.lang.Object

com.helger.commons.charset.CharsetHelper.InputStreamAndCharset

All Implemented Interfaces:

IHasInputStream

Enclosing class:

CharsetHelper

public static final class CharsetHelper.InputStreamAndCharset
extends Object
implements IHasInputStream

A wrapper that has an InputStream, an optional Unicode BOM as EUnicodeBOM and an optional Charset.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
InputStreamAndCharset(InputStream aIS, EUnicodeBOM eBOM, Charset aCharset)

Method Summary

Modifier and Type	Method and Description
EUnicodeBOM	getBOM()
Charset	getCharset()
Charset	getCharset(Charset aFallbackCharset)
InputStream	getInputStream() Get the input stream to read from the object.
boolean	hasBOM()
boolean	hasCharset()
boolean	isReadMultiple() Check if the InputStream from IHasInputStream.getInputStream() and IHasInputStream.getBufferedInputStream() can be acquired more than once.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.io.IHasInputStream

getBufferedInputStream

Constructor Detail

InputStreamAndCharset

public InputStreamAndCharset(@Nonnull
                             InputStream aIS,
                             @Nullable
                             EUnicodeBOM eBOM,
                             @Nullable
                             Charset aCharset)

Method Detail

getInputStream

@Nonnull
public InputStream getInputStream()

Description copied from interface: IHasInputStream

Get the input stream to read from the object. Each time this method is called, a new InputStream needs to be created.

Specified by:

getInputStream in interface IHasInputStream

Returns:

null if resolving failed.

isReadMultiple

public boolean isReadMultiple()

Description copied from interface: IHasInputStream

Check if the InputStream from IHasInputStream.getInputStream() and IHasInputStream.getBufferedInputStream() can be acquired more than once.

Specified by:

isReadMultiple in interface IHasInputStream

Returns:

true if the input stream can be acquired more than once, false if not.

getBOM

@Nullable
public EUnicodeBOM getBOM()

hasBOM

public boolean hasBOM()

getCharset

@Nullable
public Charset getCharset()

hasCharset

public boolean hasCharset()

getCharset

@Nullable
public Charset getCharset(@Nullable
                                     Charset aFallbackCharset)