games.strategy.triplea.delegate.dataObjects
Class MoveValidationResult

java.lang.Object
  extended by games.strategy.triplea.delegate.dataObjects.MoveValidationResult
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<MoveValidationResult>

public class MoveValidationResult
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<MoveValidationResult>

See Also:
Serialized Form

Constructor Summary
MoveValidationResult()
           
MoveValidationResult(MoveValidationResult toCopy)
           
 
Method Summary
 void addDisallowedUnit(java.lang.String warning, Unit unit)
           
 void addUnresolvedUnit(java.lang.String warning, Unit unit)
           
 int compareTo(MoveValidationResult other)
           
 int getDisallowedUnitCount()
           
 java.util.Collection<Unit> getDisallowedUnits()
           
 java.util.Collection<Unit> getDisallowedUnits(java.lang.String warning)
           
 java.lang.String getDisallowedUnitWarning(int index)
           
 java.util.Collection<java.lang.String> getDisallowedUnitWarnings()
           
 java.lang.String getError()
           
 int getTotalWarningCount()
           
 java.util.Collection<UnitCategory> getUnresolvedUnitCategories()
           
 int getUnresolvedUnitCount()
           
 java.util.Collection<Unit> getUnresolvedUnits()
           
 java.util.Collection<Unit> getUnresolvedUnits(java.lang.String warning)
           
 java.lang.String getUnresolvedUnitWarning(int index)
           
 java.util.Collection<java.lang.String> getUnresolvedUnitWarnings()
           
 boolean hasDisallowedUnits()
           
 boolean hasError()
           
 boolean hasUnresolvedUnits()
           
 boolean isMoveValid()
           
 void removeAnyUnresolvedUnitsThatAreDisallowed()
           
 boolean removeDisallowedUnit(java.lang.String warning, Unit unit)
           
 boolean removeUnresolvedUnit(java.lang.String warning, Unit unit)
           
 void setError(java.lang.String error)
           
 MoveValidationResult setErrorReturnResult(java.lang.String error)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MoveValidationResult

public MoveValidationResult()

MoveValidationResult

public MoveValidationResult(MoveValidationResult toCopy)
Method Detail

addDisallowedUnit

public void addDisallowedUnit(java.lang.String warning,
                              Unit unit)

removeDisallowedUnit

public boolean removeDisallowedUnit(java.lang.String warning,
                                    Unit unit)

addUnresolvedUnit

public void addUnresolvedUnit(java.lang.String warning,
                              Unit unit)

removeUnresolvedUnit

public boolean removeUnresolvedUnit(java.lang.String warning,
                                    Unit unit)

setError

public void setError(java.lang.String error)

setErrorReturnResult

public MoveValidationResult setErrorReturnResult(java.lang.String error)

getError

public java.lang.String getError()

getDisallowedUnits

public java.util.Collection<Unit> getDisallowedUnits()

getUnresolvedUnits

public java.util.Collection<Unit> getUnresolvedUnits()

getUnresolvedUnitCategories

public java.util.Collection<UnitCategory> getUnresolvedUnitCategories()

getDisallowedUnits

public java.util.Collection<Unit> getDisallowedUnits(java.lang.String warning)

getUnresolvedUnits

public java.util.Collection<Unit> getUnresolvedUnits(java.lang.String warning)

getDisallowedUnitWarnings

public java.util.Collection<java.lang.String> getDisallowedUnitWarnings()

getUnresolvedUnitWarnings

public java.util.Collection<java.lang.String> getUnresolvedUnitWarnings()

getDisallowedUnitWarning

public java.lang.String getDisallowedUnitWarning(int index)

getUnresolvedUnitWarning

public java.lang.String getUnresolvedUnitWarning(int index)

hasError

public boolean hasError()

hasDisallowedUnits

public boolean hasDisallowedUnits()

getDisallowedUnitCount

public int getDisallowedUnitCount()

hasUnresolvedUnits

public boolean hasUnresolvedUnits()

getUnresolvedUnitCount

public int getUnresolvedUnitCount()

isMoveValid

public boolean isMoveValid()

getTotalWarningCount

public int getTotalWarningCount()

removeAnyUnresolvedUnitsThatAreDisallowed

public void removeAnyUnresolvedUnitsThatAreDisallowed()

compareTo

public int compareTo(MoveValidationResult other)
Specified by:
compareTo in interface java.lang.Comparable<MoveValidationResult>

toString

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