Package com.google.common.io

Class BaseEncoding.StandardBaseEncoding

java.lang.Object

com.google.common.io.BaseEncoding

com.google.common.io.BaseEncoding.StandardBaseEncoding

Direct Known Subclasses:

BaseEncoding.Base16Encoding, BaseEncoding.Base64Encoding

Enclosing class:

BaseEncoding

static class BaseEncoding.StandardBaseEncoding
extends BaseEncoding

Nested Class Summary

Nested classes/interfaces inherited from class com.google.common.io.BaseEncoding

BaseEncoding.Base16Encoding, BaseEncoding.Base64Encoding, BaseEncoding.DecodingException, BaseEncoding.SeparatedBaseEncoding, BaseEncoding.StandardBaseEncoding

Field Summary

Fields

Modifier and Type	Field	Description
(package private) BaseEncoding.Alphabet	alphabet
private BaseEncoding	lowerCase
(package private) java.lang.Character	paddingChar
private BaseEncoding	upperCase

Constructor Summary

Constructors

Constructor	Description
StandardBaseEncoding(BaseEncoding.Alphabet alphabet, java.lang.Character paddingChar)
StandardBaseEncoding(java.lang.String name, java.lang.String alphabetChars, java.lang.Character paddingChar)

Method Summary

Modifier and Type	Method	Description
boolean	canDecode(java.lang.CharSequence chars)	Determines whether the specified character sequence is a valid encoded string according to this encoding.
(package private) int	decodeTo(byte[] target, java.lang.CharSequence chars)
java.io.InputStream	decodingStream(java.io.Reader reader)	Returns an InputStream that decodes base-encoded input from the specified Reader.
(package private) void	encodeChunkTo(java.lang.Appendable target, byte[] bytes, int off, int len)
(package private) void	encodeTo(java.lang.Appendable target, byte[] bytes, int off, int len)
java.io.OutputStream	encodingStream(java.io.Writer out)	Returns an OutputStream that encodes bytes using this encoding into the specified Writer.
boolean	equals(java.lang.Object other)
int	hashCode()
BaseEncoding	lowerCase()	Returns an encoding that behaves equivalently to this encoding, but encodes and decodes with lowercase letters.
(package private) int	maxDecodedSize(int chars)
(package private) int	maxEncodedSize(int bytes)
(package private) BaseEncoding	newInstance(BaseEncoding.Alphabet alphabet, java.lang.Character paddingChar)
BaseEncoding	omitPadding()	Returns an encoding that behaves equivalently to this encoding, but omits any padding characters as specified by RFC 4648 section 3.2, Padding of Encoded Data.
java.lang.String	toString()
(package private) java.lang.CharSequence	trimTrailingPadding(java.lang.CharSequence chars)
BaseEncoding	upperCase()	Returns an encoding that behaves equivalently to this encoding, but encodes and decodes with uppercase letters.
BaseEncoding	withPadChar(char padChar)	Returns an encoding that behaves equivalently to this encoding, but uses an alternate character for padding.
BaseEncoding	withSeparator(java.lang.String separator, int afterEveryChars)	Returns an encoding that behaves equivalently to this encoding, but adds a separator string after every n characters.

Methods inherited from class com.google.common.io.BaseEncoding

base16, base32, base32Hex, base64, base64Url, decode, decodeChecked, decodingSource, encode, encode, encodingSink, ignoringReader, separatingAppendable, separatingWriter

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

alphabet

final BaseEncoding.Alphabet alphabet

paddingChar

final java.lang.Character paddingChar

upperCase

private transient BaseEncoding upperCase

lowerCase

private transient BaseEncoding lowerCase

Constructor Detail

StandardBaseEncoding

StandardBaseEncoding(java.lang.String name,
                     java.lang.String alphabetChars,
                     java.lang.Character paddingChar)

StandardBaseEncoding

StandardBaseEncoding(BaseEncoding.Alphabet alphabet,
                     java.lang.Character paddingChar)

Method Detail

maxEncodedSize

int maxEncodedSize(int bytes)

Specified by:

maxEncodedSize in class BaseEncoding

encodingStream

@GwtIncompatible
public java.io.OutputStream encodingStream(java.io.Writer out)

Description copied from class: BaseEncoding

Returns an OutputStream that encodes bytes using this encoding into the specified Writer. When the returned OutputStream is closed, so is the backing Writer.

Specified by:

encodingStream in class BaseEncoding

encodeTo

void encodeTo(java.lang.Appendable target,
              byte[] bytes,
              int off,
              int len)
       throws java.io.IOException

Specified by:

encodeTo in class BaseEncoding

Throws:

java.io.IOException

encodeChunkTo

void encodeChunkTo(java.lang.Appendable target,
                   byte[] bytes,
                   int off,
                   int len)
            throws java.io.IOException

Throws:

java.io.IOException

maxDecodedSize

int maxDecodedSize(int chars)

Specified by:

maxDecodedSize in class BaseEncoding

trimTrailingPadding

java.lang.CharSequence trimTrailingPadding(java.lang.CharSequence chars)

Overrides:

trimTrailingPadding in class BaseEncoding

canDecode

public boolean canDecode(java.lang.CharSequence chars)

Description copied from class: BaseEncoding

Determines whether the specified character sequence is a valid encoded string according to this encoding.

Specified by:

canDecode in class BaseEncoding

decodeTo

int decodeTo(byte[] target,
             java.lang.CharSequence chars)
      throws BaseEncoding.DecodingException

Specified by:

decodeTo in class BaseEncoding

Throws:

BaseEncoding.DecodingException

decodingStream

@GwtIncompatible
public java.io.InputStream decodingStream(java.io.Reader reader)

Description copied from class: BaseEncoding

Returns an InputStream that decodes base-encoded input from the specified Reader. The returned stream throws a BaseEncoding.DecodingException upon decoding-specific errors.

Specified by:

decodingStream in class BaseEncoding

omitPadding

public BaseEncoding omitPadding()

Description copied from class: BaseEncoding

Returns an encoding that behaves equivalently to this encoding, but omits any padding characters as specified by RFC 4648 section 3.2, Padding of Encoded Data.

Specified by:

omitPadding in class BaseEncoding

withPadChar

public BaseEncoding withPadChar(char padChar)

Description copied from class: BaseEncoding

Returns an encoding that behaves equivalently to this encoding, but uses an alternate character for padding.

Specified by:

withPadChar in class BaseEncoding

withSeparator

public BaseEncoding withSeparator(java.lang.String separator,
                                  int afterEveryChars)

Description copied from class: BaseEncoding

Returns an encoding that behaves equivalently to this encoding, but adds a separator string after every n characters. Any occurrences of any characters that occur in the separator are skipped over in decoding.

Specified by:

withSeparator in class BaseEncoding

upperCase

public BaseEncoding upperCase()

Description copied from class: BaseEncoding

Returns an encoding that behaves equivalently to this encoding, but encodes and decodes with uppercase letters. Padding and separator characters remain in their original case.

Specified by:

upperCase in class BaseEncoding

lowerCase

public BaseEncoding lowerCase()

Description copied from class: BaseEncoding

Returns an encoding that behaves equivalently to this encoding, but encodes and decodes with lowercase letters. Padding and separator characters remain in their original case.

Specified by:

lowerCase in class BaseEncoding

newInstance

BaseEncoding newInstance(BaseEncoding.Alphabet alphabet,
                         java.lang.Character paddingChar)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object