net.freeutils.tnef

Class TNEFInputStream

java.lang.Object

net.freeutils.tnef.TNEFInputStream

public class TNEFInputStream
extends java.lang.Object

The TNEFInputStream class provides low-level access to a TNEF stream.

Since:

2003-07-25

Author:

Amichai Rothman

Constructor Summary

Constructors

Constructor and Description
TNEFInputStream(java.io.File file) Constructs a TNEFInputStream whose content is retrieved from the given File.
TNEFInputStream(java.io.InputStream in) Constructs a TNEFInputStream whose content is retrieved from the given InputStream.
TNEFInputStream(java.lang.String filename) Constructs a TNEFInputStream whose content is retrieved from the given file.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the TNEFInputStream and underlying InputStream.
int	getKey() Returns the TNEF stream key.
Attr	readAttr() Reads a TNEF attribute from the stream.
protected int	readU16() Reads a 16-bit unsigned value from the stream.
protected long	readU32() Reads a 32-bit unsigned value from the stream.
protected int	readU8() Reads an 8-bit unsigned value from the stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

TNEFInputStream

public TNEFInputStream(java.io.InputStream in)
                throws java.io.IOException

Constructs a TNEFInputStream whose content is retrieved from the given InputStream.

Parameters:

in - an InputStream supplying a TNEF data stream

Throws:

java.io.IOException - if the input does not start with a valid TNEF signature, or if an I/O error occurs

TNEFInputStream

public TNEFInputStream(java.io.File file)
                throws java.io.IOException

Constructs a TNEFInputStream whose content is retrieved from the given File.

Parameters:

file - a file containing a TNEF data stream

Throws:

java.io.IOException - if the input does not start with a valid TNEF signature, or if an I/O error occurs

TNEFInputStream

public TNEFInputStream(java.lang.String filename)
                throws java.io.IOException

Constructs a TNEFInputStream whose content is retrieved from the given file.

Parameters:

filename - the fully qualified filename of a file containing a TNEF data stream

Throws:

java.io.IOException - if the input does not start with a valid TNEF signature, or if an I/O error occurs

Method Detail

close

public void close()
           throws java.io.IOException

Closes the TNEFInputStream and underlying InputStream.

Throws:

java.io.IOException - if an I/O error occurs

readU8

protected int readU8()
              throws java.io.IOException

Reads an 8-bit unsigned value from the stream.

Returns:

an 8-bit unsigned value read from the stream

Throws:

java.io.IOException - if the stream end is reached, or if an I/O error occurs

readU16

protected int readU16()
               throws java.io.IOException

Reads a 16-bit unsigned value from the stream.

Returns:

a 16-bit unsigned value read from the stream

Throws:

java.io.IOException - if the stream end is reached, or if an I/O error occurs

readU32

protected long readU32()
                throws java.io.IOException

Reads a 32-bit unsigned value from the stream.

Returns:

a 32-bit unsigned value read from the stream

Throws:

java.io.IOException - if the stream end is reached, or if an I/O error occurs

readAttr

public Attr readAttr()
              throws java.io.IOException

Reads a TNEF attribute from the stream.

Returns:

a TNEF attribute read from the stream, or null if the stream end is reached

Throws:

java.io.IOException - if the stream does not contain a valid TNEF attribute, or if an I/O error occurs

getKey

public int getKey()

Returns the TNEF stream key.

Returns:

the TNEF stream key