equip.data
Class ItemMutator

java.lang.Object
  equip.runtime.Object
      equip.runtime.ValueBase
          equip.data.ItemMutator

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

ItemMutatorImpl

public abstract class ItemMutator

extends ValueBase

An object representating a 'mutation', that is a programmatic modification to a data item. This mutator class takes the current item value as argument and returns a 'new' item to replace it (which may be the original one with some fields/internal state changed).

Create an application-specific subclass which includes any required information as fields and implements apply(equip.data.ItemData) to perform the desired transformation.

Constructor Summary

ItemMutator()
Default no-arg constructor

Method Summary

boolean	_equals_helper(ItemMutator c) Internal IDL-generated equality test helper
boolean	_matches_helper(ItemMutator c) Internal IDL-generated match test helper
abstract ItemData	apply(ItemData item) The application-defined mutation function.
boolean	equals(java.lang.Object c) Standard IDL-generated equality test.
java.lang.String	getModuleName() IDL-generated helper routine to get module name (currently unimplemented).
boolean	matches(java.lang.Object c) Standard IDL-generated template match test.
void	readObject(ObjectInputStream in) Internal IDL-generated serialisation helper.
void	writeObject(ObjectOutputStream out) Internal IDL-generated serialisation helper.

Methods inherited from class equip.runtime.ValueBase

_equals_helper, _matches_helper, clone

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemMutator

public ItemMutator()

Default no-arg constructor

Method Detail

apply

public abstract ItemData apply(ItemData item)

The application-defined mutation function.

Parameters:

item - The previous item value.

Returns:

The new value of the item.

getModuleName

public java.lang.String getModuleName()

IDL-generated helper routine to get module name (currently unimplemented).

Overrides:

getModuleName in class Object

Returns:

name of this class's module

equals

public boolean equals(java.lang.Object c)

Standard IDL-generated equality test.

Overrides:

equals in class ValueBase

Parameters:

c - The object to be compared against this.

Returns:

true if this is equal to c

_equals_helper

public boolean _equals_helper(ItemMutator c)

Internal IDL-generated equality test helper

matches

public boolean matches(java.lang.Object c)

Standard IDL-generated template match test.

Overrides:

matches in class ValueBase

Parameters:

c - The object to be checked against this template.

Returns:

true if this (as a template) matches the argument

_matches_helper

public boolean _matches_helper(ItemMutator c)

Internal IDL-generated match test helper

writeObject

public void writeObject(ObjectOutputStream out)
                 throws java.io.IOException

Internal IDL-generated serialisation helper. Used by ObjectInputStream and ObjectOutputStream only.

Overrides:

writeObject in class ValueBase

Throws:

java.io.IOException

readObject

public void readObject(ObjectInputStream in)
                throws java.io.IOException,
                       java.lang.ClassNotFoundException,
                       java.lang.InstantiationException

Internal IDL-generated serialisation helper. Used by ObjectInputStream and ObjectOutputStream only.

Overrides:

readObject in class ValueBase

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.InstantiationException