Package it.tidalwave.mapviewer.javafx

Record Class MapView.Options

java.lang.Object
java.lang.Record
it.tidalwave.mapviewer.javafx.MapView.Options
Record Components:
cacheFolder - the Path of the folder where cached tiles are stored
downloadAllowed - whether downloading tiles is allowed
poolSize - the number of parallel thread of the tile downloader
tileQueueCapacity - the capacity of the tile queue
waitingImage - a Supplier of the image to be rendered while the tile bitmap has not been downloaded yet
executorService - the ExecutorService to load tiles in backgrounds
Enclosing class:
MapView
@API(status=STABLE) public static record MapView.Options(@Nonnull Path cacheFolder, boolean downloadAllowed, int poolSize, int tileQueueCapacity, @Nonnull Supplier<javafx.scene.image.Image> waitingImage, @Nonnull Function<Integer,ExecutorService> executorService) extends Record
Options for creating a MapView. Don't directly create an instance of this class, but use MapView.options() and then set the desired attributes with a with*() method.

  • Constructor Details

    • Options

      public Options(@Nonnull Path cacheFolder, boolean downloadAllowed, int poolSize, int tileQueueCapacity, @Nonnull Supplier<javafx.scene.image.Image> waitingImage, @Nonnull Function<Integer,ExecutorService> executorService)
      Creates an instance of a Options record class.
      Parameters:
      cacheFolder - the value for the cacheFolder record component
      downloadAllowed - the value for the downloadAllowed record component
      poolSize - the value for the poolSize record component
      tileQueueCapacity - the value for the tileQueueCapacity record component
      waitingImage - the value for the waitingImage record component
      executorService - the value for the executorService record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • cacheFolder

      @Nonnull public Path cacheFolder()
      Returns the value of the cacheFolder record component.
      Returns:
      the value of the cacheFolder record component

    • downloadAllowed

      public boolean downloadAllowed()
      Returns the value of the downloadAllowed record component.
      Returns:
      the value of the downloadAllowed record component

    • poolSize

      public int poolSize()
      Returns the value of the poolSize record component.
      Returns:
      the value of the poolSize record component

    • tileQueueCapacity

      public int tileQueueCapacity()
      Returns the value of the tileQueueCapacity record component.
      Returns:
      the value of the tileQueueCapacity record component

    • waitingImage

      @Nonnull public Supplier<javafx.scene.image.Image> waitingImage()
      Returns the value of the waitingImage record component.
      Returns:
      the value of the waitingImage record component

    • executorService

      @Nonnull public Function<Integer,ExecutorService> executorService()
      Returns the value of the executorService record component.
      Returns:
      the value of the executorService record component