com.radixdlt.client.core.atoms

Class Atom

java.lang.Object

org.radix.serialization2.client.SerializableObject

com.radixdlt.client.core.atoms.Atom

@SerializerId2(value="radix.atom")
public final class Atom
extends SerializableObject

An atom is the fundamental atomic unit of storage on the ledger (similar to a block in a blockchain) and defines the actions that can be issued onto the ledger.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	METADATA_POW_NONCE_KEY
static java.lang.String	METADATA_TIMESTAMP_KEY

Constructor Summary

Constructors

Constructor and Description
Atom(java.util.List<ParticleGroup> particleGroups, long timestamp)
Atom(java.util.List<ParticleGroup> particleGroups, java.util.Map<java.lang.String,java.lang.String> metaData)
Atom(long timestamp)
Atom(ParticleGroup particleGroup, long timestamp)

Method Summary

Modifier and Type	Method and Description
java.util.stream.Stream<RadixAddress>	addresses()
boolean	equals(java.lang.Object o)
AID	getAid()
RadixHash	getHash()
java.util.Map<java.lang.String,java.lang.String>	getMetaData() Get the metadata associated with the atom
java.util.Set<java.lang.Long>	getRequiredFirstShard()
java.util.Optional<ECSignature>	getSignature(EUID uid)
java.util.Map<java.lang.String,ECSignature>	getSignatures()
long	getTimestamp() Convenience method to retrieve timestamp
int	hashCode()
boolean	hasTimestamp()
java.util.stream.Stream<ParticleGroup>	particleGroups()
java.util.stream.Stream<Particle>	particles(Spin spin)
java.util.stream.Stream<SpunParticle>	spunParticles()
byte[]	toDson()
java.lang.String	toString()
Atom	withSignature(ECSignature signature, EUID signatureId)

Methods inherited from class java.lang.Object

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

Field Detail

METADATA_TIMESTAMP_KEY

public static final java.lang.String METADATA_TIMESTAMP_KEY

See Also:

Constant Field Values

METADATA_POW_NONCE_KEY

public static final java.lang.String METADATA_POW_NONCE_KEY

See Also:

Constant Field Values

Constructor Detail

Atom

public Atom(long timestamp)

Atom

public Atom(ParticleGroup particleGroup,
            long timestamp)

Atom

public Atom(java.util.List<ParticleGroup> particleGroups,
            long timestamp)

Atom

public Atom(java.util.List<ParticleGroup> particleGroups,
            java.util.Map<java.lang.String,java.lang.String> metaData)

Method Detail

withSignature

public Atom withSignature(ECSignature signature,
                          EUID signatureId)

getRequiredFirstShard

public java.util.Set<java.lang.Long> getRequiredFirstShard()

particleGroups

public java.util.stream.Stream<ParticleGroup> particleGroups()

spunParticles

public java.util.stream.Stream<SpunParticle> spunParticles()

particles

public java.util.stream.Stream<Particle> particles(Spin spin)

addresses

public java.util.stream.Stream<RadixAddress> addresses()

hasTimestamp

public boolean hasTimestamp()

getTimestamp

public long getTimestamp()

Convenience method to retrieve timestamp

Returns:

The timestamp in milliseconds since epoch

getSignatures

public java.util.Map<java.lang.String,ECSignature> getSignatures()

getSignature

public java.util.Optional<ECSignature> getSignature(EUID uid)

toDson

public byte[] toDson()

getHash

public RadixHash getHash()

getAid

public AID getAid()

getMetaData

public java.util.Map<java.lang.String,java.lang.String> getMetaData()

Get the metadata associated with the atom

Returns:

an immutable map of the meta data

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object