Class MagellanBorderImpl

  • All Implemented Interfaces:
    java.lang.Cloneable, java.lang.Comparable<java.lang.Object>, Border, Identifiable, Unique

    public class MagellanBorderImpl
    extends MagellanIdentifiableImpl
    implements Border
    Container class for a region border based on its representation in a cr version > 45.
    • Constructor Detail

      • MagellanBorderImpl

        public MagellanBorderImpl​(IntegerID id)
        Create a new Border object with the specified id.
        Parameters:
        id - the id of the border
      • MagellanBorderImpl

        public MagellanBorderImpl​(IntegerID id,
                                  int direction,
                                  java.lang.String type,
                                  int buildRatio)
        Create a new Border object initialized to the specified values.
        Parameters:
        id - the id of the border
        direction - the direction of the border
        type - the type of the border
        buildRatio - indicates, to what extend this border type is completed (e.g. street)
    • Method Detail

      • toString

        public java.lang.String toString()
        Return a string representation of this Border object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        Border object as string.
      • getBuildRatio

        public int getBuildRatio()
        Description copied from interface: Border
        Indicates, to what extend this border type is completed. Values may range from 0 to 100, or -1 standing for an uninitialized/invalid value.
        Specified by:
        getBuildRatio in interface Border
      • getDirection

        public int getDirection()
        Description copied from interface: Border
        The direction in which the border lies. The value must be one of the DIR_XXX constants in class Direction.
        Specified by:
        getDirection in interface Border
      • getEffects

        public java.util.List<java.lang.String> getEffects()
        Description copied from interface: Border
        A list containing String objects, specifying effects on this border.
        Specified by:
        getEffects in interface Border
      • getType

        public java.lang.String getType()
        Description copied from interface: Border
        The type of this border.
        Specified by:
        getType in interface Border
      • setDirection

        public void setDirection​(int direction)
        Description copied from interface: Border
        The direction in which the border lies. The value must be one of the DIR_XXX constants in class Direction.
        Specified by:
        setDirection in interface Border
      • setType

        public void setType​(java.lang.String type)
        Description copied from interface: Border
        The type of this border.
        Specified by:
        setType in interface Border
      • setBuildRatio

        public void setBuildRatio​(int buildratio)
        Description copied from interface: Border
        Indicates, to what extend this border type is completed. Values may range from 0 to 100, or -1 standing for an uninitialized/invalid value.
        Specified by:
        setBuildRatio in interface Border
      • setEffects

        public void setEffects​(java.util.List<java.lang.String> effects)
        Description copied from interface: Border
        A list containing String objects, specifying effects on this border.
        Specified by:
        setEffects in interface Border