org.iota.jota.utils

Class Checksum

java.lang.Object

org.iota.jota.utils.Checksum

public class Checksum
extends Object

This class defines utility methods to add/remove the checksum to/from an address.

Constructor Summary

Constructors

Constructor and Description
Checksum()

Method Summary

Modifier and Type	Method and Description
static String	addChecksum(String address) Adds the checksum to the specified address.
static boolean	isAddressWithChecksum(String address) Check if specified address is an address with checksum.
static boolean	isAddressWithoutChecksum(String address) Check if specified address is an address without checksum.
static boolean	isValidChecksum(String addressWithChecksum) Determines whether the specified address with checksum has a valid checksum.
static String	removeChecksum(String address) Remove the checksum to the specified address.

Methods inherited from class java.lang.Object

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

Constructor Detail

Checksum

public Checksum()

Method Detail

addChecksum

public static String addChecksum(String address)
                          throws ArgumentException

Adds the checksum to the specified address.

Parameters:

address - The address without checksum.

Returns:

The address with the appended checksum.

Throws:

ArgumentException - is thrown when the specified address is not a valid address, or already has a checksum.

removeChecksum

public static String removeChecksum(String address)
                             throws ArgumentException

Remove the checksum to the specified address.

Parameters:

address - The address with checksum.

Returns:

The address without checksum.

Throws:

ArgumentException - is thrown when the specified address is not an address with checksum.

isValidChecksum

public static boolean isValidChecksum(String addressWithChecksum)
                               throws ArgumentException

Determines whether the specified address with checksum has a valid checksum.

Parameters:

addressWithChecksum - The address with checksum.

Returns:

true if the specified address with checksum has a valid checksum [the specified address with checksum]; otherwise, false.

Throws:

ArgumentException - is thrown when the specified address is not an valid address.

isAddressWithChecksum

public static boolean isAddressWithChecksum(String address)
                                     throws ArgumentException

Check if specified address is an address with checksum.

Parameters:

address - The address to check.

Returns:

true if the specified address is with checksum ; otherwise, false.

Throws:

ArgumentException - is thrown when the specified address is not an valid address.

isAddressWithoutChecksum

public static boolean isAddressWithoutChecksum(String address)
                                        throws ArgumentException

Check if specified address is an address without checksum.

Parameters:

address - The address to check.

Returns:

true if the specified address is without checksum ; otherwise, false.

Throws:

ArgumentException - is thrown when the specified address is not an valid address.