|
Forge - Shell API 1.2.0.Final | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
Plugin or a command running with Shell.execute(String) are aborted.Dependency to this Project's immediate list of dependencies.
Dependency to this Project's immediate list of managed dependencies.
ProjectDependency to this Project's immediate list of managed dependencies.
DependencyFacet.KnownRepository to the project build system.
Alias is used when naming a Plugin or a Facet, but it can also be used for
custom implementations when combined with the ConstraintInspector.getName(Class).Alias annotation for performing bean lookups with BeanManagerFacet abstract class.Project implementations.JavaResource whether it exists or not.
JavaResource whether it exists or not.
DependencyFilter implementation for handling multiple filters.Facets or PackagingTypesRequiresProject or RequiresFacet)
are satisfied by the current project (if available) and Shell.getCurrentResource() scope.
DirectoryResource contains a project.
DependencyBuilder instance.
ProjectBuilder instance.
Resource instance for the target file.
ResourceFacet.getResourceFolder() - create a
file containing the given bytes.
ResourceFacet.getTestResourceFolder() -
create a file containing the given bytes.
WebResourceFacet.getWebRootDirectory() - create a
FileResource containing the given bytes.
WebResourceFacet.getWebRootDirectory() - create a
FileResource containing the given String.
Inject the current working Resource, e.g:
@Inject @Current JavaResource resource;
Will inject the current resource if and only if it is a Java Resource; otherwise, the injected value will be null.Command as the plugin default.Resource, and all child resources.
Resource is deleted, and the Resource object implements this interface, the methods of this
interface will be called.Dependency objects.Dependency objects in collections.DependencyBuilder for Dependency creation & instantiation.Dependency into the current project.Dependency including its dependency chain, configured
DependencyRepository instances, and any managed dependency version information.DependencyQuery objectDependencyQueryBuilder#create() instead.
Dependency versions, DependencyResource artifacts, and dependencies of a given
DependencyInputStream has been reached.Resource exists, return false if not.
Plugin types may rely for a set of
domain-specific operations.Facets through CDI.Shell.getCurrentResource()
scope or constraints.
Dependency.
Package for this project, returned as a String
Package for this project, returned as a directory File
BigDecimal associated with the given configuration key.
BigDecimal associated with the given configuration key.
BigInteger associated with the given configuration key.
BigInteger associated with the given configuration key.
Boolean associated with the given configuration key.
Byte associated with the given configuration key.
DirectoryResource.
Dependency
Resource scopes.
Resource scope, if it exists in this plugin.
Shell.getCurrentResource() scope.
Shell.getCurrentResource() scope, return a list of all available commands defined by this plugin.
Class for any dependencies to PackagingType types.
CommandCompleter for this option.
Project on which this shell instance is currently operating.
Resource of the shell.
Resource on which the Shell is currently operating.
Dependency for which this DependencyMetadata was retrieved.
Dependency objects
Dependency objects
Dependencies contained within this project.
Project's dependencies of the given ScopeType..
Dependency for which this DependencyMetadata was retrieved.
Dependency, if it exists in the Project direct dependency list, and
return it.
Double associated with the given configuration key.
Dependencies contained anywhere within this project's dependency
hierarchy.
Project's dependencies of the given ScopeType, from anywhere in the dependency
hierarchy.
Dependency, if it exists anywhere in the Project dependency hierarchy,
and return it.
Project and returns a managed dependency matching the given Dependency at any level of
the project hierarchy; return null otherwise.
JavaEnum at the given path relative to JavaSourceFacet.getSourceFolder().
JavaEnum from its location on disk, relative to
JavaSourceFacet.getSourceFolder().
Dependency objects to be excluded from this Dependency's list of inclusions when it
is included in a project.
Facet type, or throw a FacetNotFoundException if no
Facet of that type is registered.
Class for any dependencies to Facet types.
Collection of the currently installed Facets.
Collection of the currently installed Facets matching the given type.
Facet types.
Float associated with the given configuration key.
Dependency.
Integer associated with the given configuration key.
JavaClass at the given path relative to JavaSourceFacet.getSourceFolder().
JavaClass from its location on disk, relative to
JavaSourceFacet.getSourceFolder().
Long associated with the given configuration key.
Dependency for which this DependencyMetadata was retrieved.
Dependencies contained within this project.
Dependency, if it exists in the Project, and return it.
Method that implements this command.
List of additional Resource instances.
Dependency
PackagingType of this Dependency, if the type is not one of the default supported types,
PackagingType.OTHER will be returned;
PluginMetadata containing this command.
CommandMetadata defining this option.
PluginMetadata for the given plugin name.
PluginMetadata instance representing the singular type that is in scope, and satisfied
by the current project constraints such as RequiresProject or RequiresFacet
Project from which this event was fired.
Project from which this event was fired.
Project instance on which this Facet operates.
File representing the root directory of this Project
PromptType for this option.
Properties associated with the given configuration key.
DependencyRepository instances used when building the Dependency, or any projects which
inherit from it, for which this DependencyMetadata was retrieved.
FileResource at the given path relative to ResourceFacet.getResourceFolder().
ResourceFactory with which this Resource was created.
DirectoryResource representing the folder this Project uses to store package-able,
non-source documents (such as configuration files.)
DirectoryResources representing the directories this project uses to contain Project
non-source documents (such as configuration files.)
InputStream represented by this Resource.
List of additional Resource instances.
Resource types for which this command is in scope, or available.
Resource scopes for which this plugin is available.
Configuration instance of the given ConfigurationScope type.
Dependency
ScopeType of this Dependency, if the type is not one of the default supported types,
ScopeType.OTHER will be returned;
Short associated with the given configuration key.
DirectoryResource this Project uses to store package-able source documents (such as .java
files.)
DirectoryResources this project uses to contain Project source documents (such as
.java files.)
Dependency
JavaClass at the given path relative to JavaSourceFacet.getTestSourceFolder().
JavaClass from its location on disk, relative to
JavaSourceFacet.getTestSourceFolder().
FileResource at the given path relative to ResourceFacet.getTestResourceFolder().
DirectoryResource representing the folder this Project uses to store test-scoped
non-source documents (such as configuration files.) Files in this directory will never be packaged or deployed
except when running Unit Tests.
DirectoryResource this Project uses to store test-scoped source documents (such as .java
files.) Files in this directory will never be packaged or deployed except when running Unit Tests.
Plugin class type for this PluginMetadata
Resource
Dependency.
FileResource relative to the project Web Root directory: WebResourceFacet.getWebRootDirectory()
DirectoryResources for the current project.
DirectoryResource containing resources to be deployed to
the web-root URL when the application is published.
Facets of the given types; otherwise, if any of the given facet types
is missing, return false.
Facets of the given types; otherwise, if any of the given facet types
is missing, return false.
Resource scope.
Shell.getCurrentResourceScope()
CommandCompleter.
Project contains a dependency matching the given Dependency; return false
otherwise.
Project contains a managed dependency matching the given Dependency; return
false otherwise.
Dependency exists anywhere in the project dependency hierarchy.
Project contains a managed dependency matching the given Dependency at any
level of the project hierarchy; return false otherwise.
OptionMetadata with the given name.
DependencyFacet.KnownRepository is already registered in this project's build system.
Plugin Facet or other type.Dependency with the default ScopeType.
Dependency with the default ScopeType, applying the given DependencyFilter.
Dependency with the given ScopeType.
Dependency with the given ScopeType and DependencyFilter.
Facet to be considered installed in the given Project.
Facet.
Facet into the current ProjectDependency with the default ScopeType.
Dependency with the default ScopeType, applying the given
DependencyFilter.
Dependency with the given ScopeType .
Dependency with the given ScopeType and DependencyFilter.
Plugin instance defined by the given PluginMetadata
Shell is currently set to accept prompt defaults automatically.
Resource scopes.
PluginMetadata
FileResource exists and is actually a directory, otherwise return false;
Shell is currently executing a plugin; otherwise, return false.
ResourceFlag is set.
Dependency is installed.
Facet is available for the given Project, false if otherwise.
PipeIn
PipeOut
PluginMetadata.hasSetupCommand() returns true, and it is available in the current scope.
ResourceFilter.
Project's PackagingType is changed.Plugin must implement this interface in order to be detected and installed at framework boot-time.Shell when it has successfully started up and is ready to accept user input.Shutdown command event.Bootstrap when it has successfully started weldShell.isVerbose() == true.
Shell.isVerbose() == true.
Project has changed.Project.ShellPrompt.promptCommon(String, PromptType), but will default to a given value if user input is empty.
Enum, first printing the given message, then returning user input
as a Enum.
Enum, first printing the given message, then returning user input
as a Enum.
ShellPrompt.promptRegex(String, String), but will default to a given value if user input is empty.
InputStream for data.
InputStream for input, masking keystrokes in the console with the given mask.
Facet to this Project's internal collection of installed facets.
KeyListener object that will defined behavior when a given key is received from the
Shell
Resource if it is actually a resource of the given type; if it is, return a new reference to the
resource as the given type, otherwise return null.
ProjectDependency from this facet's Project.
Facet from this Project's internal collection of installed facets.
Facet into the current ProjectDependency from this facet's Project.
DependencyRepository from the current project.
FileResource
FacetPackagingTypesProjectClass type for a dependency on an active project.
Resource type.DependencyResource artifacts matching the given query, searching in the default
repository.
DependencyResource artifacts matching the given query, searching in only the given
DependencyRepository.
DependencyResource artifacts matching the given query, searching in only the given list
of DependencyRepository instances.
Dependency with a populated groupId, versionId, and version range, identify the available
artifacts in all known repositories for this project.
DependencyRepository instances for this Project.
DependencyQuery, identify and resolve all matching Dependency results in
configured DependencyRepository instances for this Project.
DependencyResource dependencies for the given query, searching in the default repository.
DependencyResource dependencies for the given query, searching in only the given
DependencyRepository.
DependencyResource dependencies for the given query, searching in only the given list of
DependencyRepository instances.
DependencyMetadata for a given Dependency, searching the default repository.
DependencyMetadata for a given Dependency, searching only the given
DependencyRepository.
DependencyMetadata for a given Dependency, searching only the given
DependencyRepository instances.
DependencyResolver.resolveVersions(DependencyQuery)
DependencyResolver.resolveVersions(DependencyQuery)
DependencyResolver.resolveVersions(DependencyQuery)
Dependency versions matching the given query.
Dependency versions matching the given query, searching in the default repository.
Dependency versions matching the given query, searching in only the given
DependencyRepository.
Dependency versions matching the given query, searching in only the given list of
DependencyRepository instances.
Resource has been changed to a new
Resource.Resource has been created.Resource has been deleted.Resource APIResource instances during a given operation.Resource has been modified.Resource.JavaSourceFacet.getSourceFolder() - use information in the
given JavaEnum to determine the appropriate package; packages will be created if necessary.
JavaSourceFacet.getSourceFolder() - use information in the
given JavaSource to determine the appropriate package; packages will be created if necessary.
JavaSourceFacet.getTestSourceFolder() - use
information in the given JavaSource to determine the appropriate package; packages will be created if
necessary.
Shell to accept prompt defaults automatically.
FileResource to the given String
FileResource to the given character array.
Resource on which the shell should operate.
ResourceFlag.
Facet for operation on the given Project.
Command to be used when performing setup for a Plugin.Shutdown.Status.NORMAL
Shutdown.Status, now.
InterceptorBinding that disables STDOUT and STDERR during wrapped invocations.Resource has been created.Dependency object into its id representation, for
example: "groupId:artifactId:::version", "groupId:artifactId:packaging::version" or
"groupId:artifactId:packaging:classifier:version"
Dependency object into its string representation, for
example: "groupId:artifactId:version:scope:packaging"
String containing the contents of the given InputStream
Facet from its Project, and perform any necessary cleanup.
Facet from this Project's internal collection of installed facets.
ResourceFlag.
Resource scope
Facet containing APIs to interact with Java Web Projects
|
Forge - Shell API 1.2.0.Final | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||