io.github.novacrypto.bip39.wordlists

Enum French

java.lang.Object

java.lang.Enum<French>

io.github.novacrypto.bip39.wordlists.French

All Implemented Interfaces:

WordList, java.io.Serializable, java.lang.Comparable<French>

public enum French
extends java.lang.Enum<French>
implements WordList

Source: https://github.com/bitcoin/bips/blob/master/bip-0039/french.txt

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
char	getSpace() Get the space character for this language.
java.lang.String	getWord(int index) Get a word in the word list.
static French	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static French[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final French INSTANCE

Method Detail

values

public static French[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (French c : French.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static French valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getWord

public java.lang.String getWord(int index)

Description copied from interface: WordList

Get a word in the word list.

Specified by:

getWord in interface WordList

Parameters:

index - Index of word in the word list [0..2047] inclusive.

Returns:

the word from the list.

getSpace

public char getSpace()

Description copied from interface: WordList

Get the space character for this language.

Specified by:

getSpace in interface WordList

Returns:

a whitespace character.