java.lang.Object
- io.github.mmm.binary.codec.BaseFormat

```
public class BaseFormat
extends Object
```
Format for Base.

Since:

1.0.0

See Also:

Base.withFormat(BaseFormat)

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`BaseFormat(String newline, int charsPerLine, boolean failOnWhitespace, Boolean padding)`	The constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getCharsPerLine()`
`String`	`getNewline()`
`boolean`	`isFailOnMissingPadding()`
`boolean`	`isFailOnWhitespace()`
`boolean`	`isOmitPadding()`
`static BaseFormat`	`ofDefault()`
`static BaseFormat`	`ofMime()`
`static BaseFormat`	`ofNewline(String newline, int charsPerLine)`
`static BaseFormat`	`ofStrict()`

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

- Constructor Detail
  - BaseFormat
```
protected BaseFormat(String newline,
                     int charsPerLine,
                     boolean failOnWhitespace,
                     Boolean padding)
```
    The constructor.
    
    Parameters:
    
    newline - - see getNewline().
    
    charsPerLine - - see getCharsPerLine().
    
    failOnWhitespace - - see isFailOnMissingPadding()
    
    padding - - see isFailOnMissingPadding() and isOmitPadding().
- Method Detail
  - getNewline
```
public String getNewline()
```
    Returns:
    
    newline the newline sequence (e.g. "\r\n") or null for none (encoded String is a single line).
  - getCharsPerLine
```
public int getCharsPerLine()
```
    Returns:
    
    the number of characters until another newline will be appended. Will be 0 if newline is null.
  - isFailOnWhitespace
```
public boolean isFailOnWhitespace()
```
    Returns:
    
    true to fail on whitespace (' ', '\r', or '\n'), false to silently ignore whitespaces.
  - isFailOnMissingPadding
```
public boolean isFailOnMissingPadding()
```
    Returns:
    
    true to fail if padding (e.g. on Base64) is omitted where applicable, false to silently ignore missing padding.
  - isOmitPadding
```
public boolean isOmitPadding()
```
    Returns:
    
    true if padding should be omitted, false otherwise (add padding where applicable).
  - ofDefault
```
public static BaseFormat ofDefault()
```
    Returns:
    
    the default BaseFormat (tolerant, no newline on encoding).
  - ofMime
```
public static BaseFormat ofMime()
```
    Returns:
    
    instance of BaseFormat with MIME compatible newline settings for encoding.
  - ofStrict
```
public static BaseFormat ofStrict()
```
    Returns:
    
    instance of BaseFormat with strict decoding and without newlines on encoding.
  - ofNewline
```
public static BaseFormat ofNewline(String newline,
                                   int charsPerLine)
```
    Parameters:
    
    newline - the newline sequence (e.g. "\n", "\r\n").
    
    charsPerLine - the number of characters per line until a newline is appended.
    
    Returns:
    
    instance of BaseFormat for the given arguments.

Class BaseFormat

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseFormat

Method Detail

getNewline

getCharsPerLine

isFailOnWhitespace

isFailOnMissingPadding

isOmitPadding

ofDefault

ofMime

ofStrict

ofNewline