io.nem.symbol.sdk.model.namespace

Class NamespaceId

java.lang.Object

io.nem.symbol.sdk.model.namespace.NamespaceId

All Implemented Interfaces:

UnresolvedAddress, UnresolvedMosaicId

public class NamespaceId
extends java.lang.Object
implements UnresolvedMosaicId, UnresolvedAddress

The namespace id structure describes namespace id

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
NamespaceId(java.lang.String hex) Create NamespaceId from namespace Hex string

Method Summary

Modifier and Type	Method and Description
static NamespaceId	createFromId(java.math.BigInteger id) Create NamespaceId from BigInteger id
static NamespaceId	createFromIdAndFullName(java.math.BigInteger id, java.lang.String fullName) Creates a NamespaceId when the id and the full name is known.
static NamespaceId	createFromName(java.lang.String namespaceName) Create NamespaceId from namespace string name (ex: nem or domain.subdom.subdome)
static NamespaceId	createFromNameAndParentId(java.lang.String namespaceName, java.math.BigInteger parentId) Create NamespaceId from namespace string name (ex: nem or domain.subdom.subdome) and parent id
static NamespaceId	createFromNameAndParentName(java.lang.String namespaceName, java.lang.String parentNamespaceName) Create NamespaceId from namespace string name (ex: nem or domain.subdom.subdome) and parent namespace name
java.lang.String	encoded(NetworkType networkType)
boolean	equals(java.lang.Object o)
java.util.Optional<java.lang.String>	getFullName() Returns optional namespace full name, with subnamespaces if it's the case.
java.math.BigInteger	getId() Returns namespace BigInteger id
java.lang.String	getIdAsHex() Gets the id as a hexadecimal string.
long	getIdAsLong() Returns namespace id as a long
static java.util.List<java.math.BigInteger>	getNamespacePath(java.lang.String namespaceName) Returns a list of BigInteger ids for a namespace path (ex: nem or domain.subdom.subdome)
int	hashCode()
java.lang.String	plain()

Methods inherited from class java.lang.Object

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

Constructor Detail

NamespaceId

public NamespaceId(java.lang.String hex)

Create NamespaceId from namespace Hex string

Parameters:

hex - the hex value.

Throws:

IllegalIdentifierException - NamespaceId identifier

Method Detail

createFromName

public static NamespaceId createFromName(java.lang.String namespaceName)

Create NamespaceId from namespace string name (ex: nem or domain.subdom.subdome)

Parameters:

namespaceName - the namespace name.

Returns:

the new NamespaceId

createFromIdAndFullName

public static NamespaceId createFromIdAndFullName(java.math.BigInteger id,
                                                  java.lang.String fullName)

Creates a NamespaceId when the id and the full name is known.

Parameters:

id - the id.

fullName - the full name that includes the parent namespaces (ex: nem or domain.subdom.subdome)

Returns:

the new NamespaceId

createFromNameAndParentId

public static NamespaceId createFromNameAndParentId(java.lang.String namespaceName,
                                                    java.math.BigInteger parentId)

Create NamespaceId from namespace string name (ex: nem or domain.subdom.subdome) and parent id

Parameters:

namespaceName - the namespace name.

parentId - the parent id.

Returns:

the new NamespaceId

createFromNameAndParentName

public static NamespaceId createFromNameAndParentName(java.lang.String namespaceName,
                                                      java.lang.String parentNamespaceName)

Create NamespaceId from namespace string name (ex: nem or domain.subdom.subdome) and parent namespace name

Parameters:

namespaceName - the namespace name.

parentNamespaceName - the parent's namespace name.

Returns:

the new NamespaceId

createFromId

public static NamespaceId createFromId(java.math.BigInteger id)

Create NamespaceId from BigInteger id

Parameters:

id - the namespace id as BigInteger.

Returns:

the new NamespaceId

getNamespacePath

public static java.util.List<java.math.BigInteger> getNamespacePath(java.lang.String namespaceName)

Returns a list of BigInteger ids for a namespace path (ex: nem or domain.subdom.subdome)

Parameters:

namespaceName - the namespace name.

Returns:

the paths

getId

public java.math.BigInteger getId()

Returns namespace BigInteger id

Specified by:

getId in interface UnresolvedMosaicId

Returns:

namespace BigInteger id

getIdAsLong

public long getIdAsLong()

Returns namespace id as a long

Specified by:

getIdAsLong in interface UnresolvedMosaicId

Returns:

id long

getFullName

public java.util.Optional<java.lang.String> getFullName()

Returns optional namespace full name, with subnamespaces if it's the case.

Returns:

namespace full name

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

encoded

public java.lang.String encoded(NetworkType networkType)

Specified by:

encoded in interface UnresolvedAddress

Parameters:

networkType - the network type.

Returns:

the encoded address or namespace id. Note that namespace id get the hex reversed and zero padded. See SerializationUtils

plain

public java.lang.String plain()

Specified by:

plain in interface UnresolvedAddress

Returns:

the plain representation of the address.

getIdAsHex

public java.lang.String getIdAsHex()

Gets the id as a hexadecimal string.

Specified by:

getIdAsHex in interface UnresolvedMosaicId

Returns:

Hex id.