Package com.intellectualsites.arkitektonika

Class Arkitektonika

java.lang.Object

com.intellectualsites.arkitektonika.Arkitektonika

public class Arkitektonika
extends Object

Arkitektonika client class

Since:

2020-06-21

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Arkitektonika.Builder	Builder class for Arkitektonika instances.

Method Summary

Modifier and Type	Method	Description
static @NotNull Arkitektonika.Builder	builder()	Create a new Arkitektonika builder
@NotNull CompletableFuture<ResourceStatus>	checkStatus(@NotNull String key)	Check the status of a remote schematic
@NotNull CompletableFuture<Boolean>	delete(@NotNull String key)	Attempt to delete a schematic from the remote service
@NotNull CompletableFuture<Schematic>	download(@NotNull String key)	Attempt to download a schematic from the remote service
@NotNull ApiClient	getClient()	Get the internal ApiClient instance.
@NotNull CompletableFuture<Boolean>	isCompatible()	Check if the specified address is compatible with the Arkitektonika client
@NotNull CompletableFuture<SchematicKeys>	upload(@NotNull File file)	Upload the schematic that is contained in a given file and return the generated access keys

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

@NotNull
public static @NotNull Arkitektonika.Builder builder()

Create a new Arkitektonika builder

Returns:

New builder

getClient

@NotNull
public @NotNull ApiClient getClient()

Get the internal ApiClient instance. It is not recommended to interact with this client directly.

Returns:

Internal client

isCompatible

@NotNull
public @NotNull CompletableFuture<Boolean> isCompatible()

Check if the specified address is compatible with the Arkitektonika client

Returns:

Future that completes with the result

upload

@NotNull
public @NotNull CompletableFuture<SchematicKeys> upload(@NotNull
 @NotNull File file)

Upload the schematic that is contained in a given file and return the generated access keys

Parameters:

file - Schematic File

Returns:

Future that completes with the generated keys

checkStatus

@NotNull
public @NotNull CompletableFuture<ResourceStatus> checkStatus(@NotNull
 @NotNull String key)

Check the status of a remote schematic

Parameters:

key - Schematic access key

Returns:

Future that completes with the resource status

delete

@NotNull
public @NotNull CompletableFuture<Boolean> delete(@NotNull
 @NotNull String key)

Attempt to delete a schematic from the remote service

Parameters:

key - Deletion key

Returns:

Future that completes with the result

download

@NotNull
public @NotNull CompletableFuture<Schematic> download(@NotNull
 @NotNull String key)

Attempt to download a schematic from the remote service

Parameters:

key - Download key

Returns:

Future that completes with the result