com.radixdlt.client.core.atoms

Class ParticleGroup

java.lang.Object

org.radix.serialization2.client.SerializableObject

com.radixdlt.client.core.atoms.ParticleGroup

@SerializerId2(value="radix.particle_group")
public class ParticleGroup
extends SerializableObject

A group of particles representing one intent, e.g. a transfer.

* @author flotothemoon

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParticleGroup.ParticleGroupBuilder A builder for immutable ParticleGroups

Constructor Summary

Constructors

Constructor and Description
ParticleGroup(java.lang.Iterable<SpunParticle> particles)
ParticleGroup(java.lang.Iterable<SpunParticle> particles, java.util.Map<java.lang.String,java.lang.String> metaData)

Method Summary

Modifier and Type	Method and Description
static ParticleGroup.ParticleGroupBuilder	builder() Get a build for a single ParticleGroup
java.util.Map<java.lang.String,java.lang.String>	getMetaData() Get the metadata associated with the particle group
com.google.common.collect.ImmutableList<SpunParticle>	getSpunParticles()
boolean	hasParticles() Whether this ParticleGroup contains any particles
static ParticleGroup	of(java.lang.Iterable<SpunParticle> particles) Get a ParticleGroup consisting of the given particles
static ParticleGroup	of(java.lang.Iterable<SpunParticle> particles, java.util.Map<java.lang.String,java.lang.String> metaData) Get a ParticleGroup consisting of the given particles
static ParticleGroup	of(SpunParticle<?>... particles) Get a ParticleGroup consisting of the given particles
java.util.stream.Stream<Particle>	particles(Spin spin) Get a stream of particles of a certain spin in this group
java.util.stream.Stream<SpunParticle>	spunParticles() Get a stream of the spun particles in this group
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParticleGroup

public ParticleGroup(java.lang.Iterable<SpunParticle> particles)

ParticleGroup

public ParticleGroup(java.lang.Iterable<SpunParticle> particles,
                     java.util.Map<java.lang.String,java.lang.String> metaData)

Method Detail

getSpunParticles

public com.google.common.collect.ImmutableList<SpunParticle> getSpunParticles()

spunParticles

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

Get a stream of the spun particles in this group

particles

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

Get a stream of particles of a certain spin in this group

Parameters:

spin - The spin to filter by

Returns:

The particles in this group with that spin

getMetaData

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

Get the metadata associated with the particle group

Returns:

an immutable map of the metadata

of

public static ParticleGroup of(java.lang.Iterable<SpunParticle> particles)

Get a ParticleGroup consisting of the given particles

of

public static ParticleGroup of(java.lang.Iterable<SpunParticle> particles,
                               java.util.Map<java.lang.String,java.lang.String> metaData)

Get a ParticleGroup consisting of the given particles

of

public static ParticleGroup of(SpunParticle<?>... particles)

Get a ParticleGroup consisting of the given particles

hasParticles

public boolean hasParticles()

Whether this ParticleGroup contains any particles

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static ParticleGroup.ParticleGroupBuilder builder()

Get a build for a single ParticleGroup

Returns:

The ParticleGroup.ParticleGroupBuilder