Base64OutputStream

java.lang.Object
- java.io.OutputStream
- - java.io.FilterOutputStream
  - - org.apache.james.mime4j.codec.Base64OutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
```
public class Base64OutputStream
extends java.io.FilterOutputStream
```
This class implements section 6.8. Base64 Content-Transfer-Encoding from RFC 2045 Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies by Freed and Borenstein.
Code is based on Base64 and Base64OutputStream code from Commons-Codec 1.4.

See Also:

RFC 2045

Field Summary

Fields
Modifier and Type	Field and Description
`private static java.util.Set<java.lang.Byte>`	`BASE64_CHARS`
`private static byte`	`BASE64_PAD`
`(package private) static byte[]`	`BASE64_TABLE`
`private boolean`	`closed`
`private static byte[]`	`CRLF_SEPARATOR`
`private int`	`data`
`private static int`	`DEFAULT_LINE_LENGTH`
`private byte[]`	`encoded`
`private static int`	`ENCODED_BUFFER_SIZE`
`private int`	`lineLength`
`private int`	`linePosition`
`private byte[]`	`lineSeparator`
`private static int`	`MASK_6BITS`
`private int`	`modulus`
`private int`	`position`
`private byte[]`	`singleByte`

Fields inherited from class java.io.FilterOutputStream
out

Constructor Summary

Constructors
Constructor and Description
`Base64OutputStream(java.io.OutputStream out)` Creates a `Base64OutputStream` that writes the encoded data to the given output stream using the default line length (76) and line separator (CRLF).
`Base64OutputStream(java.io.OutputStream out, int lineLength)` Creates a `Base64OutputStream` that writes the encoded data to the given output stream using the given line length and the default line separator (CRLF).
`Base64OutputStream(java.io.OutputStream out, int lineLength, byte[] lineSeparator)` Creates a `Base64OutputStream` that writes the encoded data to the given output stream using the given line length and line separator.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`checkLineSeparator(byte[] lineSeparator)`
`void`	`close()`
`private void`	`close0()`
`void`	`flush()`
`private void`	`flush0()`
`void`	`write(byte[] buffer)`
`void`	`write(byte[] buffer, int offset, int length)`
`void`	`write(int b)`
`private void`	`write0(byte[] buffer, int from, int to)`
`private void`	`writeLineSeparator()`
`private void`	`writePad()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_LINE_LENGTH
```
private static final int DEFAULT_LINE_LENGTH
```
    See Also:
    
    Constant Field Values
  - CRLF_SEPARATOR
```
private static final byte[] CRLF_SEPARATOR
```
  - BASE64_TABLE
```
static final byte[] BASE64_TABLE
```
  - BASE64_PAD
```
private static final byte BASE64_PAD
```
    See Also:
    
    Constant Field Values
  - BASE64_CHARS
```
private static final java.util.Set<java.lang.Byte> BASE64_CHARS
```
  - MASK_6BITS
```
private static final int MASK_6BITS
```
    See Also:
    
    Constant Field Values
  - ENCODED_BUFFER_SIZE
```
private static final int ENCODED_BUFFER_SIZE
```
    See Also:
    
    Constant Field Values
  - singleByte
```
private final byte[] singleByte
```
  - lineLength
```
private final int lineLength
```
  - lineSeparator
```
private final byte[] lineSeparator
```
  - closed
```
private boolean closed
```
  - encoded
```
private final byte[] encoded
```
  - position
```
private int position
```
  - data
```
private int data
```
  - modulus
```
private int modulus
```
  - linePosition
```
private int linePosition
```
- Constructor Detail
  - Base64OutputStream
```
public Base64OutputStream(java.io.OutputStream out)
```
    Creates a Base64OutputStream that writes the encoded data to the given output stream using the default line length (76) and line separator (CRLF).
    
    Parameters:
    
    out - underlying output stream.
  - Base64OutputStream
```
public Base64OutputStream(java.io.OutputStream out,
                          int lineLength)
```
    Creates a Base64OutputStream that writes the encoded data to the given output stream using the given line length and the default line separator (CRLF).
    The given line length will be rounded up to the nearest multiple of 4. If the line length is zero then the output will not be split into lines.
    
    Parameters:
    
    out - underlying output stream.
    
    lineLength - desired line length.
  - Base64OutputStream
```
public Base64OutputStream(java.io.OutputStream out,
                          int lineLength,
                          byte[] lineSeparator)
```
    Creates a Base64OutputStream that writes the encoded data to the given output stream using the given line length and line separator.
    The given line length will be rounded up to the nearest multiple of 4. If the line length is zero then the output will not be split into lines and the line separator is ignored.
    The line separator must not include characters from the BASE64 alphabet (including the padding character =).
    
    Parameters:
    
    out - underlying output stream.
    
    lineLength - desired line length.
    
    lineSeparator - line separator to use.
- Method Detail
  - write
```
public final void write(int b)
                 throws java.io.IOException
```
    Overrides:
    
    write in class java.io.FilterOutputStream
    
    Throws:
    
    java.io.IOException
  - write
```
public final void write(byte[] buffer)
                 throws java.io.IOException
```
    Overrides:
    
    write in class java.io.FilterOutputStream
    
    Throws:
    
    java.io.IOException
  - write
```
public final void write(byte[] buffer,
                        int offset,
                        int length)
                 throws java.io.IOException
```
    Overrides:
    
    write in class java.io.FilterOutputStream
    
    Throws:
    
    java.io.IOException
  - flush
```
public void flush()
           throws java.io.IOException
```
    Specified by:
    
    flush in interface java.io.Flushable
    
    Overrides:
    
    flush in class java.io.FilterOutputStream
    
    Throws:
    
    java.io.IOException
  - close
```
public void close()
           throws java.io.IOException
```
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Overrides:
    
    close in class java.io.FilterOutputStream
    
    Throws:
    
    java.io.IOException
  - write0
```
private void write0(byte[] buffer,
                    int from,
                    int to)
             throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - flush0
```
private void flush0()
             throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - close0
```
private void close0()
             throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - writePad
```
private void writePad()
               throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - writeLineSeparator
```
private void writeLineSeparator()
                         throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - checkLineSeparator
```
private void checkLineSeparator(byte[] lineSeparator)
```

Class Base64OutputStream

Field Summary

Fields inherited from class java.io.FilterOutputStream

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_LINE_LENGTH

CRLF_SEPARATOR

BASE64_TABLE

BASE64_PAD

BASE64_CHARS

MASK_6BITS

ENCODED_BUFFER_SIZE

singleByte

lineLength

lineSeparator

closed

encoded

position

data

modulus

linePosition

Constructor Detail

Base64OutputStream

Base64OutputStream

Base64OutputStream

Method Detail

write

write

write

flush

close

write0

flush0

close0

writePad

writeLineSeparator

checkLineSeparator