Package org.bitcoinj.base

Enum SegwitAddress.SegwitHrp

java.lang.Object

java.lang.Enum<SegwitAddress.SegwitHrp>

org.bitcoinj.base.SegwitAddress.SegwitHrp

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SegwitAddress.SegwitHrp>

Enclosing class:

SegwitAddress

public static enum SegwitAddress.SegwitHrp
extends java.lang.Enum<SegwitAddress.SegwitHrp>

Human-readable part (HRP) of Segwit addresses for standard Bitcoin networks.

See BIP 173 definition of bc and tb HRPs and Bitcoin Core Issue 1234 - discussion of bcrt HRP for details.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BC
BCRT
TB

Method Summary

Modifier and Type	Method	Description
static java.util.Optional<SegwitAddress.SegwitHrp>	find(java.lang.String hrp)
static SegwitAddress.SegwitHrp	of(java.lang.String hrp)
static SegwitAddress.SegwitHrp	ofNetwork(BitcoinNetwork network)
java.lang.String	toString()	Get the HRP in lowercase.
static SegwitAddress.SegwitHrp	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static SegwitAddress.SegwitHrp[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BC

public static final SegwitAddress.SegwitHrp BC

TB

public static final SegwitAddress.SegwitHrp TB

BCRT

public static final SegwitAddress.SegwitHrp BCRT

Method Detail

values

public static SegwitAddress.SegwitHrp[] 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 (SegwitAddress.SegwitHrp c : SegwitAddress.SegwitHrp.values())
    System.out.println(c);

Returns:

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

valueOf

public static SegwitAddress.SegwitHrp 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

toString

public java.lang.String toString()

Get the HRP in lowercase. To get uppercase, use Enum.name()

Overrides:

toString in class java.lang.Enum<SegwitAddress.SegwitHrp>

Returns:

HRP in lowercase.

of

public static SegwitAddress.SegwitHrp of(java.lang.String hrp)

Parameters:

hrp - uppercase or lowercase HRP

Returns:

the corresponding enum

Throws:

java.lang.IllegalArgumentException - if unknown string

find

public static java.util.Optional<SegwitAddress.SegwitHrp> find(java.lang.String hrp)

Parameters:

hrp - uppercase or lowercase HRP

Returns:

Optional containing the corresponding enum or empty if not found

ofNetwork

public static SegwitAddress.SegwitHrp ofNetwork(BitcoinNetwork network)

Parameters:

network - network enum

Returns:

the corresponding enum