NearbyStructuresResponse

java.lang.Object

com.ryandw11.structure.io.NearbyStructuresResponse

public class NearbyStructuresResponse extends Object

The response of the nearby request.

Returned in the CompletableFuture provided by StructureDatabaseHandler.findNearby(NearbyStructuresRequest).

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

NearbyStructuresResponse.NearbyStructureContainer

The container to contain the nearby structure results.
Constructor Summary

Constructors

Constructor

Description

NearbyStructuresResponse(@NotNull List<NearbyStructuresResponse.NearbyStructureContainer> response)

Construct a nearby structure response.
Method Summary

Modifier and Type

Method

Description

@Nullable NearbyStructuresResponse.NearbyStructureContainer

getFirst()

Get the closest nearby structure.

List<NearbyStructuresResponse.NearbyStructureContainer>

getResponse()

Get the list of nearby structures.

boolean

hasEntries()

Check if any nearby structures were found.

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

Constructor Details
- NearbyStructuresResponse
  
  public NearbyStructuresResponse(@NotNull @NotNull List<NearbyStructuresResponse.NearbyStructureContainer> response)
  
  Construct a nearby structure response.
  For internal use only.
  
  Parameters:
  
  response - The list of nearby structures.
Method Details
- getResponse
  
  public List<NearbyStructuresResponse.NearbyStructureContainer> getResponse()
  
  Get the list of nearby structures.
  
  Returns:
  
  The list of nearby structures.
- getFirst
  
  @Nullable public @Nullable NearbyStructuresResponse.NearbyStructureContainer getFirst()
  
  Get the closest nearby structure.
  Use hasEntries() to check if there are any structures first.
  
  Returns:
  
  The closest nearby structure. (Null if no structures are found).
- hasEntries
  
  public boolean hasEntries()
  
  Check if any nearby structures were found.
  
  Returns:
  
  If any nearby structures were found.