Package de.dytanic.cloudnet.driver.template

Interface SpecificTemplateStorage

All Superinterfaces:

de.dytanic.cloudnet.common.INameable

All Known Implementing Classes:

DefaultSpecificTemplateStorage

public interface SpecificTemplateStorage
extends de.dytanic.cloudnet.common.INameable

Method Summary

Modifier and Type	Method	Description
@Nullable java.io.OutputStream	appendOutputStream(@NotNull java.lang.String path)
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.io.OutputStream>	appendOutputStreamAsync(@NotNull java.lang.String path)
@Nullable java.util.zip.ZipInputStream	asZipInputStream()
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.util.zip.ZipInputStream>	asZipInputStreamAsync()
boolean	copy(@NotNull java.nio.file.Path directory)
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean>	copyAsync(@NotNull java.nio.file.Path directory)
boolean	create()
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean>	createAsync()
boolean	createDirectory(@NotNull java.lang.String path)
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean>	createDirectoryAsync(@NotNull java.lang.String path)
boolean	createFile(@NotNull java.lang.String path)
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean>	createFileAsync(@NotNull java.lang.String path)
boolean	delete()
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean>	deleteAsync()
boolean	deleteFile(@NotNull java.lang.String path)
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean>	deleteFileAsync(@NotNull java.lang.String path)
boolean	deploy(@NotNull java.io.InputStream inputStream)
default boolean	deploy(@NotNull java.nio.file.Path directory)
boolean	deploy(@NotNull java.nio.file.Path directory, @Nullable java.util.function.Predicate<java.nio.file.Path> fileFilter)
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean>	deployAsync(@NotNull java.io.InputStream inputStream)
default @NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean>	deployAsync(@NotNull java.nio.file.Path directory)
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean>	deployAsync(@NotNull java.nio.file.Path directory, @Nullable java.util.function.Predicate<java.nio.file.Path> fileFilter)
boolean	exists()
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean>	existsAsync()
@Nullable FileInfo	getFileInfo(@NotNull java.lang.String path)
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<FileInfo>	getFileInfoAsync(@NotNull java.lang.String path)
@NotNull ServiceTemplate	getTargetTemplate()	Gets the template this class is wrapping.
@NotNull TemplateStorage	getWrappedStorage()	Gets the storage this class is wrapping.
boolean	hasFile(@NotNull java.lang.String path)
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean>	hasFileAsync(@NotNull java.lang.String path)
default @Nullable FileInfo[]	listFiles()
default @Nullable FileInfo[]	listFiles(boolean deep)
default @Nullable FileInfo[]	listFiles(@NotNull java.lang.String dir)
@Nullable FileInfo[]	listFiles(@NotNull java.lang.String dir, boolean deep)
default @NotNull de.dytanic.cloudnet.common.concurrent.ITask<FileInfo[]>	listFilesAsync()
default @NotNull de.dytanic.cloudnet.common.concurrent.ITask<FileInfo[]>	listFilesAsync(boolean deep)
default @NotNull de.dytanic.cloudnet.common.concurrent.ITask<FileInfo[]>	listFilesAsync(@NotNull java.lang.String dir)
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<FileInfo[]>	listFilesAsync(@NotNull java.lang.String dir, boolean deep)
@Nullable java.io.InputStream	newInputStream(@NotNull java.lang.String path)
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.io.InputStream>	newInputStreamAsync(@NotNull java.lang.String path)
@Nullable java.io.OutputStream	newOutputStream(@NotNull java.lang.String path)
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.io.OutputStream>	newOutputStreamAsync(@NotNull java.lang.String path)
static @NotNull SpecificTemplateStorage	of(@NotNull ServiceTemplate template)	Creates a new SpecificTemplateStorage for the given template.
static @NotNull SpecificTemplateStorage	of(@NotNull ServiceTemplate template, @NotNull TemplateStorage storage)	Creates a new SpecificTemplateStorage for the given template.
@Nullable java.io.InputStream	zipTemplate()
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.io.InputStream>	zipTemplateAsync()

Methods inherited from interface de.dytanic.cloudnet.common.INameable

getName

Method Detail

of

@NotNull
static @NotNull SpecificTemplateStorage of(@NotNull
                                           @NotNull ServiceTemplate template)

Creates a new SpecificTemplateStorage for the given template.

Parameters:

template - the template which should be wrapped by the given storage

Returns:

a new instance of the SpecificTemplateStorage

Throws:

java.lang.IllegalArgumentException - if the storage of the given template doesn't exist

of

@NotNull
static @NotNull SpecificTemplateStorage of(@NotNull
                                           @NotNull ServiceTemplate template,
                                           @NotNull
                                           @NotNull TemplateStorage storage)

Creates a new SpecificTemplateStorage for the given template.

Parameters:

template - the template which should be wrapped by the given storage

storage - the TemplateStorage instance matching the name of the storage in the template

Returns:

a new instance of the SpecificTemplateStorage

Throws:

java.lang.IllegalArgumentException - if the name of the storage doesn't match the name of the storage in the template

getTargetTemplate

@NotNull
@NotNull ServiceTemplate getTargetTemplate()

Gets the template this class is wrapping.

getWrappedStorage

@NotNull
@NotNull TemplateStorage getWrappedStorage()

Gets the storage this class is wrapping.

deploy

boolean deploy(@NotNull
               @NotNull java.nio.file.Path directory,
               @Nullable
               @Nullable java.util.function.Predicate<java.nio.file.Path> fileFilter)

See Also:

TemplateStorage.deploy(Path, ServiceTemplate, Predicate)

deploy

default boolean deploy(@NotNull
                       @NotNull java.nio.file.Path directory)

See Also:

TemplateStorage.deploy(Path, ServiceTemplate)

deploy

boolean deploy(@NotNull
               @NotNull java.io.InputStream inputStream)

See Also:

TemplateStorage.deploy(InputStream, ServiceTemplate)

copy

boolean copy(@NotNull
             @NotNull java.nio.file.Path directory)

See Also:

TemplateStorage.copy(ServiceTemplate, Path)

asZipInputStream

@Nullable
@Nullable java.util.zip.ZipInputStream asZipInputStream()
                                                 throws java.io.IOException

Throws:

java.io.IOException

See Also:

TemplateStorage.asZipInputStream(ServiceTemplate)

zipTemplate

@Nullable
@Nullable java.io.InputStream zipTemplate()
                                   throws java.io.IOException

Throws:

java.io.IOException

See Also:

TemplateStorage.zipTemplate(ServiceTemplate)

delete

boolean delete()

See Also:

TemplateStorage.delete(ServiceTemplate)

create

boolean create()

See Also:

TemplateStorage.create(ServiceTemplate)

exists

boolean exists()

See Also:

TemplateStorage.has(ServiceTemplate)

appendOutputStream

@Nullable
@Nullable java.io.OutputStream appendOutputStream(@NotNull
                                                  @NotNull java.lang.String path)
                                           throws java.io.IOException

Throws:

java.io.IOException

See Also:

TemplateStorage.appendOutputStream(ServiceTemplate, String)

newOutputStream

@Nullable
@Nullable java.io.OutputStream newOutputStream(@NotNull
                                               @NotNull java.lang.String path)
                                        throws java.io.IOException

Throws:

java.io.IOException

See Also:

TemplateStorage.newOutputStream(ServiceTemplate, String)

createFile

boolean createFile(@NotNull
                   @NotNull java.lang.String path)
            throws java.io.IOException

Throws:

java.io.IOException

See Also:

TemplateStorage.createFile(ServiceTemplate, String)

createDirectory

boolean createDirectory(@NotNull
                        @NotNull java.lang.String path)
                 throws java.io.IOException

Throws:

java.io.IOException

See Also:

TemplateStorage.createDirectory(ServiceTemplate, String)

hasFile

boolean hasFile(@NotNull
                @NotNull java.lang.String path)
         throws java.io.IOException

Throws:

java.io.IOException

See Also:

TemplateStorage.hasFile(ServiceTemplate, String)

deleteFile

boolean deleteFile(@NotNull
                   @NotNull java.lang.String path)
            throws java.io.IOException

Throws:

java.io.IOException

See Also:

TemplateStorage.deleteFile(ServiceTemplate, String)

newInputStream

@Nullable
@Nullable java.io.InputStream newInputStream(@NotNull
                                             @NotNull java.lang.String path)
                                      throws java.io.IOException

Throws:

java.io.IOException

See Also:

TemplateStorage.newInputStream(ServiceTemplate, String)

getFileInfo

@Nullable
@Nullable FileInfo getFileInfo(@NotNull
                               @NotNull java.lang.String path)
                        throws java.io.IOException

Throws:

java.io.IOException

See Also:

TemplateStorage.getFileInfo(ServiceTemplate, String)

listFiles

@Nullable
@Nullable FileInfo[] listFiles(@NotNull
                               @NotNull java.lang.String dir,
                               boolean deep)
                        throws java.io.IOException

Throws:

java.io.IOException

See Also:

TemplateStorage.listFiles(ServiceTemplate, String, boolean)

listFiles

@Nullable
default @Nullable FileInfo[] listFiles(boolean deep)
                                throws java.io.IOException

Throws:

java.io.IOException

See Also:

TemplateStorage.listFiles(ServiceTemplate, boolean)

listFiles

@Nullable
default @Nullable FileInfo[] listFiles(@NotNull
                                       @NotNull java.lang.String dir)
                                throws java.io.IOException

Throws:

java.io.IOException

See Also:

TemplateStorage.listFiles(ServiceTemplate, String)

listFiles

@Nullable
default @Nullable FileInfo[] listFiles()
                                throws java.io.IOException

Throws:

java.io.IOException

See Also:

TemplateStorage.listFiles(ServiceTemplate)

deployAsync

@NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean> deployAsync(@NotNull
                                                                                    @NotNull java.nio.file.Path directory,
                                                                                    @Nullable
                                                                                    @Nullable java.util.function.Predicate<java.nio.file.Path> fileFilter)

See Also:

TemplateStorage.deployAsync(Path, ServiceTemplate, Predicate)

deployAsync

@NotNull
default @NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean> deployAsync(@NotNull
                                                                                            @NotNull java.nio.file.Path directory)

See Also:

TemplateStorage.deployAsync(Path, ServiceTemplate)

deployAsync

@NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean> deployAsync(@NotNull
                                                                                    @NotNull java.io.InputStream inputStream)

See Also:

TemplateStorage.deployAsync(InputStream, ServiceTemplate)

copyAsync

@NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean> copyAsync(@NotNull
                                                                                  @NotNull java.nio.file.Path directory)

See Also:

TemplateStorage.copyAsync(ServiceTemplate, Path)

asZipInputStreamAsync

@NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.util.zip.ZipInputStream> asZipInputStreamAsync()

See Also:

TemplateStorage.asZipInputStreamAsync(ServiceTemplate)

zipTemplateAsync

@NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.io.InputStream> zipTemplateAsync()

See Also:

TemplateStorage.zipTemplateAsync(ServiceTemplate)

deleteAsync

@NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean> deleteAsync()

See Also:

TemplateStorage.deleteAsync(ServiceTemplate)

createAsync

@NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean> createAsync()

See Also:

TemplateStorage.createAsync(ServiceTemplate)

existsAsync

@NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean> existsAsync()

See Also:

TemplateStorage.hasAsync(ServiceTemplate)

appendOutputStreamAsync

@NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.io.OutputStream> appendOutputStreamAsync(@NotNull
                                                                                                   @NotNull java.lang.String path)

See Also:

TemplateStorage.appendOutputStreamAsync(ServiceTemplate, String)

newOutputStreamAsync

@NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.io.OutputStream> newOutputStreamAsync(@NotNull
                                                                                                @NotNull java.lang.String path)

See Also:

TemplateStorage.newOutputStreamAsync(ServiceTemplate, String)

createFileAsync

@NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean> createFileAsync(@NotNull
                                                                                        @NotNull java.lang.String path)

See Also:

TemplateStorage.createFileAsync(ServiceTemplate, String)

createDirectoryAsync

@NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean> createDirectoryAsync(@NotNull
                                                                                             @NotNull java.lang.String path)

See Also:

TemplateStorage.createDirectoryAsync(ServiceTemplate, String)

hasFileAsync

@NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean> hasFileAsync(@NotNull
                                                                                     @NotNull java.lang.String path)

See Also:

TemplateStorage.hasFileAsync(ServiceTemplate, String)

deleteFileAsync

@NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Boolean> deleteFileAsync(@NotNull
                                                                                        @NotNull java.lang.String path)

See Also:

TemplateStorage.deleteFileAsync(ServiceTemplate, String)

newInputStreamAsync

@NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.io.InputStream> newInputStreamAsync(@NotNull
                                                                                              @NotNull java.lang.String path)

See Also:

TemplateStorage.newInputStreamAsync(ServiceTemplate, String)

getFileInfoAsync

@NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<FileInfo> getFileInfoAsync(@NotNull
                                                                                @NotNull java.lang.String path)

See Also:

TemplateStorage.getFileInfoAsync(ServiceTemplate, String)

listFilesAsync

@NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<FileInfo[]> listFilesAsync(@NotNull
                                                                                @NotNull java.lang.String dir,
                                                                                boolean deep)

See Also:

TemplateStorage.listFilesAsync(ServiceTemplate, String, boolean)

listFilesAsync

@NotNull
default @NotNull de.dytanic.cloudnet.common.concurrent.ITask<FileInfo[]> listFilesAsync(boolean deep)

See Also:

TemplateStorage.listFilesAsync(ServiceTemplate, boolean)

listFilesAsync

@NotNull
default @NotNull de.dytanic.cloudnet.common.concurrent.ITask<FileInfo[]> listFilesAsync(@NotNull
                                                                                        @NotNull java.lang.String dir)

See Also:

TemplateStorage.listFilesAsync(ServiceTemplate, String)

listFilesAsync

@NotNull
default @NotNull de.dytanic.cloudnet.common.concurrent.ITask<FileInfo[]> listFilesAsync()

See Also:

TemplateStorage.listFilesAsync(ServiceTemplate)