io.nem.symbol.sdk.model.account

Class Address

java.lang.Object

io.nem.symbol.sdk.model.account.Address

All Implemented Interfaces:

UnresolvedAddress

public class Address
extends java.lang.Object
implements UnresolvedAddress

The address structure describes an address with its network.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
Address(java.lang.String prettyOrRaw, NetworkType networkType) Constructor

Method Summary

Modifier and Type	Method and Description
static Address	createFromEncoded(java.lang.String encodedAddress) Create an Address from a given encoded address.
static Address	createFromPublicKey(java.lang.String publicKey, NetworkType networkType) Creates an address based on the public key and the network type.
static Address	createFromRawAddress(java.lang.String rawAddress) Create an Address from a given raw address.
java.lang.String	encoded() Returns the encoded address.
java.lang.String	encoded(NetworkType networkType) Returns the encoded address.
boolean	equals(java.lang.Object o) Compares addresses for equality.
static Address	generateRandom(NetworkType networkType) Generates a random address for the given network type.
NetworkType	getNetworkType() Returns network type.
int	hashCode()
static boolean	isValidEncodedAddress(java.lang.String encodedAddress) Determines the validity of an encoded address string.
static boolean	isValidPlainAddress(java.lang.String plainAddress) Determines the validity of a plainAddress address.
java.lang.String	plain() Get address in plain format ex: SB3KUBHATFCPV7UZQLWAQ2EUR6SIHBSBEOEDDDF3.
java.lang.String	pretty() Get address in pretty format ex: SB3KUB-HATFCP-V7UZQL-WAQ2EU-R6SIHB-SBEOED-DDF3.
static java.util.Optional<java.lang.String>	validateEncodedAddress(java.lang.String encodedAddress) Checks if an encoded address is valid returning the problem message if it's not valid.
static java.util.Optional<java.lang.String>	validatePlainAddress(java.lang.String plainAddress) Checks if a plain address is valid returning the problem message if it's not valid.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Address

public Address(java.lang.String prettyOrRaw,
               NetworkType networkType)

Constructor

Parameters:

prettyOrRaw - The address in pretty or raw.

networkType - Network type

Method Detail

createFromRawAddress

public static Address createFromRawAddress(java.lang.String rawAddress)

Create an Address from a given raw address.

Parameters:

rawAddress - String

Returns:

Address

createFromEncoded

public static Address createFromEncoded(java.lang.String encodedAddress)

Create an Address from a given encoded address.

Parameters:

encodedAddress - String

Returns:

Address

createFromPublicKey

public static Address createFromPublicKey(java.lang.String publicKey,
                                          NetworkType networkType)

Creates an address based on the public key and the network type. The sign schema will be resolved based on the

Parameters:

publicKey - String

networkType - the NetworkType

Returns:

Address

See Also:

RawAddress

isValidPlainAddress

public static boolean isValidPlainAddress(java.lang.String plainAddress)

Determines the validity of a plainAddress address.

Parameters:

plainAddress - Decoded address.

Returns:

true if the plainAddress address is valid, false otherwise.

isValidEncodedAddress

public static boolean isValidEncodedAddress(java.lang.String encodedAddress)

Determines the validity of an encoded address string.

Parameters:

encodedAddress - encoded Encoded address string.

Returns:

true if the encoded address string is valid, false otherwise.

validateEncodedAddress

public static java.util.Optional<java.lang.String> validateEncodedAddress(java.lang.String encodedAddress)

Checks if an encoded address is valid returning the problem message if it's not valid.

Parameters:

encodedAddress - the encoded hex address.

Returns:

the error message or emtpy if the address is valid.

validatePlainAddress

public static java.util.Optional<java.lang.String> validatePlainAddress(java.lang.String plainAddress)

Checks if a plain address is valid returning the problem message if it's not valid.

Parameters:

plainAddress - the address to be checked.

Returns:

the error message or emtpy if the address is valid.

generateRandom

public static Address generateRandom(NetworkType networkType)

Generates a random address for the given network type.

Parameters:

networkType - the network type

Returns:

an random address.

plain

public java.lang.String plain()

Get address in plain format ex: SB3KUBHATFCPV7UZQLWAQ2EUR6SIHBSBEOEDDDF3.

Specified by:

plain in interface UnresolvedAddress

Returns:

String

getNetworkType

public NetworkType getNetworkType()

Returns network type.

Returns:

NetworkType

encoded

public java.lang.String encoded(NetworkType networkType)

Returns the encoded address.

Specified by:

encoded in interface UnresolvedAddress

Parameters:

networkType - the network type.

Returns:

the encoded plain address.

encoded

public java.lang.String encoded()

Returns the encoded address.

Returns:

the encoded plain address.

pretty

public java.lang.String pretty()

Get address in pretty format ex: SB3KUB-HATFCP-V7UZQL-WAQ2EU-R6SIHB-SBEOED-DDF3.

Returns:

String

equals

public boolean equals(java.lang.Object o)

Compares addresses for equality.

Overrides:

equals in class java.lang.Object

Returns:

boolean

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object