com.openexchange.mail.mime.converters

Class HeaderOutputStream

java.lang.Object

java.io.OutputStream

java.io.ByteArrayOutputStream

com.openexchange.mail.mime.converters.HeaderOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public final class HeaderOutputStream
extends java.io.ByteArrayOutputStream

HeaderOutputStream - Reads until two subsequent CR?LF sequences are detected

Author:

Thorben Betten

Constructor Summary

Constructors

Constructor and Description
HeaderOutputStream() Creates a new byte array output stream.
HeaderOutputStream(int size) Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closing a byte array output stream has no effect.
void	reset() Resets the count field of this byte array output stream to zero, so that all currently accumulated output in the output stream is discarded.
int	size() Returns the current size of the buffer.
byte[]	toByteArray() Creates a newly allocated byte array.
byte[]	toByteArray(int off, int size) Creates a newly allocated byte array.
java.lang.String	toString() Converts the buffer's contents into a string, translating bytes into characters according to the platform's default character encoding.
java.lang.String	toString(int hibyte) Deprecated. This method does not properly convert bytes into characters. As of JDK 1.1, the preferred way to do this is via the toString(String enc) method, which takes an encoding-name argument, or the toString() method, which uses the platform's default character encoding.
java.lang.String	toString(java.lang.String enc) Converts the buffer's contents into a string, translating bytes into characters according to the specified character encoding.
void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array starting at offset off to this byte array output stream.
void	write(int b) Writes the specified byte to this byte array output stream.
void	writeTo(java.io.OutputStream out) Writes the complete contents of this byte array output stream to the specified output stream argument, as if by calling the output stream's write method using out.write(buf, 0, count).

Methods inherited from class java.io.OutputStream

flush, write

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderOutputStream

public HeaderOutputStream()

Creates a new byte array output stream. The buffer capacity is initially 32 bytes, though its size increases if necessary.

HeaderOutputStream

public HeaderOutputStream(int size)

Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.

Parameters:

size - The initial size.

Throws:

java.lang.IllegalArgumentException - If size is negative.

Method Detail

write

public void write(int b)

Writes the specified byte to this byte array output stream.

Overrides:

write in class java.io.ByteArrayOutputStream

Parameters:

b - The byte to be written.

write

public void write(byte[] b,
         int off,
         int len)

Writes len bytes from the specified byte array starting at offset off to this byte array output stream.

Overrides:

write in class java.io.ByteArrayOutputStream

Parameters:

b - The data.

off - The start offset in the data.

len - The number of bytes to write.

writeTo

public void writeTo(java.io.OutputStream out)
             throws java.io.IOException

Writes the complete contents of this byte array output stream to the specified output stream argument, as if by calling the output stream's write method using out.write(buf, 0, count).

Overrides:

writeTo in class java.io.ByteArrayOutputStream

Parameters:

out - The output stream to which to write the data.

Throws:

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

reset

public void reset()

Resets the count field of this byte array output stream to zero, so that all currently accumulated output in the output stream is discarded. The output stream can be used again, reusing the already allocated buffer space.

Overrides:

reset in class java.io.ByteArrayOutputStream

toByteArray

public byte[] toByteArray()

Creates a newly allocated byte array. Its size is the current size of this output stream and the valid contents of the buffer have been copied into it.

Overrides:

toByteArray in class java.io.ByteArrayOutputStream

Returns:

The current contents of this output stream, as a byte array.

toByteArray

public byte[] toByteArray(int off,
                 int size)

Creates a newly allocated byte array. Its size is specified size and the valid contents starting from specified offset off are going to be copied into it.

Parameters:

off - The offset in valid contents

size - The demanded size

Returns:

The current contents of this output stream, as a byte array.

size

public int size()

Returns the current size of the buffer.

Overrides:

size in class java.io.ByteArrayOutputStream

Returns:

The value of the count field, which is the number of valid bytes in this output stream.

toString

public java.lang.String toString()

Converts the buffer's contents into a string, translating bytes into characters according to the platform's default character encoding.

Overrides:

toString in class java.io.ByteArrayOutputStream

Returns:

A string translated from the buffer's contents.

toString

public java.lang.String toString(java.lang.String enc)
                          throws java.io.UnsupportedEncodingException

Converts the buffer's contents into a string, translating bytes into characters according to the specified character encoding.

Overrides:

toString in class java.io.ByteArrayOutputStream

Parameters:

enc - The character-encoding name.

Returns:

A string translated from the buffer's contents.

Throws:

java.io.UnsupportedEncodingException - If the named encoding is not supported.

toString

@Deprecated
public java.lang.String toString(int hibyte)

Deprecated. This method does not properly convert bytes into characters. As of JDK 1.1, the preferred way to do this is via the toString(String enc) method, which takes an encoding-name argument, or the toString() method, which uses the platform's default character encoding.

Creates a newly allocated string. Its size is the current size of the output stream and the valid contents of the buffer have been copied into it. Each character c in the resulting string is constructed from the corresponding element b in the byte array such that:

 c == (char) (((hibyte & 0xff) << 8) | (b & 0xff))
 

Overrides:

toString in class java.io.ByteArrayOutputStream

Parameters:

hibyte - The high byte of each resulting Unicode character.

Returns:

The current contents of the output stream, as a string.

close

public void close()
           throws java.io.IOException

Closing a byte array output stream has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.ByteArrayOutputStream

Throws:

java.io.IOException