Module uk.oczadly.karl.jnano

Package uk.oczadly.karl.jnano.model.block

Class Block

java.lang.Object

uk.oczadly.karl.jnano.model.block.Block

All Implemented Interfaces:

IBlock

Direct Known Subclasses:

ChangeBlock, OpenBlock, ReceiveBlock, SendBlock, StateBlock

public abstract class Block
extends Object
implements IBlock

An abstract class which represents a Nano block.

For a concrete version of this class, use StateBlock (or SendBlock, ReceiveBlock, ChangeBlock and OpenBlock for legacy types).

To convert a JSON string/object to a Block instance, use the parse(JsonObject) static method or the BlockDeserializer class. This class can automatically be serialized and deserialized by Gson, as a built-in JSON adapter is provided and automatically registered.

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	HASH_LENGTH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Block(String type)
protected	Block(String type, String hash, String signature, WorkSolution workSolution)
protected	Block(BlockType type)
protected	Block(BlockType type, String hash, String signature, WorkSolution workSolution)

Method Summary

Modifier and Type	Method	Description
protected com.google.gson.JsonObject	buildJsonObject()	Build a JsonObject that represents this instance.
protected byte[]	calculateHashBytes()
boolean	equals(Object o)
protected void	fillJsonBlanks(com.google.gson.JsonObject json)	Fill blank or missing parameters with JsonObject.addProperty(String, String).
protected abstract byte[][]	generateHashables()
String	getHash()	Returns the block hash, or attempts to calculate it if the hash value was not present.
byte[]	getHashBytes()
com.google.gson.JsonObject	getJsonObject()
com.google.gson.JsonObject	getJsonObject(boolean fillBlanks)
String	getSignature()
BlockType	getType()
String	getTypeString()
WorkSolution	getWorkSolution()
int	hashCode()
boolean	isComplete()	Returns whether or not this object contains all the necessary fields to be a block.
static Block	parse(com.google.gson.JsonObject json)	Parses a block from a given JsonObject instance.
static Block	parse(String json)	Parses a block from a given JSON string.
String	toJsonString()
String	toJsonString(boolean fillBlanks)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

HASH_LENGTH

protected static final int HASH_LENGTH

See Also:

Constant Field Values

Constructor Detail

Block

protected Block(String type)

Parameters:

type - the block type, as a string

Block

protected Block(BlockType type)

Parameters:

type - the block type

Block

protected Block(String type,
                String hash,
                String signature,
                WorkSolution workSolution)

Parameters:

type - the block type, as a string

hash - the block hash, or null (for performance improvements only)

signature - the block signature

workSolution - the work solution

Block

protected Block(BlockType type,
                String hash,
                String signature,
                WorkSolution workSolution)

Parameters:

type - the block type

hash - the block hash, or null (for performance improvements only)

signature - the block signature

workSolution - the work solution

Method Detail

getHash

public final String getHash()

Returns the block hash, or attempts to calculate it if the hash value was not present.

Specified by:

getHash in interface IBlock

Returns:

the block hash

getHashBytes

public final byte[] getHashBytes()

Returns:

a 32-length array of bytes, representing the hash of this block

getType

public final BlockType getType()

Specified by:

getType in interface IBlock

Returns:

the block type (may be null)

getTypeString

public final String getTypeString()

Specified by:

getTypeString in interface IBlock

Returns:

the block type, as a string

getSignature

public final String getSignature()

Specified by:

getSignature in interface IBlock

Returns:

the signature which verifies and authorizes this block (may be null)

getWorkSolution

public final WorkSolution getWorkSolution()

Specified by:

getWorkSolution in interface IBlock

Returns:

the work solution (may be null)

isComplete

public boolean isComplete()

Returns whether or not this object contains all the necessary fields to be a block. This includes having a non-null work value and signature.

Returns:

true if this block contains all mandatory fields

generateHashables

protected abstract byte[][] generateHashables()

Returns:

an array of hashable byte arrays in the correct sequence, or null if not supported

calculateHashBytes

protected final byte[] calculateHashBytes()

toJsonString

public final String toJsonString()

Returns:

a JSON representation of this block

toJsonString

public final String toJsonString(boolean fillBlanks)

Parameters:

fillBlanks - if true, null properties will be filled with dummy data

Returns:

a JSON representation of this block

getJsonObject

public final com.google.gson.JsonObject getJsonObject()

Returns:

a JSON representation of this block, as a Gson JsonObject

getJsonObject

public final com.google.gson.JsonObject getJsonObject(boolean fillBlanks)

Parameters:

fillBlanks - if true, null properties will be filled with dummy data

Returns:

a JSON representation of this block, as a Gson JsonObject

fillJsonBlanks

protected void fillJsonBlanks(com.google.gson.JsonObject json)

Fill blank or missing parameters with JsonObject.addProperty(String, String).

Parameters:

json - the JSON object to fill

buildJsonObject

protected com.google.gson.JsonObject buildJsonObject()

Build a JsonObject that represents this instance.

Returns:

the JsonObject representing this block

toString

public final String toString()

Overrides:

toString in class Object

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

parse

public static Block parse(String json)

Parses a block from a given JSON string.

Parameters:

json - the json to parse from

Returns:

a block object derived from the provided JSON

See Also:

BlockDeserializer

parse

public static Block parse(com.google.gson.JsonObject json)

Parses a block from a given JsonObject instance.

Parameters:

json - the json to parse from

Returns:

a block object derived from the provided JSON

See Also:

BlockDeserializer