diff --git a/src/main/lombok/org/warp/filesponge/api/FileAccessor.java b/src/main/lombok/org/warp/filesponge/api/FileAccessor.java index bff5261..6246346 100644 --- a/src/main/lombok/org/warp/filesponge/api/FileAccessor.java +++ b/src/main/lombok/org/warp/filesponge/api/FileAccessor.java @@ -19,6 +19,7 @@ package org.warp.filesponge.api; import java.util.Optional; +import java.util.concurrent.CompletableFuture; import org.jetbrains.annotations.NotNull; /** @@ -26,9 +27,24 @@ import org.jetbrains.annotations.NotNull; */ public interface FileAccessor { + /** + * Request file deletion + * @param fileURI File URI + */ void delete(@NotNull FileURI fileURI); - Optional getContent(@NotNull FileURI fileURI, boolean offlineOnly); + /** + * Get file content + * @param fileURI File URI + * @param offlineOnly true to get the file from cache + * @return content if found. If the request is offline the future will complete instantly + */ + CompletableFuture> getContent(@NotNull FileURI fileURI, boolean offlineOnly); + /** + * Get file status + * @param fileURI File URI + * @return status of this file + */ @NotNull FileStatus getStatus(@NotNull FileURI fileURI); } diff --git a/src/main/lombok/org/warp/filesponge/api/FileSpongeClient.java b/src/main/lombok/org/warp/filesponge/api/FileSpongeClient.java index 2400ed2..adc4f07 100644 --- a/src/main/lombok/org/warp/filesponge/api/FileSpongeClient.java +++ b/src/main/lombok/org/warp/filesponge/api/FileSpongeClient.java @@ -29,7 +29,7 @@ public interface FileSpongeClient extends FileAccessor { /** * Get this instance but without special methods - * @return a limited instance of itself + * @return limited instance of itself */ default FileAccessor asFileAccessor() { return new SecureFileAccessor(this);