Mutator

public abstract class Mutator extends Object

Known Direct Subclasses AbstractProcedureMutator<Info extends ProcedureInfo>, IfElseMutator, MathIsDivisibleByMutator, ProceduresIfReturnMutator AbstractProcedureMutator<Info extends ProcedureInfo> Base class for all procedure definition and procedure call mutators, providing a base implementation of the mutation state variables and related I/O.  IfElseMutator Mutator for the if/else if/else block.  MathIsDivisibleByMutator Implements math_is_divisibleby_mutator Mutator for the math_number_property block, which adds the DIVISOR input if the property is "is divisible by".  ProceduresIfReturnMutator This mutator supports the procedures_ifreturn block, configuring the presence of the return value input and the block's disabled state.

Known Indirect Subclasses ProcedureCallMutator, ProcedureDefinitionMutator ProcedureCallMutator This mutator supports procedure call blocks for user-defined procedures (procedures_callreturn and procedures_callnoreturn blocks).  ProcedureDefinitionMutator This mutator class supports procedure definition blocks for user-defined procedures (procedures_defreturn and procedures_defnoreturn blocks).

Interface for mutators, platform specific hooks into blocks that manage the <mutation> serialized state and any related block updates.

Mutators can be added to blocks by setting the "mutator" attribute in JSON block definition. With this, the block constructor will call applyMutator(String, Block).

See guide on extensions and mutators.

Nested Class Summary

interface

Mutator.Factory<T extends Mutator>

The factory class for this type of mutator.

Constant Summary

String

TAG_MUTATION

The tag name for the XML element when serializing and updating Mutators.

Field Summary

protected Block

mBlock

Protected Constructor Summary

Mutator(Factory factory) Mutators are required to be initialized with the factory used to create them.

Public Method Summary

final void	attachToBlock(Block block) This is called when a mutator is attached to a block.
final void	detachFromBlock() This is called when a mutator is detached from a block.
Block	getBlock()
final String	getMutatorId()
abstract void	serialize(XmlSerializer serializer) Serializes the Mutator's state to an XML <mutation> element.
abstract void	update(XmlPullParser parser) Updates the mutator state from the provided <mutation> XML.

Protected Method Summary

void	onAttached(Block block) Called immediately after the mutator is attached to the block.
void	onDetached(Block block) Called immediately after the mutator is detached from a block, usually as a result of destroying the block.

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Constants

public static final String TAG_MUTATION

The tag name for the XML element when serializing and updating Mutators.

Constant Value: "mutation"

Fields

protected Block mBlock

Protected Constructors

protected Mutator (Factory factory)

Mutators are required to be initialized with the factory used to create them.

Parameters

factory

Public Methods

public final void attachToBlock (Block block)

This is called when a mutator is attached to a block. Developers wishing to perform setup on the block should override onAttached(Block).

Parameters

block	The block this mutator is attached to.

public final void detachFromBlock ()

This is called when a mutator is detached from a block. Developers wishing to perform teardown on the block should override onDetached(Block).

public Block getBlock ()

Returns

• The block this mutator is currently attached to.

public final String getMutatorId ()

Returns

• The id that was used to register this mutator's factory.

public abstract void serialize (XmlSerializer serializer)

Serializes the Mutator's state to an XML <mutation> element. Compare with block.mutationToDom() on web Blockly (added by extensions or mixins), or Mutator.toXMLElement() on blockly-ios.

Throws

IOException

public abstract void update (XmlPullParser parser)

Updates the mutator state from the provided <mutation> XML. The parser state is such that parser.next() will return START_TAG, the beginning of the <mutation> element. Compare with block.domToMutation() on web Blockly (added by extensions or mixins), or Mutator.update() on blockly-ios.

Parameters

parser	The parser with the <mutation> element.

Throws

IOException	If the parser cannot read its source.
XmlPullParserException	If the parser cannot parse into XML.
BlockLoadingException	If the XML is not what the mutator expected.

Protected Methods

protected void onAttached (Block block)

Called immediately after the mutator is attached to the block. Can be used to perform additional block initialization related to this mutator.

Parameters

block

protected void onDetached (Block block)

Called immediately after the mutator is detached from a block, usually as a result of destroying the block.

Parameters

block