A C D E F G H I M N O P R S T U V Y
All Classes All Packages

A

AbstractArchiver<C extends org.siouan.frontendgradleplugin.core.archivers.ArchiverContext,E extends org.siouan.frontendgradleplugin.core.archivers.ArchiveEntry> - Class in org.siouan.frontendgradleplugin.core.archivers

Base class of an archiver.

AbstractArchiver() - Constructor for class org.siouan.frontendgradleplugin.core.archivers.AbstractArchiver

AbstractPredefinedRunScriptTask - Class in org.siouan.frontendgradleplugin.tasks

This abstract class exposes the common I/O properties for ready-to-use tasks that run a frontend script.

AbstractRunScriptTask - Class in org.siouan.frontendgradleplugin.tasks

This abstract class provides the reusable logic to run a NPM/Yarn script.

apply(Project) - Method in class org.siouan.frontendgradleplugin.FrontendGradlePlugin

Archiver - Interface in org.siouan.frontendgradleplugin.core.archivers

Interface of a component capable to process archives.

ArchiverException - Exception in org.siouan.frontendgradleplugin.core.archivers

Exception thrown when an archiver fails.

ArchiverException(String) - Constructor for exception org.siouan.frontendgradleplugin.core.archivers.ArchiverException

Builds an exception with the given message.

ArchiverException(Throwable) - Constructor for exception org.siouan.frontendgradleplugin.core.archivers.ArchiverException

Builds an exception with the given cause.

ArchiverFactory - Interface in org.siouan.frontendgradleplugin.core.archivers

Interface of a component capable to build instances of archiver.

ArchiverFactoryImpl - Class in org.siouan.frontendgradleplugin.core.archivers

Factory that builds/provides archivers using an internal map based on filename extensions.

ArchiverFactoryImpl() - Constructor for class org.siouan.frontendgradleplugin.core.archivers.ArchiverFactoryImpl

ASSEMBLE_TASK_NAME - Static variable in class org.siouan.frontendgradleplugin.FrontendGradlePlugin

Name of the task that assembles the frontend.

AssembleTask - Class in org.siouan.frontendgradleplugin.tasks

This task assembles frontend artifacts.

AssembleTask() - Constructor for class org.siouan.frontendgradleplugin.tasks.AssembleTask

C

CHECK_TASK_NAME - Static variable in class org.siouan.frontendgradleplugin.FrontendGradlePlugin

Name of the task that checks the frontend.

CheckTask - Class in org.siouan.frontendgradleplugin.tasks

This task executes frontend tests.

CheckTask() - Constructor for class org.siouan.frontendgradleplugin.tasks.CheckTask

CLEAN_TASK_NAME - Static variable in class org.siouan.frontendgradleplugin.FrontendGradlePlugin

Name of the task that cleans the frontend.

CleanTask - Class in org.siouan.frontendgradleplugin.tasks

This task cleans frontend resources, using a custom script.

CleanTask() - Constructor for class org.siouan.frontendgradleplugin.tasks.CleanTask

copyFileTree(Path, Path) - Static method in class org.siouan.frontendgradleplugin.core.Utils

Copies a file at the given path, recursively if it is a directory.

D

DEFAULT_NODE_INSTALL_DIRNAME - Static variable in class org.siouan.frontendgradleplugin.FrontendGradlePlugin

Name of the task that installs a Node distribution.

DEFAULT_YARN_INSTALL_DIRNAME - Static variable in class org.siouan.frontendgradleplugin.FrontendGradlePlugin

Name of the task that installs a Yarn distribution.

deleteFileTree(Path, boolean) - Static method in class org.siouan.frontendgradleplugin.core.Utils

Deletes a file or a directory at the given path.

DistributionInstaller - Class in org.siouan.frontendgradleplugin.core

Component that downloads and installs a distribution.

DistributionInstaller(DistributionInstallerSettings) - Constructor for class org.siouan.frontendgradleplugin.core.DistributionInstaller

DistributionInstallerException - Exception in org.siouan.frontendgradleplugin.core

Exception thrown when a distribution installer fails.

DistributionInstallerException(Throwable) - Constructor for exception org.siouan.frontendgradleplugin.core.DistributionInstallerException

DistributionInstallerSettings - Class in org.siouan.frontendgradleplugin.core

Settings for the distribution installer.

DistributionInstallerSettings(Task, LogLevel, String, Path, DistributionUrlResolver, Downloader, DistributionValidator, ArchiverFactory, Path) - Constructor for class org.siouan.frontendgradleplugin.core.DistributionInstallerSettings

Builds an installer.

DistributionUrlResolverException - Exception in org.siouan.frontendgradleplugin.core

Exception thrown when the URL to download a distribution can not be resolved.

DistributionUrlResolverException(String) - Constructor for exception org.siouan.frontendgradleplugin.core.DistributionUrlResolverException

DistributionUrlResolverException(Throwable) - Constructor for exception org.siouan.frontendgradleplugin.core.DistributionUrlResolverException

DistributionValidatorException - Exception in org.siouan.frontendgradleplugin.core

Exception thrown when a downloaded distribution is invalid.

DistributionValidatorException(String) - Constructor for exception org.siouan.frontendgradleplugin.core.DistributionValidatorException

DistributionValidatorException(Throwable) - Constructor for exception org.siouan.frontendgradleplugin.core.DistributionValidatorException

download(URL, Path) - Method in class org.siouan.frontendgradleplugin.core.DownloaderImpl

DownloaderImpl - Class in org.siouan.frontendgradleplugin.core

Class providing download utilities with efficient behavior and low impact on memory.

DownloaderImpl(Path) - Constructor for class org.siouan.frontendgradleplugin.core.DownloaderImpl

Builds a downloader using the given directory as a temporary directory.

E

ExecutableNotFoundException - Exception in org.siouan.frontendgradleplugin.core

Exception thrown when an executable cannot be found.

execute() - Method in class org.siouan.frontendgradleplugin.tasks.AbstractRunScriptTask

Executes the task.

execute() - Method in class org.siouan.frontendgradleplugin.tasks.NodeInstallTask

Executes the task: downloads and installs the distribution.

execute() - Method in class org.siouan.frontendgradleplugin.tasks.YarnInstallTask

Executes the task: downloads and installs the distribution.

execute(String) - Method in class org.siouan.frontendgradleplugin.core.StringSplitter

Splits the given argument.

Executor - Enum in org.siouan.frontendgradleplugin.core

Enumeration of types of execution supported by the plugin.

explode(ExplodeSettings) - Method in class org.siouan.frontendgradleplugin.core.archivers.AbstractArchiver

explode(ExplodeSettings) - Method in interface org.siouan.frontendgradleplugin.core.archivers.Archiver

Explodes an archive into a target directory.

ExplodeSettings - Class in org.siouan.frontendgradleplugin.core

Settings for an archive exploder.

ExplodeSettings(Path, Path, String) - Constructor for class org.siouan.frontendgradleplugin.core.ExplodeSettings

Builds settings to explode an archive.

F

FileHasherImpl - Class in org.siouan.frontendgradleplugin.core

This class resolves the hash of a file, using the SHA-256 algorithm, and an internal buffer of 8 KB.

FileHasherImpl() - Constructor for class org.siouan.frontendgradleplugin.core.FileHasherImpl

Builds a hasher using the SHA-256 algorithm.

FrontendException - Exception in org.siouan.frontendgradleplugin.core

Base exception class for checked exceptions thrown by the plugin.

FrontendException() - Constructor for exception org.siouan.frontendgradleplugin.core.FrontendException

FrontendException(String) - Constructor for exception org.siouan.frontendgradleplugin.core.FrontendException

FrontendException(String, Throwable) - Constructor for exception org.siouan.frontendgradleplugin.core.FrontendException

FrontendException(Throwable) - Constructor for exception org.siouan.frontendgradleplugin.core.FrontendException

FrontendExtension - Class in org.siouan.frontendgradleplugin

Extension providing configuration properties for frontend tasks.

FrontendExtension(Project) - Constructor for class org.siouan.frontendgradleplugin.FrontendExtension

FrontendGradlePlugin - Class in org.siouan.frontendgradleplugin

Main plugin class that bootstraps the plugin by declaring its DSL and its tasks.

FrontendGradlePlugin() - Constructor for class org.siouan.frontendgradleplugin.FrontendGradlePlugin

G

get(String) - Method in interface org.siouan.frontendgradleplugin.core.archivers.ArchiverFactory

Gets an archiver capable to process the given file extension.

get(String) - Method in class org.siouan.frontendgradleplugin.core.archivers.ArchiverFactoryImpl

getArchiveFile() - Method in class org.siouan.frontendgradleplugin.core.ExplodeSettings

getArchiverFactory() - Method in class org.siouan.frontendgradleplugin.core.DistributionInstallerSettings

Gets the archiver factory.

getAssembleScript() - Method in class org.siouan.frontendgradleplugin.FrontendExtension

getAssembleScript() - Method in class org.siouan.frontendgradleplugin.tasks.AssembleTask

getCheckScript() - Method in class org.siouan.frontendgradleplugin.FrontendExtension

getCheckScript() - Method in class org.siouan.frontendgradleplugin.tasks.CheckTask

getCleanScript() - Method in class org.siouan.frontendgradleplugin.FrontendExtension

getCleanScript() - Method in class org.siouan.frontendgradleplugin.tasks.CleanTask

getDownloader() - Method in class org.siouan.frontendgradleplugin.core.DistributionInstallerSettings

Gest the downloader.

getExecutionType() - Method in class org.siouan.frontendgradleplugin.tasks.AbstractRunScriptTask

getExecutionType() - Method in class org.siouan.frontendgradleplugin.tasks.RunNodeTask

getExtension(String) - Static method in class org.siouan.frontendgradleplugin.core.Utils

Gets the extension of a file.

getInstallDirectory() - Method in class org.siouan.frontendgradleplugin.core.DistributionInstallerSettings

Gets the install directory.

getInstallScript() - Method in class org.siouan.frontendgradleplugin.FrontendExtension

getInstallScript() - Method in class org.siouan.frontendgradleplugin.tasks.InstallTask

getLoggingLevel() - Method in class org.siouan.frontendgradleplugin.core.DistributionInstallerSettings

Gets the default logging level.

getLoggingLevel() - Method in class org.siouan.frontendgradleplugin.FrontendExtension

getLoggingLevel() - Method in class org.siouan.frontendgradleplugin.tasks.AbstractRunScriptTask

getLoggingLevel() - Method in class org.siouan.frontendgradleplugin.tasks.NodeInstallTask

getLoggingLevel() - Method in class org.siouan.frontendgradleplugin.tasks.YarnInstallTask

getNodeDistributionUrl() - Method in class org.siouan.frontendgradleplugin.FrontendExtension

getNodeDistributionUrl() - Method in class org.siouan.frontendgradleplugin.tasks.NodeInstallTask

getNodeExecutablePath(Path, String) - Static method in class org.siouan.frontendgradleplugin.core.Utils

Gets the path of the Node executable.

getNodeInstallDirectory() - Method in class org.siouan.frontendgradleplugin.FrontendExtension

getNodeInstallDirectory() - Method in class org.siouan.frontendgradleplugin.tasks.AbstractRunScriptTask

getNodeInstallDirectory() - Method in class org.siouan.frontendgradleplugin.tasks.NodeInstallTask

getNodeVersion() - Method in class org.siouan.frontendgradleplugin.FrontendExtension

getNodeVersion() - Method in class org.siouan.frontendgradleplugin.tasks.NodeInstallTask

getNpmExecutablePath(Path, String) - Static method in class org.siouan.frontendgradleplugin.core.Utils

Gets the path of the NPM executable.

getOsName() - Method in class org.siouan.frontendgradleplugin.core.DistributionInstallerSettings

Gets the underlying O/S name.

getOsName() - Method in class org.siouan.frontendgradleplugin.core.ExplodeSettings

getPackageJsonDirectory() - Method in class org.siouan.frontendgradleplugin.FrontendExtension

getPackageJsonDirectory() - Method in class org.siouan.frontendgradleplugin.tasks.AbstractRunScriptTask

getPublishScript() - Method in class org.siouan.frontendgradleplugin.FrontendExtension

getPublishScript() - Method in class org.siouan.frontendgradleplugin.tasks.PublishTask

getScript() - Method in class org.siouan.frontendgradleplugin.tasks.RunNodeTask

getScript() - Method in class org.siouan.frontendgradleplugin.tasks.RunScriptTask

getSystemJvmArch() - Static method in class org.siouan.frontendgradleplugin.core.Utils

Gets the current JVM architecture.

getSystemOsName() - Static method in class org.siouan.frontendgradleplugin.core.Utils

Gets the current O/S name.

getTargetDirectory() - Method in class org.siouan.frontendgradleplugin.core.ExplodeSettings

getTask() - Method in class org.siouan.frontendgradleplugin.core.DistributionInstallerSettings

Gets the related task.

getTemporaryDirectory() - Method in class org.siouan.frontendgradleplugin.core.DistributionInstallerSettings

getUrlResolver() - Method in class org.siouan.frontendgradleplugin.core.DistributionInstallerSettings

Gets the resolver of the distribution URL.

getValidator() - Method in class org.siouan.frontendgradleplugin.core.DistributionInstallerSettings

Gets the distribution validator.

getYarnDistributionUrl() - Method in class org.siouan.frontendgradleplugin.FrontendExtension

getYarnDistributionUrl() - Method in class org.siouan.frontendgradleplugin.tasks.YarnInstallTask

getYarnEnabled() - Method in class org.siouan.frontendgradleplugin.FrontendExtension

getYarnEnabled() - Method in class org.siouan.frontendgradleplugin.tasks.AbstractPredefinedRunScriptTask

getYarnExecutablePath(Path, String) - Static method in class org.siouan.frontendgradleplugin.core.Utils

Gets the path of Yarn executable.

getYarnInstallDirectory() - Method in class org.siouan.frontendgradleplugin.FrontendExtension

getYarnInstallDirectory() - Method in class org.siouan.frontendgradleplugin.tasks.AbstractRunScriptTask

getYarnInstallDirectory() - Method in class org.siouan.frontendgradleplugin.tasks.YarnInstallTask

getYarnVersion() - Method in class org.siouan.frontendgradleplugin.FrontendExtension

getYarnVersion() - Method in class org.siouan.frontendgradleplugin.tasks.YarnInstallTask

GRADLE_ASSEMBLE_TASK_NAME - Static variable in class org.siouan.frontendgradleplugin.FrontendGradlePlugin

GRADLE_CHECK_TASK_NAME - Static variable in class org.siouan.frontendgradleplugin.FrontendGradlePlugin

GRADLE_CLEAN_TASK_NAME - Static variable in class org.siouan.frontendgradleplugin.FrontendGradlePlugin

H

hash(Path) - Method in class org.siouan.frontendgradleplugin.core.FileHasherImpl

I

install() - Method in class org.siouan.frontendgradleplugin.core.DistributionInstaller

Installs a distribution: Empty the install directory. Resolve the URL to download the distribution. Download the distribution. Validate the downloaded distribution. Explode the distribution archive. Delete the distribution archive and all unnecessary files.

INSTALL_TASK_NAME - Static variable in class org.siouan.frontendgradleplugin.FrontendGradlePlugin

Name of the task that installs frontend dependencies.

InstallTask - Class in org.siouan.frontendgradleplugin.tasks

This task installs frontend environment (by executing a npm/yarn command).

InstallTask() - Constructor for class org.siouan.frontendgradleplugin.tasks.InstallTask

is64BitsArch(String) - Static method in class org.siouan.frontendgradleplugin.core.Utils

Tells whether the given JRE architecture is a 64 bits one.

isGzipExtension(String) - Static method in class org.siouan.frontendgradleplugin.core.Utils

Tells whether a file name extension is related to a GZIP file.

isLinuxOs(String) - Static method in class org.siouan.frontendgradleplugin.core.Utils

Tells whether the given OS name matches a Linux OS.

isMacOs(String) - Static method in class org.siouan.frontendgradleplugin.core.Utils

Tells whether the given OS name matches a Mac OS.

isWindowsOs(String) - Static method in class org.siouan.frontendgradleplugin.core.Utils

Tells whether the given OS name matches a Windows OS.

M

MAVEN_GENERAL_PUBLISH_TASK_NAME - Static variable in class org.siouan.frontendgradleplugin.FrontendGradlePlugin

MissingScriptException - Exception in org.siouan.frontendgradleplugin.core

Exception thrown when no script was provided.

MissingScriptException() - Constructor for exception org.siouan.frontendgradleplugin.core.MissingScriptException

moveFileTree(Path, Path) - Static method in class org.siouan.frontendgradleplugin.core.Utils

Moves all files/directories from a source directory into a destination directory.

N

newNodeExecutableNotFoundException() - Static method in exception org.siouan.frontendgradleplugin.core.ExecutableNotFoundException

Builds the appropriate exception when the Node executable cannot be found.

newNpmExecutableNotFoundException() - Static method in exception org.siouan.frontendgradleplugin.core.ExecutableNotFoundException

Builds the appropriate exception when the NPM executable cannot be found.

newYarnExecutableNotFoundException() - Static method in exception org.siouan.frontendgradleplugin.core.ExecutableNotFoundException

Builds the appropriate exception when the Yarn executable cannot be found.

NODE - org.siouan.frontendgradleplugin.core.Executor

NODE - Static variable in exception org.siouan.frontendgradleplugin.core.ExecutableNotFoundException

NODE_INSTALL_TASK_NAME - Static variable in class org.siouan.frontendgradleplugin.FrontendGradlePlugin

Name of the task that installs a Node distribution.

NodeDistributionChecksumReaderImpl - Class in org.siouan.frontendgradleplugin.core

This reader allows to extract the checksum of a distribution file in a Node's file providing all checksums for a given Node version.

NodeDistributionChecksumReaderImpl() - Constructor for class org.siouan.frontendgradleplugin.core.NodeDistributionChecksumReaderImpl

NodeDistributionUrlResolver - Class in org.siouan.frontendgradleplugin.core

Resolves the name of a distribution supported by the underlying OS and JRE.

NodeDistributionUrlResolver(String, String) - Constructor for class org.siouan.frontendgradleplugin.core.NodeDistributionUrlResolver

Builds a resolver using the local platform characteristics to determine the appropriate distro (Windows, Linux, i86, x64 compliant...).

NodeDistributionUrlResolver(String, String, String, String) - Constructor for class org.siouan.frontendgradleplugin.core.NodeDistributionUrlResolver

Builds a resolver using the local platform characteristics to determine the appropriate distro (Windows, Linux, i86, x64 compliant...).

NodeDistributionValidator - Class in org.siouan.frontendgradleplugin.core

Validates a Node distribution by comparing its SHA-256 hash against the one officially published.

NodeDistributionValidator(Task, LogLevel, Downloader, NodeDistributionChecksumReader, FileHasher, Path) - Constructor for class org.siouan.frontendgradleplugin.core.NodeDistributionValidator

Builds a validator of a Node distribution.

NodeInstallTask - Class in org.siouan.frontendgradleplugin.tasks

Task that downloads and installs a Node distribution.

NodeInstallTask() - Constructor for class org.siouan.frontendgradleplugin.tasks.NodeInstallTask

NPM - org.siouan.frontendgradleplugin.core.Executor

NPM - Static variable in exception org.siouan.frontendgradleplugin.core.ExecutableNotFoundException

O

org.siouan.frontendgradleplugin - package org.siouan.frontendgradleplugin

Provides the plugin's DSL and entry-point.

org.siouan.frontendgradleplugin.core - package org.siouan.frontendgradleplugin.core

Provides Gradle-independent core components.

org.siouan.frontendgradleplugin.core.archivers - package org.siouan.frontendgradleplugin.core.archivers

Provides archiving components.

org.siouan.frontendgradleplugin.tasks - package org.siouan.frontendgradleplugin.tasks

Provides the plugin's tasks.

P

PUBLISH_TASK_NAME - Static variable in class org.siouan.frontendgradleplugin.FrontendGradlePlugin

Name of the task that publishes the frontend.

PublishTask - Class in org.siouan.frontendgradleplugin.tasks

This task publishes frontend artifacts.

PublishTask() - Constructor for class org.siouan.frontendgradleplugin.tasks.PublishTask

R

readHash(Path, String) - Method in class org.siouan.frontendgradleplugin.core.NodeDistributionChecksumReaderImpl

removeExtension(String) - Static method in class org.siouan.frontendgradleplugin.core.Utils

Removes the extension of a filename.

resolve() - Method in class org.siouan.frontendgradleplugin.core.NodeDistributionUrlResolver

resolve() - Method in class org.siouan.frontendgradleplugin.core.YarnDistributionUrlResolver

run() - Method in class org.siouan.frontendgradleplugin.core.RunScriptJob

RunNodeTask - Class in org.siouan.frontendgradleplugin.tasks

Task provided as a type to let developers implement custom task based on it.

RunNodeTask() - Constructor for class org.siouan.frontendgradleplugin.tasks.RunNodeTask

RunScriptJob - Class in org.siouan.frontendgradleplugin.core

This abstract class provides the reusable logic to run a NPM/Yarn script.

RunScriptJob(Task, LogLevel, Path, Executor, Path, Path, String, String) - Constructor for class org.siouan.frontendgradleplugin.core.RunScriptJob

Builds a job to run a script.

RunScriptTask - Class in org.siouan.frontendgradleplugin.tasks

Task provided as a type to let developers implement custom task based on it.

RunScriptTask() - Constructor for class org.siouan.frontendgradleplugin.tasks.RunScriptTask

S

setFileExecutable(Path, String) - Static method in class org.siouan.frontendgradleplugin.core.Utils

Marks the file as executable.

setFileExecutable(Path, Set<PosixFilePermission>, String) - Static method in class org.siouan.frontendgradleplugin.core.Utils

Marks the file as executable.

SlipAttackException - Exception in org.siouan.frontendgradleplugin.core.archivers

Exception thrown when an archive contains an entry that would cause writing out of the target directory (e.g

SlipAttackException(String) - Constructor for exception org.siouan.frontendgradleplugin.core.archivers.SlipAttackException

Builds an exception with the given entry name.

StringSplitter - Class in org.siouan.frontendgradleplugin.core

A splitter of strings.

StringSplitter(char, char) - Constructor for class org.siouan.frontendgradleplugin.core.StringSplitter

Builds a string splitter.

T

toHexadecimalString(byte[]) - Static method in class org.siouan.frontendgradleplugin.core.Utils

Converts a binary buffer into an hexadecimal string, with a lower case.

U

UnsupportedEntryException - Exception in org.siouan.frontendgradleplugin.core.archivers

Exception thrown when an archive contains an entry that cannot be extracted by an archiver.

UnsupportedEntryException(String) - Constructor for exception org.siouan.frontendgradleplugin.core.archivers.UnsupportedEntryException

Builds an exception for the given entry.

Utils - Class in org.siouan.frontendgradleplugin.core

This class provides utilities for the whole plugin.

V

validate(URL, Path) - Method in class org.siouan.frontendgradleplugin.core.NodeDistributionValidator

valueOf(String) - Static method in enum org.siouan.frontendgradleplugin.core.Executor

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.siouan.frontendgradleplugin.core.Executor

Returns an array containing the constants of this enum type, in the order they are declared.

Y

YARN - org.siouan.frontendgradleplugin.core.Executor

YARN - Static variable in exception org.siouan.frontendgradleplugin.core.ExecutableNotFoundException

YARN_INSTALL_TASK_NAME - Static variable in class org.siouan.frontendgradleplugin.FrontendGradlePlugin

Name of the task that installs a Yarn distribution.

YarnDistributionUrlResolver - Class in org.siouan.frontendgradleplugin.core

Resolves the name of a distribution supported by the underlying OS and JRE.

YarnDistributionUrlResolver(String, String) - Constructor for class org.siouan.frontendgradleplugin.core.YarnDistributionUrlResolver

Builds a resolver for the local platform.

YarnInstallTask - Class in org.siouan.frontendgradleplugin.tasks

Task that downloads and installs a Yarn distribution.

YarnInstallTask() - Constructor for class org.siouan.frontendgradleplugin.tasks.YarnInstallTask

A C D E F G H I M N O P R S T U V Y
All Classes All Packages