Package net.sf.gridarta.model.exitconnector

Class ExitLocation

  • public class ExitLocation
extends java.lang.Object
    Stores information about a remembered exit location.

    • Constructor Summary

      Constructors 
      Constructor Description
      ExitLocation​(@NotNull MapFile mapFile, @NotNull java.awt.Point point, @NotNull java.lang.String mapName)
      Creates a new instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(@Nullable java.lang.Object obj)  
      @NotNull java.awt.Point getMapCoordinate()
      Returns the coordinate of the remembered exit.
      @NotNull MapFile getMapFile()
      Returns the file of the map that contains the remembered exit.
      int hashCode()  
      java.lang.String toString()  
      void updateExitObject​(@NotNull BaseObject<?,​?,​?,​?> gameObject, boolean updateName, @Nullable MapFile sourceMapFile)
      Updates exit information.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • ExitLocation

        public ExitLocation​(@NotNull
                    @NotNull MapFile mapFile,
                    @NotNull
                    @NotNull java.awt.Point point,
                    @NotNull
                    @NotNull java.lang.String mapName)
        Creates a new instance.
        Parameters:
        mapFile - the map file that contains the remembered exit
        point - the coordinate of the remembered exit
        mapName - the map name of the remembered exit

    • Method Detail

      • getMapCoordinate

        @NotNull
public @NotNull java.awt.Point getMapCoordinate()
        Returns the coordinate of the remembered exit.
        Returns:
        the coordinate

      • updateExitObject

        public void updateExitObject​(@NotNull
                             @NotNull BaseObject<?,​?,​?,​?> gameObject,
                             boolean updateName,
                             @Nullable
                             @Nullable MapFile sourceMapFile)
        Updates exit information.
        Parameters:
        gameObject - the exit game object to update
        updateName - whether the exit's name should be updated
        sourceMapFile - the file of the map containing gameObject or null if on an unsaved map

      • getMapFile

        @NotNull
public @NotNull MapFile getMapFile()
        Returns the file of the map that contains the remembered exit.
        Returns:
        the file

      • equals

        public boolean equals​(@Nullable
                      @Nullable java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

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