Package com.petrolpark.contamination

Class Contamination<OBJECT,OBJECT_STACK>

java.lang.Object

com.petrolpark.contamination.Contamination<OBJECT,OBJECT_STACK>

All Implemented Interfaces:

IContamination<OBJECT,OBJECT_STACK>

Direct Known Subclasses:

FluidContamination, GenericContamination, ItemContamination

public abstract class Contamination<OBJECT,OBJECT_STACK>
extends Object
implements IContamination<OBJECT,OBJECT_STACK>

Field Summary

Fields

Modifier and Type	Field	Description
protected final Set<Contaminant>	contaminants	All extrinsic Contaminants, whether added themselves or by parental proxy.
protected final SortedSet<Contaminant>	orphanContaminants	Extrinsic Contaminants that do not have a parent (if one exists) in this Contamination.
protected final OBJECT_STACK	stack

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Contamination(OBJECT_STACK stack)

Method Summary

Modifier and Type	Method	Description
final boolean	contaminate(Contaminant contaminant)
final boolean	contaminateAll(Stream<Contaminant> contaminantsStream)	Add several Contaminants, and
final boolean	decontaminate(Contaminant contaminant)	Remove a Contaminant and any children it has that don't belong to another parent.
final boolean	decontaminateOnly(Contaminant contaminant)	Remove a Contaminant, but not any of its children.
final boolean	fullyDecontaminate()	Remove all extrinsic Contaminants.
final boolean	has(Contaminant contaminant)
final boolean	hasAnyContaminant()
final boolean	hasAnyExtrinsicContaminant()
void	readNBT(net.minecraft.nbt.ListTag contaminationTag)
final Stream<Contaminant>	streamAllContaminants()
final Stream<Contaminant>	streamOrphanExtrinsicContaminants()	Stream all Contaminants in this Contamination that: Are not intrinsic Have no children in this Contamination Note that this is the minimum set of Contaminants needed to uniquely define a Contamination.
net.minecraft.nbt.ListTag	writeNBT()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.petrolpark.contamination.IContamination

getAmount, getContaminable, getType, save, streamShownAbsentContaminants, streamShownContaminants

Field Details

stack

protected final OBJECT_STACK stack

orphanContaminants

protected final SortedSet<Contaminant> orphanContaminants

Extrinsic Contaminants that do not have a parent (if one exists) in this Contamination.

contaminants

protected final Set<Contaminant> contaminants

All extrinsic Contaminants, whether added themselves or by parental proxy.

Constructor Details

Contamination

protected Contamination(OBJECT_STACK stack)

Method Details

has

public final boolean has(Contaminant contaminant)

Specified by:

has in interface IContamination<OBJECT,OBJECT_STACK>

hasAnyContaminant

public final boolean hasAnyContaminant()

Specified by:

hasAnyContaminant in interface IContamination<OBJECT,OBJECT_STACK>

hasAnyExtrinsicContaminant

public final boolean hasAnyExtrinsicContaminant()

Specified by:

hasAnyExtrinsicContaminant in interface IContamination<OBJECT,OBJECT_STACK>

streamAllContaminants

public final Stream<Contaminant> streamAllContaminants()

Specified by:

streamAllContaminants in interface IContamination<OBJECT,OBJECT_STACK>

streamOrphanExtrinsicContaminants

public final Stream<Contaminant> streamOrphanExtrinsicContaminants()

Description copied from interface: IContamination

Stream all Contaminants in this Contamination that:

• Are not intrinsic
• Have no children in this Contamination

Note that this is the minimum set of Contaminants needed to uniquely define a Contamination.

Specified by:

streamOrphanExtrinsicContaminants in interface IContamination<OBJECT,OBJECT_STACK>

Returns:

Distinct Stream of Contaminants

contaminate

public final boolean contaminate(Contaminant contaminant)

Specified by:

contaminate in interface IContamination<OBJECT,OBJECT_STACK>

contaminateAll

public final boolean contaminateAll(Stream<Contaminant> contaminantsStream)

Description copied from interface: IContamination

Add several Contaminants, and

Specified by:

contaminateAll in interface IContamination<OBJECT,OBJECT_STACK>

Returns:

decontaminate

public final boolean decontaminate(Contaminant contaminant)

Description copied from interface: IContamination

Remove a Contaminant and any children it has that don't belong to another parent. If the Contaminant has any parents in this Contamination, it will not be removed.

Specified by:

decontaminate in interface IContamination<OBJECT,OBJECT_STACK>

Returns:

Whether this Contamination changed

See Also:

• Don't remove children

decontaminateOnly

public final boolean decontaminateOnly(Contaminant contaminant)

Description copied from interface: IContamination

Remove a Contaminant, but not any of its children. If the Contaminant has any parents in this Contamination, it will not be removed.

Specified by:

decontaminateOnly in interface IContamination<OBJECT,OBJECT_STACK>

Returns:

Whether this Contamination changed (the Contaminant was removed)

See Also:

• Remove all children

fullyDecontaminate

public final boolean fullyDecontaminate()

Description copied from interface: IContamination

Remove all extrinsic Contaminants.

Specified by:

fullyDecontaminate in interface IContamination<OBJECT,OBJECT_STACK>

Returns:

Whether this Contamination changed (whether it had any extrinsic Contaminants)

readNBT

public void readNBT(net.minecraft.nbt.ListTag contaminationTag)

writeNBT

public net.minecraft.nbt.ListTag writeNBT()