jfreerails.move
Class AddItemToListMove

java.lang.Object
  extended by jfreerails.move.AddItemToListMove
All Implemented Interfaces:
java.io.Serializable, ListMove, Move, FreerailsSerializable
Direct Known Subclasses:
AddCargoBundleMove

public class AddItemToListMove
extends java.lang.Object
implements ListMove

All moves that add an item to a list should extend this class.

Author:
Luke
See Also:
Serialized Form

Field Summary
private  int index
           
private  FreerailsSerializable item
           
private  KEY listKey
           
private  FreerailsPrincipal principal
           
private static long serialVersionUID
           
 
Constructor Summary
AddItemToListMove(KEY key, int i, FreerailsSerializable item, FreerailsPrincipal p)
           
 
Method Summary
 MoveStatus doMove(World w, FreerailsPrincipal p)
          Executes this move on the specifed world object.
 boolean equals(java.lang.Object o)
           
 FreerailsSerializable getAfter()
           
 FreerailsSerializable getBefore()
           
 int getIndex()
           
 KEY getKey()
           
 FreerailsPrincipal getPrincipal()
           
 int hashCode()
           
 java.lang.String toString()
           
 MoveStatus tryDoMove(World w, FreerailsPrincipal p)
          Tests whether this Move can be executed on the specifed world object, this method should leave the world object unchanged.
 MoveStatus tryUndoMove(World w, FreerailsPrincipal p)
          Tests whether this Move can be undone on the specifed world object, this method should leave the world object unchanged.
 MoveStatus undoMove(World w, FreerailsPrincipal p)
          If doMove has just been executed on the specified world object, calling this method changes the state of the world object back to how it was before doMove was called.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

listKey

private final KEY listKey

index

private final int index

principal

private final FreerailsPrincipal principal

item

private final FreerailsSerializable item
Constructor Detail

AddItemToListMove

public AddItemToListMove(KEY key,
                         int i,
                         FreerailsSerializable item,
                         FreerailsPrincipal p)
Method Detail

getIndex

public int getIndex()
Specified by:
getIndex in interface ListMove
Returns:
the index of the item which changed.

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

getKey

public KEY getKey()
Specified by:
getKey in interface ListMove
Returns:
the type of object which was changed

tryDoMove

public MoveStatus tryDoMove(World w,
                            FreerailsPrincipal p)
Description copied from interface: Move
Tests whether this Move can be executed on the specifed world object, this method should leave the world object unchanged.

Specified by:
tryDoMove in interface Move

tryUndoMove

public MoveStatus tryUndoMove(World w,
                              FreerailsPrincipal p)
Description copied from interface: Move
Tests whether this Move can be undone on the specifed world object, this method should leave the world object unchanged.

Specified by:
tryUndoMove in interface Move

doMove

public MoveStatus doMove(World w,
                         FreerailsPrincipal p)
Description copied from interface: Move
Executes this move on the specifed world object.

Specified by:
doMove in interface Move

undoMove

public MoveStatus undoMove(World w,
                           FreerailsPrincipal p)
Description copied from interface: Move
If doMove has just been executed on the specified world object, calling this method changes the state of the world object back to how it was before doMove was called.

Specified by:
undoMove in interface Move

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

getBefore

public FreerailsSerializable getBefore()
Specified by:
getBefore in interface ListMove
Returns:
the old item or null if not any.

getAfter

public FreerailsSerializable getAfter()
Specified by:
getAfter in interface ListMove
Returns:
the new item or null if not any.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getPrincipal

public FreerailsPrincipal getPrincipal()
Specified by:
getPrincipal in interface ListMove