Interface Border

  • All Superinterfaces:
    java.lang.Cloneable, java.lang.Comparable<java.lang.Object>, Identifiable, Unique
    All Known Implementing Classes:
    MagellanBorderImpl

    public interface Border
    extends Identifiable
    Container class for a region border based on its representation in a cr version > 45.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static StringID STRASSE
      Deprecated.
      should use EresseaConstants
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getBuildRatio()
      Indicates, to what extend this border type is completed.
      int getDirection()
      The direction in which the border lies.
      java.util.List<java.lang.String> getEffects()
      A list containing String objects, specifying effects on this border.
      IntegerID getID()
      Returns the id uniquely identifying this object.
      java.lang.String getType()
      The type of this border.
      void setBuildRatio​(int buildratio)
      Indicates, to what extend this border type is completed.
      void setDirection​(int direction)
      The direction in which the border lies.
      void setEffects​(java.util.List<java.lang.String> effects)
      A list containing String objects, specifying effects on this border.
      void setType​(java.lang.String type)
      The type of this border.
    • Field Detail

      • STRASSE

        @Deprecated
        static final StringID STRASSE
        Deprecated.
        should use EresseaConstants
    • Method Detail

      • getDirection

        int getDirection()
        The direction in which the border lies. The value must be one of the DIR_XXX constants in class Direction.
      • setDirection

        void setDirection​(int direction)
        The direction in which the border lies. The value must be one of the DIR_XXX constants in class Direction.
      • getType

        java.lang.String getType()
        The type of this border.
      • setType

        void setType​(java.lang.String type)
        The type of this border.
      • getBuildRatio

        int getBuildRatio()
        Indicates, to what extend this border type is completed. Values may range from 0 to 100, or -1 standing for an uninitialized/invalid value.
      • setBuildRatio

        void setBuildRatio​(int buildratio)
        Indicates, to what extend this border type is completed. Values may range from 0 to 100, or -1 standing for an uninitialized/invalid value.
      • getEffects

        java.util.List<java.lang.String> getEffects()
        A list containing String objects, specifying effects on this border.
      • setEffects

        void setEffects​(java.util.List<java.lang.String> effects)
        A list containing String objects, specifying effects on this border.