BaseNCodec (uuid-creator 3.4.1 API)

java.lang.Object
- com.github.f4b6a3.uuid.codec.base.BaseNCodec

All Implemented Interfaces:

UuidCodec<String>

Direct Known Subclasses:

Base16Codec, Base32Codec, Base32CrockfordCodec, Base32HexCodec, Base64Codec, Base64UrlCodec
```
public abstract class BaseNCodec
extends Object
implements UuidCodec<String>
```
Abstract class that contains the basic functionality for base-n codecs of this package.

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`alphabet`
`protected BaseN`	`base`
`protected Function<String,UUID>`	`decoder`
`protected Function<UUID,String>`	`encoder`

Constructor Summary

Constructors
Modifier Constructor Description

protected BaseNCodec(BaseNAlphabet baseNAlphabet)

BaseNCodec(BaseN base, String alphabet)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`UUID`	`decode(String string)`
`String`	`encode(UUID uuid)`
`String`	`getAlphabet()`
`BaseN`	`getBase()`

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

Field Detail

base
```
protected final BaseN base
```

alphabet
```
protected final String alphabet
```

encoder

protected final Function<UUID,String> encoder

decoder

protected final Function<String,UUID> decoder

Constructor Detail
- BaseNCodec
```
protected BaseNCodec(BaseNAlphabet baseNAlphabet)
```
  Parameters:
  
  baseNAlphabet - a enumeration that represents a supported alphabet.
- BaseNCodec
```
public BaseNCodec(BaseN base,
                  String alphabet)
```
  Parameters:
  
  base - an enumeration that represents the base-n encoding
  
  alphabet - a string that contains the base-n alphabet

Method Detail

encode
```
public String encode(UUID uuid)
```
Specified by:

encode in interface UuidCodec<String>

decode
```
public UUID decode(String string)
```
Specified by:

decode in interface UuidCodec<String>

getBase
```
public BaseN getBase()
```

getAlphabet
```
public String getAlphabet()
```