ezvcard.util

Class Gobble

java.lang.Object

ezvcard.util.Gobble

public class Gobble
extends Object

Gets the entire contents of an input stream or a file.

Author:

Michael Angstadt

Constructor Summary

Constructors

Constructor and Description
Gobble(InputStream in) Gets the contents of an input stream.
Gobble(Path file) Gets the contents of a file.
Gobble(Reader reader) Gets the contents of a reader.

Method Summary

Modifier and Type	Method and Description
byte[]	asByteArray() Gets the stream contents as a byte array.
String	asString() Gets the stream contents as a string.
String	asString(Charset charset) Gets the stream contents as a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

Gobble

public Gobble(Path file)

Gets the contents of a file.

Parameters:

file - the file

Gobble

public Gobble(InputStream in)

Gets the contents of an input stream.

Parameters:

in - the input stream

Gobble

public Gobble(Reader reader)

Gets the contents of a reader.

Parameters:

reader - the reader

Method Detail

asString

public String asString()
                throws IOException

Gets the stream contents as a string. If something other than a Reader was passed into this class's constructor, this method decodes the stream data using the system's default character encoding.

Returns:

the string

Throws:

IOException - if there was a problem reading from the stream

asString

public String asString(Charset charset)
                throws IOException

Gets the stream contents as a string.

Parameters:

charset - the character set to decode the stream data with (this parameter is ignored if a Reader was passed into this class's constructor)

Returns:

the string

Throws:

IOException - if there was a problem reading from the stream

asByteArray

public byte[] asByteArray()
                   throws IOException

Gets the stream contents as a byte array.

Returns:

the byte array

Throws:

IOException - if there was a problem reading from the stream

IllegalStateException - if a Reader object was passed into this class's constructor