Base64Encoder.Builder

java.lang.Object

org.cryptacular.codec.Base64Encoder.Builder

Enclosing class:: Base64Encoder

public static class Base64Encoder.Builder extends Object

Builder for base-64 encoders.

Field Summary

Fields

Modifier and Type

Field

Description

private String

alphabet

Arbitrary alphbet.

private int

charactersPerLine

Number of base-64 characters per line in output.

private boolean

padding

Padding flag.

private boolean

urlSafe

URL-safe alphabet flag.
Constructor Summary

Constructors

Constructor

Description

Builder()
Method Summary

Modifier and Type

Method

Description

Base64Encoder

build()

Builds a base-64 encoder with the given options.

Base64Encoder.Builder

setAlphabet(String alpha)

Sets an arbitrary 64-character alphabet for encoding.

Base64Encoder.Builder

setCharactersPerLine(int lineLength)

Sets the number of characters per line in output produced by the encoder.

Base64Encoder.Builder

setPadding(boolean pad)

Sets padding flag on the encoder.

Base64Encoder.Builder

setUrlSafe(boolean safe)

Sets the URL-safe alphabet flag.

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

Field Details
- urlSafe
  
  private boolean urlSafe
  
  URL-safe alphabet flag.
- alphabet
  
  private String alphabet
  
  Arbitrary alphbet.
- padding
  
  private boolean padding
  
  Padding flag.
- charactersPerLine
  
  private int charactersPerLine
  
  Number of base-64 characters per line in output.
Constructor Details
- Builder
  
  public Builder()
Method Details
- setUrlSafe
  
  public Base64Encoder.Builder setUrlSafe(boolean safe)
  
  Sets the URL-safe alphabet flag.
  
  Parameters:
  
  safe - True for URL-safe alphabet, false otherwise.
  
  Returns:
  
  This instance.
- setAlphabet
  
  public Base64Encoder.Builder setAlphabet(String alpha)
  
  Sets an arbitrary 64-character alphabet for encoding.
  
  Parameters:
  
  alpha - Alternative alphabet.
  
  Returns:
  
  This instance.
- setPadding
  
  public Base64Encoder.Builder setPadding(boolean pad)
  
  Sets padding flag on the encoder.
  
  Parameters:
  
  pad - True for base-64 padding, false otherwise.
  
  Returns:
  
  This instance.
- setCharactersPerLine
  
  public Base64Encoder.Builder setCharactersPerLine(int lineLength)
  
  Sets the number of characters per line in output produced by the encoder.
  
  Parameters:
  
  lineLength - Number of characters per line. Set to -1 to suppress line breaks.
  
  Returns:
  
  This instance.
- build
  
  public Base64Encoder build()
  
  Builds a base-64 encoder with the given options.
  
  Returns:
  
  New base-64 encoder instance.