public final class Base64Variant
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
static int |
BASE64_VALUE_INVALID
Marker used to denote ascii characters that do not correspond
to a 6-bit value (in this variant), and is not used as a padding
character.
|
static int |
BASE64_VALUE_PADDING
Marker used to denote ascii character (in decoding table) that
is the padding character using this variant (if any).
|
Constructor and Description |
---|
Base64Variant(Base64Variant base,
java.lang.String name,
boolean usesPadding,
char paddingChar,
int maxLineLength)
"Copy constructor" that can be used when the base alphabet is identical
to one used by another variant, but other details (padding, maximum
line length) differ
|
Base64Variant(Base64Variant base,
java.lang.String name,
int maxLineLength)
"Copy constructor" that can be used when the base alphabet is identical
to one used by another variant except for the maximum line length
(and obviously, name).
|
Base64Variant(java.lang.String name,
java.lang.String base64Alphabet,
boolean usesPadding,
char paddingChar,
int maxLineLength) |
Modifier and Type | Method and Description |
---|---|
byte[] |
decode(java.lang.String input)
Convenience method for decoding contents of a Base64-encoded String,
using this variant's settings.
|
void |
decode(java.lang.String str,
ByteArrayBuilder builder)
Convenience method for decoding contents of a Base64-encoded String,
using this variant's settings
and appending decoded binary data using provided
ByteArrayBuilder . |
int |
decodeBase64Byte(byte b) |
int |
decodeBase64Char(char c) |
int |
decodeBase64Char(int ch) |
java.lang.String |
encode(byte[] input)
Convenience method for converting given byte array as base64 encoded
String using this variant's settings.
|
java.lang.String |
encode(byte[] input,
boolean addQuotes)
Convenience method for converting given byte array as base64 encoded String
using this variant's settings, optionally enclosed in double-quotes.
|
java.lang.String |
encode(byte[] input,
boolean addQuotes,
java.lang.String linefeed)
Convenience method for converting given byte array as base64 encoded String
using this variant's settings, optionally enclosed in double-quotes.
|
byte |
encodeBase64BitsAsByte(int value) |
char |
encodeBase64BitsAsChar(int value) |
int |
encodeBase64Chunk(int b24,
byte[] buffer,
int ptr)
Method that encodes given right-aligned (LSB) 24-bit value
into 4 base64 bytes (ascii), stored in given result buffer.
|
int |
encodeBase64Chunk(int b24,
char[] buffer,
int ptr)
Method that encodes given right-aligned (LSB) 24-bit value
into 4 base64 characters, stored in given result buffer.
|
void |
encodeBase64Chunk(java.lang.StringBuilder sb,
int b24) |
int |
encodeBase64Partial(int bits,
int outputBytes,
byte[] buffer,
int outPtr)
Method that outputs partial chunk (which only encodes one
or two bytes of data).
|
int |
encodeBase64Partial(int bits,
int outputBytes,
char[] buffer,
int outPtr)
Method that outputs partial chunk (which only encodes one
or two bytes of data).
|
void |
encodeBase64Partial(java.lang.StringBuilder sb,
int bits,
int outputBytes) |
boolean |
equals(java.lang.Object o) |
int |
getMaxLineLength() |
java.lang.String |
getName() |
byte |
getPaddingByte() |
char |
getPaddingChar() |
int |
hashCode() |
java.lang.String |
missingPaddingMessage()
Helper method that will construct a message to use in exceptions for cases where input ends
prematurely in place where padding would be expected.
|
java.lang.String |
toString() |
boolean |
usesPadding() |
boolean |
usesPaddingChar(char c) |
boolean |
usesPaddingChar(int ch) |
public static final int BASE64_VALUE_INVALID
public static final int BASE64_VALUE_PADDING
public Base64Variant(java.lang.String name, java.lang.String base64Alphabet, boolean usesPadding, char paddingChar, int maxLineLength)
public Base64Variant(Base64Variant base, java.lang.String name, int maxLineLength)
public Base64Variant(Base64Variant base, java.lang.String name, boolean usesPadding, char paddingChar, int maxLineLength)
public java.lang.String getName()
public boolean usesPadding()
public boolean usesPaddingChar(char c)
public boolean usesPaddingChar(int ch)
public char getPaddingChar()
public byte getPaddingByte()
public int getMaxLineLength()
public int decodeBase64Char(char c)
public int decodeBase64Char(int ch)
public int decodeBase64Byte(byte b)
public char encodeBase64BitsAsChar(int value)
public int encodeBase64Chunk(int b24, char[] buffer, int ptr)
public void encodeBase64Chunk(java.lang.StringBuilder sb, int b24)
public int encodeBase64Partial(int bits, int outputBytes, char[] buffer, int outPtr)
outputBytes
- Number of encoded bytes included (either 1 or 2)public void encodeBase64Partial(java.lang.StringBuilder sb, int bits, int outputBytes)
public byte encodeBase64BitsAsByte(int value)
public int encodeBase64Chunk(int b24, byte[] buffer, int ptr)
public int encodeBase64Partial(int bits, int outputBytes, byte[] buffer, int outPtr)
outputBytes
- Number of encoded bytes included (either 1 or 2)public java.lang.String encode(byte[] input)
input
- Byte array to encodepublic java.lang.String encode(byte[] input, boolean addQuotes)
input
- Byte array to encodeaddQuotes
- Whether to surround resulting value in double quotes or notpublic java.lang.String encode(byte[] input, boolean addQuotes, java.lang.String linefeed)
input
- Byte array to encodeaddQuotes
- Whether to surround resulting value in double quotes or notpublic byte[] decode(java.lang.String input) throws java.lang.IllegalArgumentException
input
- java.lang.IllegalArgumentException
- if input is not valid base64 encoded datapublic void decode(java.lang.String str, ByteArrayBuilder builder) throws java.lang.IllegalArgumentException
ByteArrayBuilder
.
NOTE: builder will NOT be reset before decoding (nor cleared afterwards); assumption is that caller will ensure it is given in proper state, and used as appropriate afterwards.
java.lang.IllegalArgumentException
- if input is not valid base64 encoded datapublic java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String missingPaddingMessage()
Copyright © 2010 - 2020 Adobe. All Rights Reserved