Index (location 1.1.2 API)

C D E F H I L M N O P R S T U V W X Y Z
All Classes and Interfaces|All Packages|Serialized Form

C

close() - Method in interface com.cotani.location.api.LocationService: Starts asynchronous shutdown, rejects new mutations, and completes after accepted mutations finish.
com.cotani.location - package com.cotani.location
com.cotani.location.api - package com.cotani.location.api
com.cotani.location.storage - package com.cotani.location.storage
CotaniLocations - Class in com.cotani.location: Factories for the cotani-location module.
createdAt() - Method in record class com.cotani.location.api.Home: Returns the value of the createdAt record component.
createdAt() - Method in record class com.cotani.location.api.Warp: Returns the value of the createdAt record component.
CreateLocationIndexesMigration - Class in com.cotani.location.storage: Adds lookup indexes for player homes and global warps.
CreateLocationIndexesMigration() - Constructor for class com.cotani.location.storage.CreateLocationIndexesMigration
CreateLocationTablesMigration - Class in com.cotani.location.storage: Creates the SQL table used by StorageLocationRepository.
CreateLocationTablesMigration() - Constructor for class com.cotani.location.storage.CreateLocationTablesMigration

D

defaults() - Static method in record class com.cotani.location.api.LocationServiceOptions
deleteHomeAsync(HomeId) - Method in interface com.cotani.location.api.LocationRepository: Deletes one player home.
deleteHomeAsync(HomeId) - Method in class com.cotani.location.storage.StorageLocationRepository
deleteHomeAsync(UUID, LocationName) - Method in interface com.cotani.location.api.LocationService: Deletes one home, failing with HomeNotFoundException when absent.
deleteWarpAsync(LocationName) - Method in interface com.cotani.location.api.LocationService: Deletes one warp, failing with WarpNotFoundException when absent.
deleteWarpAsync(WarpId) - Method in interface com.cotani.location.api.LocationRepository: Deletes one global warp.
deleteWarpAsync(WarpId) - Method in class com.cotani.location.storage.StorageLocationRepository
description() - Method in class com.cotani.location.storage.CreateLocationIndexesMigration
description() - Method in class com.cotani.location.storage.CreateLocationTablesMigration

E

empty() - Static method in record class com.cotani.location.api.LocationSnapshot
equals(Object) - Method in record class com.cotani.location.api.Home: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cotani.location.api.HomeId: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cotani.location.api.LocationName: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cotani.location.api.LocationPosition: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cotani.location.api.LocationServiceOptions: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cotani.location.api.LocationSnapshot: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cotani.location.api.Warp: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cotani.location.api.WarpId: Indicates whether some other object is "equal to" this one.

F

findHomeAsync(UUID, LocationName) - Method in interface com.cotani.location.api.LocationService: Finds one home, returning empty when it is absent.
findWarpAsync(LocationName) - Method in interface com.cotani.location.api.LocationService: Finds one warp, returning empty when it is absent.
fromRepositoryAsync(LocationRepository) - Static method in class com.cotani.location.CotaniLocations: Restores a location service from a repository asynchronously; loading must complete before use.
fromRepositoryAsync(LocationRepository, LocationServiceOptions) - Static method in class com.cotani.location.CotaniLocations: Restores a location service with explicit operational options.

H

hashCode() - Method in record class com.cotani.location.api.Home: Returns a hash code value for this object.
hashCode() - Method in record class com.cotani.location.api.HomeId: Returns a hash code value for this object.
hashCode() - Method in record class com.cotani.location.api.LocationName: Returns a hash code value for this object.
hashCode() - Method in record class com.cotani.location.api.LocationPosition: Returns a hash code value for this object.
hashCode() - Method in record class com.cotani.location.api.LocationServiceOptions: Returns a hash code value for this object.
hashCode() - Method in record class com.cotani.location.api.LocationSnapshot: Returns a hash code value for this object.
hashCode() - Method in record class com.cotani.location.api.Warp: Returns a hash code value for this object.
hashCode() - Method in record class com.cotani.location.api.WarpId: Returns a hash code value for this object.
Home - Record Class in com.cotani.location.api: Immutable player-owned home.
Home(HomeId, LocationPosition, Instant, Instant) - Constructor for record class com.cotani.location.api.Home: Creates an instance of a Home record class.
HomeId - Record Class in com.cotani.location.api: Stable key for a player-owned home.
HomeId(UUID, LocationName) - Constructor for record class com.cotani.location.api.HomeId: Creates an instance of a HomeId record class.
HomeLimitExceededException - Exception Class in com.cotani.location.api: Raised when a player has reached the configured number of homes.
HomeLimitExceededException(UUID, int) - Constructor for exception class com.cotani.location.api.HomeLimitExceededException
HomeNotFoundException - Exception Class in com.cotani.location.api: Raised when a requested home does not exist.
HomeNotFoundException(HomeId) - Constructor for exception class com.cotani.location.api.HomeNotFoundException
homes() - Method in record class com.cotani.location.api.LocationSnapshot: Returns the value of the homes record component.
homesAsync(UUID) - Method in interface com.cotani.location.api.LocationService: Lists the owner's homes in deterministic name order.

I

id() - Method in record class com.cotani.location.api.Home: Returns the value of the id record component.
id() - Method in exception class com.cotani.location.api.HomeNotFoundException
id() - Method in record class com.cotani.location.api.Warp: Returns the value of the id record component.
id() - Method in exception class com.cotani.location.api.WarpNotFoundException
inMemory() - Static method in class com.cotani.location.CotaniLocations: Creates an isolated in-memory location service.
inMemory(LocationServiceOptions) - Static method in class com.cotani.location.CotaniLocations: Creates an isolated in-memory service with explicit operational options.

L

limit() - Method in exception class com.cotani.location.api.HomeLimitExceededException
loadAsync() - Method in interface com.cotani.location.api.LocationRepository: Loads the complete persisted state before a service becomes available.
loadAsync() - Method in class com.cotani.location.storage.StorageLocationRepository
LocationException - Exception Class in com.cotani.location.api: Base exception for expected location-domain failures.
LocationException(String) - Constructor for exception class com.cotani.location.api.LocationException
LocationException(String, Throwable) - Constructor for exception class com.cotani.location.api.LocationException
LocationName - Record Class in com.cotani.location.api: Canonical, case-insensitive name used by a home or warp.
LocationName(String) - Constructor for record class com.cotani.location.api.LocationName: Creates an instance of a LocationName record class.
LocationPosition - Record Class in com.cotani.location.api: Immutable, Bukkit-independent representation of a saved position.
LocationPosition(UUID, double, double, double, float, float) - Constructor for record class com.cotani.location.api.LocationPosition: Creates an instance of a LocationPosition record class.
LocationRepository - Interface in com.cotani.location.api: Persistence SPI for saved locations.
LocationService - Interface in com.cotani.location.api: Asynchronous CRUD use cases for player homes and global warps.
LocationServiceOptions - Record Class in com.cotani.location.api: Operational limits and timeout for a location service.
LocationServiceOptions(int, Duration) - Constructor for record class com.cotani.location.api.LocationServiceOptions: Creates an instance of a LocationServiceOptions record class.
LocationSnapshot - Record Class in com.cotani.location.api: Complete immutable state exchanged with a location repository.
LocationSnapshot(List, List) - Constructor for record class com.cotani.location.api.LocationSnapshot: Creates an instance of a LocationSnapshot record class.
LocationTeleportService - Interface in com.cotani.location.api: Resolves saved positions on the correct server thread and delegates to cotani-teleport.

M

maxHomesPerPlayer() - Method in record class com.cotani.location.api.LocationServiceOptions: Returns the value of the maxHomesPerPlayer record component.
migrate(Schema) - Method in class com.cotani.location.storage.CreateLocationIndexesMigration
migrate(Schema) - Method in class com.cotani.location.storage.CreateLocationTablesMigration
migrations() - Static method in class com.cotani.location.storage.StorageLocationRepository

N

name() - Method in record class com.cotani.location.api.HomeId: Returns the value of the name record component.
name() - Method in record class com.cotani.location.api.WarpId: Returns the value of the name record component.

O

of(String) - Static method in record class com.cotani.location.api.LocationName
of(String) - Static method in record class com.cotani.location.api.WarpId
of(UUID, String) - Static method in record class com.cotani.location.api.HomeId
ownerId() - Method in record class com.cotani.location.api.HomeId: Returns the value of the ownerId record component.
ownerId() - Method in exception class com.cotani.location.api.HomeLimitExceededException

P

pitch() - Method in record class com.cotani.location.api.LocationPosition: Returns the value of the pitch record component.
position() - Method in record class com.cotani.location.api.Home: Returns the value of the position record component.
position() - Method in record class com.cotani.location.api.Warp: Returns the value of the position record component.

R

repositoryTimeout() - Method in record class com.cotani.location.api.LocationServiceOptions: Returns the value of the repositoryTimeout record component.

S

saveHomeAsync(Home) - Method in interface com.cotani.location.api.LocationRepository: Inserts or replaces one player home.
saveHomeAsync(Home) - Method in class com.cotani.location.storage.StorageLocationRepository
saveWarpAsync(Warp) - Method in interface com.cotani.location.api.LocationRepository: Inserts or replaces one global warp.
saveWarpAsync(Warp) - Method in class com.cotani.location.storage.StorageLocationRepository
setHomeAsync(UUID, LocationName, LocationPosition) - Method in interface com.cotani.location.api.LocationService: Creates or replaces one home, subject to the configured per-player limit.
setWarpAsync(LocationName, LocationPosition) - Method in interface com.cotani.location.api.LocationService: Creates or replaces one global warp.
StorageLocationRepository - Class in com.cotani.location.storage: SQL-backed repository with atomic per-location upserts and deletes.
StorageLocationRepository(CotaniStorage) - Constructor for class com.cotani.location.storage.StorageLocationRepository

T

teleportHomeAsync(UUID, LocationName, TeleportOptions) - Method in interface com.cotani.location.api.LocationTeleportService: Resolves and teleports a player to one of their homes.
teleports(LocationService, TeleportService, PaperTaskScheduler) - Static method in class com.cotani.location.CotaniLocations: Creates the Bukkit/Folia bridge used to teleport to saved locations.
teleportWarpAsync(UUID, LocationName, TeleportOptions) - Method in interface com.cotani.location.api.LocationTeleportService: Resolves and teleports a player to a global warp.
toString() - Method in record class com.cotani.location.api.Home: Returns a string representation of this record class.
toString() - Method in record class com.cotani.location.api.HomeId: Returns a string representation of this record class.
toString() - Method in record class com.cotani.location.api.LocationName: Returns a string representation of this record class.
toString() - Method in record class com.cotani.location.api.LocationPosition: Returns a string representation of this record class.
toString() - Method in record class com.cotani.location.api.LocationServiceOptions: Returns a string representation of this record class.
toString() - Method in record class com.cotani.location.api.LocationSnapshot: Returns a string representation of this record class.
toString() - Method in record class com.cotani.location.api.Warp: Returns a string representation of this record class.
toString() - Method in record class com.cotani.location.api.WarpId: Returns a string representation of this record class.

U

updatedAt() - Method in record class com.cotani.location.api.Home: Returns the value of the updatedAt record component.
updatedAt() - Method in record class com.cotani.location.api.Warp: Returns the value of the updatedAt record component.

V

value() - Method in record class com.cotani.location.api.LocationName: Returns the value of the value record component.
version() - Method in class com.cotani.location.storage.CreateLocationIndexesMigration
version() - Method in class com.cotani.location.storage.CreateLocationTablesMigration

W

Warp - Record Class in com.cotani.location.api: Immutable global warp.
Warp(WarpId, LocationPosition, Instant, Instant) - Constructor for record class com.cotani.location.api.Warp: Creates an instance of a Warp record class.
WarpId - Record Class in com.cotani.location.api: Stable key for a global warp.
WarpId(LocationName) - Constructor for record class com.cotani.location.api.WarpId: Creates an instance of a WarpId record class.
WarpNotFoundException - Exception Class in com.cotani.location.api: Raised when a requested warp does not exist.
WarpNotFoundException(WarpId) - Constructor for exception class com.cotani.location.api.WarpNotFoundException
warps() - Method in record class com.cotani.location.api.LocationSnapshot: Returns the value of the warps record component.
warpsAsync() - Method in interface com.cotani.location.api.LocationService: Lists all warps in deterministic name order.
withMaxHomesPerPlayer(int) - Method in record class com.cotani.location.api.LocationServiceOptions: Returns these options with a different home limit.
withRepositoryTimeout(Duration) - Method in record class com.cotani.location.api.LocationServiceOptions: Returns these options with a different repository timeout.
withRepositoryTimeout(CompletionStage) - Method in record class com.cotani.location.api.LocationServiceOptions: Applies the configured timeout to the caller-facing stage.
worldId() - Method in record class com.cotani.location.api.LocationPosition: Returns the value of the worldId record component.
worldId() - Method in exception class com.cotani.location.api.WorldUnavailableException
WorldUnavailableException - Exception Class in com.cotani.location.api: Raised when a saved location points to a world that is not currently loaded.
WorldUnavailableException(UUID) - Constructor for exception class com.cotani.location.api.WorldUnavailableException

X

x() - Method in record class com.cotani.location.api.LocationPosition: Returns the value of the x record component.

Y

y() - Method in record class com.cotani.location.api.LocationPosition: Returns the value of the y record component.
yaw() - Method in record class com.cotani.location.api.LocationPosition: Returns the value of the yaw record component.

Z

z() - Method in record class com.cotani.location.api.LocationPosition: Returns the value of the z record component.

C D E F H I L M N O P R S T U V W X Y Z
All Classes and Interfaces|All Packages|Serialized Form