Package com.google.common.io

Class BaseEncoding.SeparatedBaseEncoding

java.lang.Object

com.google.common.io.BaseEncoding

com.google.common.io.BaseEncoding.SeparatedBaseEncoding

Enclosing class:

BaseEncoding

static final class BaseEncoding.SeparatedBaseEncoding
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
private int	afterEveryChars
private BaseEncoding	delegate
private java.lang.String	separator

Constructor Summary

Constructors

Constructor	Description
SeparatedBaseEncoding(BaseEncoding delegate, java.lang.String separator, int afterEveryChars)

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	encodeTo(java.lang.Appendable target, byte[] bytes, int off, int len)
java.io.OutputStream	encodingStream(java.io.Writer output)	Returns an OutputStream that encodes bytes using this encoding into the specified Writer.
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)
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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

delegate

private final BaseEncoding delegate

separator

private final java.lang.String separator

afterEveryChars

private final int afterEveryChars

Constructor Detail

SeparatedBaseEncoding

SeparatedBaseEncoding(BaseEncoding delegate,
                      java.lang.String separator,
                      int afterEveryChars)

Method Detail

trimTrailingPadding

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

Overrides:

trimTrailingPadding in class BaseEncoding

maxEncodedSize

int maxEncodedSize(int bytes)

Specified by:

maxEncodedSize in class BaseEncoding

encodingStream

public java.io.OutputStream encodingStream(java.io.Writer output)

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

maxDecodedSize

int maxDecodedSize(int chars)

Specified by:

maxDecodedSize 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

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object