SquaremapProvider (squaremap-api 1.2.2 API)

java.lang.Object

xyz.jpenilla.squaremap.api.SquaremapProvider

public final class SquaremapProvider extends Object

Static singleton for conveniently accessing the squaremap API instance. Prefer using the platform's service manager when available.

Method Summary

Modifier and Type

Method

Description

static @NonNull Squaremap

get()

Gets an instance of the Squaremap service, throwing IllegalStateException if an instance is not yet loaded.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- get
  
  public static @NonNull Squaremap get()
  
  Gets an instance of the Squaremap service, throwing IllegalStateException if an instance is not yet loaded.
  Will never return null.
  
  Returns:
  
  an api instance
  
  Throws:
  
  IllegalStateException - if the api is not loaded