java.lang.Object
- org.apache.commons.codec.binary.BaseNCodec
- - org.apache.commons.codec.binary.Base32

All Implemented Interfaces:

BinaryDecoder, BinaryEncoder, Decoder, Encoder
```
public class Base32
extends BaseNCodec
```
Provides Base32 encoding and decoding as defined by RFC 4648.
The class can be parameterized in the following manner with various constructors:
- Whether to use the "base32hex" variant instead of the default "base32"
- Line length: Default 76. Line length that aren't multiples of 8 will still essentially end up being multiples of 8 in the encoded data.
- Line separator: Default is CRLF ("\r\n")
This class operates directly on byte streams, and not character streams.

This class is thread-safe.
Since:

1.5

See Also:

RFC 4648

Field Summary
- Fields inherited from class org.apache.commons.codec.binary.BaseNCodec
  MIME_CHUNK_SIZE, PEM_CHUNK_SIZE

Constructor Summary

Constructors
Constructor	Description
`Base32()`	Creates a Base32 codec used for decoding and encoding.
`Base32(boolean useHex)`	Creates a Base32 codec used for decoding and encoding.
`Base32(boolean useHex, byte padding)`	Creates a Base32 codec used for decoding and encoding.
`Base32(byte pad)`	Creates a Base32 codec used for decoding and encoding.
`Base32(int lineLength)`	Creates a Base32 codec used for decoding and encoding.
`Base32(int lineLength, byte[] lineSeparator)`	Creates a Base32 codec used for decoding and encoding.
`Base32(int lineLength, byte[] lineSeparator, boolean useHex)`	Creates a Base32 / Base32 Hex codec used for decoding and encoding.
`Base32(int lineLength, byte[] lineSeparator, boolean useHex, byte padding)`	Creates a Base32 / Base32 Hex codec used for decoding and encoding.
`Base32(int lineLength, byte[] lineSeparator, boolean useHex, byte padding, CodecPolicy decodingPolicy)`	Creates a Base32 / Base32 Hex codec used for decoding and encoding.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

boolean isInAlphabet(byte octet)
Returns whether or not the octet is in the Base32 alphabet.
- Methods inherited from class org.apache.commons.codec.binary.BaseNCodec
  decode, decode, decode, encode, encode, encode, encodeAsString, encodeToString, getChunkSeparator, getCodecPolicy, getEncodedLength, isInAlphabet, isInAlphabet, isStrictDecoding
- Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Base32
```
public Base32()
```
    Creates a Base32 codec used for decoding and encoding.
    When encoding the line length is 0 (no chunking).
  - Base32
```
public Base32(boolean useHex)
```
    Creates a Base32 codec used for decoding and encoding.
    When encoding the line length is 0 (no chunking).
    
    Parameters:
    
    useHex - if true then use Base32 Hex alphabet
  - Base32
```
public Base32(boolean useHex,
              byte padding)
```
    Creates a Base32 codec used for decoding and encoding.
    When encoding the line length is 0 (no chunking).
    
    Parameters:
    
    useHex - if true then use Base32 Hex alphabet
    
    padding - byte used as padding byte.
  - Base32
```
public Base32(byte pad)
```
    Creates a Base32 codec used for decoding and encoding.
    When encoding the line length is 0 (no chunking).
    
    Parameters:
    
    pad - byte used as padding byte.
  - Base32
```
public Base32(int lineLength)
```
    Creates a Base32 codec used for decoding and encoding.
    When encoding the line length is given in the constructor, the line separator is CRLF.
    
    Parameters:
    
    lineLength - Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 8). If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.
  - Base32
```
public Base32(int lineLength,
              byte[] lineSeparator)
```
    Creates a Base32 codec used for decoding and encoding.
    When encoding the line length and line separator are given in the constructor.
    
    Line lengths that aren't multiples of 8 will still essentially end up being multiples of 8 in the encoded data.
    
    Parameters:
    
    lineLength - Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 8). If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.
    
    lineSeparator - Each line of encoded data will end with this sequence of bytes.
    
    Throws:
    
    java.lang.IllegalArgumentException - Thrown when the lineSeparator contains Base32 characters.
  - Base32
```
public Base32(int lineLength,
              byte[] lineSeparator,
              boolean useHex)
```
    Creates a Base32 / Base32 Hex codec used for decoding and encoding.
    When encoding the line length and line separator are given in the constructor.
    
    Line lengths that aren't multiples of 8 will still essentially end up being multiples of 8 in the encoded data.
    
    Parameters:
    
    lineLength - Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 8). If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.
    
    lineSeparator - Each line of encoded data will end with this sequence of bytes.
    
    useHex - if true, then use Base32 Hex alphabet, otherwise use Base32 alphabet
    
    Throws:
    
    java.lang.IllegalArgumentException - Thrown when the lineSeparator contains Base32 characters. Or the lineLength > 0 and lineSeparator is null.
  - Base32
```
public Base32(int lineLength,
              byte[] lineSeparator,
              boolean useHex,
              byte padding)
```
    Creates a Base32 / Base32 Hex codec used for decoding and encoding.
    When encoding the line length and line separator are given in the constructor.
    
    Line lengths that aren't multiples of 8 will still essentially end up being multiples of 8 in the encoded data.
    
    Parameters:
    
    lineLength - Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 8). If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.
    
    lineSeparator - Each line of encoded data will end with this sequence of bytes.
    
    useHex - if true, then use Base32 Hex alphabet, otherwise use Base32 alphabet
    
    padding - byte used as padding byte.
    
    Throws:
    
    java.lang.IllegalArgumentException - Thrown when the lineSeparator contains Base32 characters. Or the lineLength > 0 and lineSeparator is null.
  - Base32
```
public Base32(int lineLength,
              byte[] lineSeparator,
              boolean useHex,
              byte padding,
              CodecPolicy decodingPolicy)
```
    Creates a Base32 / Base32 Hex codec used for decoding and encoding.
    When encoding the line length and line separator are given in the constructor.
    
    Line lengths that aren't multiples of 8 will still essentially end up being multiples of 8 in the encoded data.
    
    Parameters:
    
    lineLength - Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 8). If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.
    
    lineSeparator - Each line of encoded data will end with this sequence of bytes.
    
    useHex - if true, then use Base32 Hex alphabet, otherwise use Base32 alphabet
    
    padding - byte used as padding byte.
    
    decodingPolicy - The decoding policy.
    
    Throws:
    
    java.lang.IllegalArgumentException - Thrown when the lineSeparator contains Base32 characters. Or the lineLength > 0 and lineSeparator is null.
    
    Since:
    
    1.15
- Method Detail
  - isInAlphabet
```
public boolean isInAlphabet(byte octet)
```
    Returns whether or not the octet is in the Base32 alphabet.
    
    Parameters:
    
    octet - The value to test
    
    Returns:
    
    true if the value is defined in the the Base32 alphabet false otherwise.

Class Base32

Field Summary

Fields inherited from class org.apache.commons.codec.binary.BaseNCodec

Constructor Summary

Method Summary

Methods inherited from class org.apache.commons.codec.binary.BaseNCodec

Methods inherited from class java.lang.Object

Constructor Detail

Base32

Base32

Base32

Base32

Base32

Base32

Base32

Base32

Base32

Method Detail

isInAlphabet