Interface GameSpecificOrderReader

  • All Known Implementing Classes:
    OrderReader

    public interface GameSpecificOrderReader
    Reads an order file.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  GameSpecificOrderReader.Status
      Describes a few aspects of the orders read.
    • Method Detail

      • setLocale

        void setLocale​(java.util.Locale locale)
        Sets the order locale.
      • getLocale

        java.util.Locale getLocale()
        Returns the order locale.
      • read

        void read​(java.io.Reader in)
           throws java.io.IOException
        Reads the orders from the specified Reader. Orders for multiple factions can be read. Region lines are ignored. Unit are not created. If there are orders for a unit that cannot be found in the game data these orders are ignored. Lines containing ECHECK comments are always ignored. Comments starting with a semicolon and containing the literal 'bestaetigt' (case and umlaut insensitive) after an arbitrary number of whitespace characters are never added to a unit's orders, instead they set the order confirmation status of the unit to true.
        Throws:
        java.io.IOException - if an I/O error occurs
      • getAutoConfirm

        boolean getAutoConfirm()
        Returns whether all read orders get automatically confirmed.
      • setAutoConfirm

        void setAutoConfirm​(boolean autoConfirm)
        Sets whether all read orders get automatically confirmed.
      • isIgnoringSemicolonComments

        boolean isIgnoringSemicolonComments()
        Returns whether all comments in the orders starting with a semicolon (except confirmation comments) are ignored.
      • setIgnoreSemicolonComments

        void setIgnoreSemicolonComments​(boolean ignoreSemicolonComments)
        Sets whether all comments in the orders starting with a semicolon (except confirmation comments) are ignored.
      • getStatus

        GameSpecificOrderReader.Status getStatus()
        Returns the number of factions and units that were read. This method should only be called after reading the orders has finished.
      • isDoNotOverwriteConfirmedOrders

        boolean isDoNotOverwriteConfirmedOrders()
        Returns whether orders of confirmed units should be overwritten.
        Returns:
        Returns doNotOverwriteConfirmedOrders.
      • setDoNotOverwriteConfirmedOrders

        void setDoNotOverwriteConfirmedOrders​(boolean doNotOverwriteConfirmedOrders)
        Sets whether orders of confirmed units should be overwritten. If set to true, orders of confirmed units will not be changed.
        Parameters:
        doNotOverwriteConfirmedOrders - The value for doNotOverwriteConfirmedOrders.
      • getCheckerName

        java.lang.String getCheckerName()
        Return the name of the order checker like ECheck.