rescuecore2.standard.kernel.comms

Class ChainedNoise

java.lang.Object

rescuecore2.standard.kernel.comms.ChainedNoise

All Implemented Interfaces:

Noise

public class ChainedNoise
extends java.lang.Object
implements Noise

A Noise implementation that chains Noise objects together.

Constructor Summary

Constructors

Constructor and Description
ChainedNoise() Create a ChainedNoise object with no children.
ChainedNoise(java.util.Collection<Noise> chain) Create a ChainedNoise object with a set of children.

Method Summary

Modifier and Type	Method and Description
void	addChild(Noise child) Add a child.
AKSpeak	applyNoise(AKSpeak message) Optionally apply some noise to a message and return either the original message or a replacement.
void	removeChild(Noise child) Remove a child.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChainedNoise

public ChainedNoise()

Create a ChainedNoise object with no children.

ChainedNoise

public ChainedNoise(java.util.Collection<Noise> chain)

Create a ChainedNoise object with a set of children.

Parameters:

chain - The child noise objects.

Method Detail

applyNoise

public AKSpeak applyNoise(AKSpeak message)

Description copied from interface: Noise

Optionally apply some noise to a message and return either the original message or a replacement.

Specified by:

applyNoise in interface Noise

Parameters:

message - The message to tinker with.

Returns:

The original message or a replacement.

addChild

public void addChild(Noise child)

Add a child.

Parameters:

child - The child to add. This may be null.

removeChild

public void removeChild(Noise child)

Remove a child.

Parameters:

child - The child to remove.