dip.order.result
Class ConvoyPathResult

java.lang.Object
  dip.order.result.Result
      dip.order.result.OrderResult
          dip.order.result.ConvoyPathResult

All Implemented Interfaces:

java.lang.Comparable, java.io.Serializable

public class ConvoyPathResult

extends OrderResult

An OrderResult that contains the path taken by a successfully convoyed Move. It has the result type of CONVOY_PATH_TAKEN.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class dip.order.result.OrderResult

OrderResult.ResultType

Field Summary

Fields inherited from class dip.order.result.OrderResult

order, resultType

Fields inherited from class dip.order.result.Result

message, power

Constructor Summary

ConvoyPathResult(Orderable order, java.util.List path)
Create a ConvoyPathResult

ConvoyPathResult(Orderable order, Province[] convoyPath)
Create a ConvoyPathResult

Method Summary

Province[]	getConvoyPath() Gets the Convoy Path; path includes source and destination provinces.
java.lang.String	getMessage(OrderFormatOptions ofo) Creates an appropriate internationalized text message given the convoy path.
java.lang.String	toString() Primarily for debugging.

Methods inherited from class dip.order.result.OrderResult

compareTo, getOrder, getResultType

Methods inherited from class dip.order.result.Result

getMessage, getPower

Methods inherited from class java.lang.Object

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

Constructor Detail

ConvoyPathResult

public ConvoyPathResult(Orderable order,
                        java.util.List path)

Create a ConvoyPathResult

ConvoyPathResult

public ConvoyPathResult(Orderable order,
                        Province[] convoyPath)

Create a ConvoyPathResult

Method Detail

getConvoyPath

public Province[] getConvoyPath()

Gets the Convoy Path; path includes source and destination provinces.

getMessage

public java.lang.String getMessage(OrderFormatOptions ofo)

Creates an appropriate internationalized text message given the convoy path.

Overrides:

getMessage in class Result

toString

public java.lang.String toString()

Primarily for debugging.

Overrides:

toString in class OrderResult