A B C D E F G H I J K L M N O P Q R S T U V W

A

AbortedException - Exception in org.jboss.forge.shell.exceptions

Thrown when one of a running Plugin or a command running with Shell.execute(String) are aborted.

AbortedException() - Constructor for exception org.jboss.forge.shell.exceptions.AbortedException

AbortedException(String, Throwable) - Constructor for exception org.jboss.forge.shell.exceptions.AbortedException

AbortedException(String) - Constructor for exception org.jboss.forge.shell.exceptions.AbortedException

AbortedException(Throwable) - Constructor for exception org.jboss.forge.shell.exceptions.AbortedException

AbstractResource<T> - Class in org.jboss.forge.resources

AbstractResource(ResourceFactory, Resource<?>) - Constructor for class org.jboss.forge.resources.AbstractResource

accept(Dependency) - Method in class org.jboss.forge.project.dependencies.CompositeDependencyFilter

Tests each filter if it matches the dependency informed.

accept(Dependency) - Method in interface org.jboss.forge.project.dependencies.DependencyFilter

Return true if the filter accepts this dependency, or false if the dependency should be filtered out.

accept(Dependency) - Method in class org.jboss.forge.project.dependencies.NonSnapshotDependencyFilter

accept(Resource<?>) - Method in interface org.jboss.forge.resources.ResourceFilter

addArguments(String...) - Method in interface org.jboss.forge.project.build.ProjectBuilder

Manually add an argument to be passed to the underlying build system.

addDirectDependency(Dependency) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Add the given Dependency to this Project's immediate list of dependencies.

addDirectManagedDependency(Dependency) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Add the given managed Dependency to this Project's immediate list of managed dependencies.

AddedDependencies - Class in org.jboss.forge.project.dependencies.events

Fired when dependencies are added to the current Project

AddedDependencies(Project, Dependency...) - Constructor for class org.jboss.forge.project.dependencies.events.AddedDependencies

AddedDependencies(Project, List<Dependency>) - Constructor for class org.jboss.forge.project.dependencies.events.AddedDependencies

addExclusion() - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

addExclusion() - Method in class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

addManagedDependency(Dependency) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Add the given managed Dependency to this Project's immediate list of managed dependencies.

addPlugin(PluginMetadata) - Method in interface org.jboss.forge.shell.command.PluginRegistry

Add a plugin to the registry.

addProperty(String, Object) - Method in interface org.jboss.forge.env.Configuration

Add a property to the configuration.

addRepository(DependencyFacet.KnownRepository) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Add a DependencyFacet.KnownRepository to the project build system.

addRepository(String, String) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Add a repository to the project build system.

Alias - Annotation Type in org.jboss.forge.shell.plugins

Most commonly, 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).

AliasLiteral - Class in org.jboss.forge.shell.plugins

Used to create instances of the Alias annotation for performing bean lookups with BeanManager

AliasLiteral(String) - Constructor for class org.jboss.forge.shell.plugins.AliasLiteral

areEquivalent(Dependency, Dependency) - Static method in class org.jboss.forge.project.dependencies.DependencyBuilder

Return true if the groupId and artifactId of the two given dependencies are equal.

associate(Project, DirectoryResource) - Method in interface org.jboss.forge.project.services.ProjectAssociationProvider

Create a parent-child association between the given Project and the given parent directory.

B

BaseFacet - Class in org.jboss.forge.project.facets

A base convenience Facet abstract class.

BaseFacet() - Constructor for class org.jboss.forge.project.facets.BaseFacet

BaseProject - Class in org.jboss.forge.project

Convenience base class for Project implementations.

BaseProject() - Constructor for class org.jboss.forge.project.BaseProject

BeanManagerUtils - Class in org.jboss.forge.shell.util

Warning: ***DO NOT USE THIS CLASS***

BeanManagerUtils() - Constructor for class org.jboss.forge.shell.util.BeanManagerUtils

bufferingMode() - Method in interface org.jboss.forge.shell.Shell

Place the shell output into buffering mode.

BufferManager - Interface in org.jboss.forge.shell.integration

A BufferManager is responsible for managing a shell buffer in Forge.

bufferOnlyMode() - Method in interface org.jboss.forge.shell.integration.BufferManager

Set the buffer into buffering-only mode.

bufferOnlyMode() - Method in enum org.jboss.forge.shell.integration.NoopBufferManager

build() - Method in interface org.jboss.forge.project.build.ProjectBuilder

Execute the build.

BuildException - Exception in org.jboss.forge.project.build

Represents an exception during project building.

BuildException() - Constructor for exception org.jboss.forge.project.build.BuildException

BuildException(String, Throwable) - Constructor for exception org.jboss.forge.project.build.BuildException

BuildException(String) - Constructor for exception org.jboss.forge.project.build.BuildException

BuildException(Throwable) - Constructor for exception org.jboss.forge.project.build.BuildException

C

calculateName(JavaResource) - Method in interface org.jboss.forge.project.facets.JavaSourceFacet

Return the class name for the given JavaResource whether it exists or not.

calculateOutputAttributes(List<String>, Shell, ColumnPrinter.OutputAttributes) - Method in class org.jboss.forge.shell.util.ColumnPrinter

calculateOutputAttributes(List<String>, Shell) - Method in class org.jboss.forge.shell.util.ColumnPrinter

calculatePackage(JavaResource) - Method in interface org.jboss.forge.project.facets.JavaSourceFacet

Return the package for the given JavaResource whether it exists or not.

canAssociate(Project, DirectoryResource) - Method in interface org.jboss.forge.project.services.ProjectAssociationProvider

Return true if this provide is capable of creating a parent-child association between the given Project and the given parent directory.

canonicalize(String) - Static method in class org.jboss.forge.shell.util.Files

Replace instances of internal tokens with actual file equivalents.

clear() - Method in interface org.jboss.forge.env.Configuration

Remove all properties from the configuration.

clear() - Method in interface org.jboss.forge.shell.Shell

Clear the console.

clearLine() - Method in interface org.jboss.forge.shell.Shell

Clear the current line of any text.

clearProperty(String) - Method in interface org.jboss.forge.env.Configuration

Remove a property from the configuration.

closeQuietly(Closeable) - Static method in class org.jboss.forge.shell.util.Streams

CLR_ANNOTATION - Static variable in class org.jboss.forge.shell.util.JavaColorizer

CLR_COMMENT - Static variable in class org.jboss.forge.shell.util.JavaColorizer

CLR_KEYWORD - Static variable in class org.jboss.forge.shell.util.JavaColorizer

CLR_STR_LITERAL - Static variable in class org.jboss.forge.shell.util.JavaColorizer

ColumnPrinter - Class in org.jboss.forge.shell.util

Displays output in Shell in columns

ColumnPrinter() - Constructor for class org.jboss.forge.shell.util.ColumnPrinter

ColumnPrinter.FormatCallback - Interface in org.jboss.forge.shell.util

ColumnPrinter.OutputAttributes - Class in org.jboss.forge.shell.util

ColumnPrinter.OutputAttributes(int, int) - Constructor for class org.jboss.forge.shell.util.ColumnPrinter.OutputAttributes

Command - Annotation Type in org.jboss.forge.shell.plugins

Represents a single command to be run on a Shell.

CommandCompleter - Interface in org.jboss.forge.shell.completer

Defines the interface for interacting with the Shell command completion functionality.

CommandCompleterState - Interface in org.jboss.forge.shell.completer

CommandExecuted - Class in org.jboss.forge.shell.events

Fired after a plugin/command has been executed and has finished processing.

CommandExecuted(CommandExecuted.Status, CommandMetadata, String, Object[], Map<Object, Object>) - Constructor for class org.jboss.forge.shell.events.CommandExecuted

CommandExecuted.Status - Enum in org.jboss.forge.shell.events

CommandInterceptor - Interface in org.jboss.forge.shell.spi

Allows the shell input stream to be intercepted, modified, or observed by extensions.

CommandMetadata - Interface in org.jboss.forge.shell.command

Defines a command.

CommandMissing - Class in org.jboss.forge.shell.events

Event fired when a command is missing

CommandMissing(String, Object[]) - Constructor for class org.jboss.forge.shell.events.CommandMissing

CommandScoped - Annotation Type in org.jboss.forge.shell.command

Declares a bean as being scoped to the current Command.

CommandVetoed - Class in org.jboss.forge.shell.events

Fired when a command is vetoed

CommandVetoed(CommandMetadata, Object[], String, Map<Object, Object>) - Constructor for class org.jboss.forge.shell.events.CommandVetoed

complete(CommandCompleterState) - Method in interface org.jboss.forge.shell.completer.CommandCompleter

complete(CommandCompleterState) - Method in class org.jboss.forge.shell.completer.NullCommandCompleter

complete(CommandCompleterState) - Method in class org.jboss.forge.shell.completer.SimpleTokenCompleter

CompositeDependencyFilter - Class in org.jboss.forge.project.dependencies

Composite DependencyFilter implementation for handling multiple filters.

CompositeDependencyFilter(DependencyFilter...) - Constructor for class org.jboss.forge.project.dependencies.CompositeDependencyFilter

CompositeDependencyFilter(Iterable<? extends DependencyFilter>) - Constructor for class org.jboss.forge.project.dependencies.CompositeDependencyFilter

Configuration - Interface in org.jboss.forge.env

ConfigurationException - Exception in org.jboss.forge.env

ConfigurationException() - Constructor for exception org.jboss.forge.env.ConfigurationException

ConfigurationException(String) - Constructor for exception org.jboss.forge.env.ConfigurationException

ConfigurationException(Throwable) - Constructor for exception org.jboss.forge.env.ConfigurationException

ConfigurationException(String, Throwable) - Constructor for exception org.jboss.forge.env.ConfigurationException

ConfigurationFacet - Class in org.jboss.forge.env

This facet allows easy access to the project-scoped Configuration object

ConfigurationFacet(ConfigurationFactory) - Constructor for class org.jboss.forge.env.ConfigurationFacet

ConfigurationFactory - Interface in org.jboss.forge.env

Creates Configuration objects for the requested scopes

ConfigurationScope - Enum in org.jboss.forge.env

ConstraintInspector - Class in org.jboss.forge.shell.util

Used to inspect types that may or may not depend on Facets or PackagingTypes

ConstraintInspector() - Constructor for class org.jboss.forge.shell.util.ConstraintInspector

constrantsSatisfied(Shell) - Method in interface org.jboss.forge.shell.command.PluginMetadata

Return true if all constraints defined on this plugin (such as RequiresProject or RequiresFacet) are satisfied by the current project (if available) and Shell.getCurrentResource() scope.

containsKey(String) - Method in interface org.jboss.forge.env.Configuration

Check if the configuration contains the specified key.

containsProject(DirectoryResource) - Method in interface org.jboss.forge.project.locator.ProjectLocator

Return true if the given DirectoryResource contains a project.

containsProject(DirectoryResource) - Method in class org.jboss.forge.project.services.ProjectFactory

An exception-safe method of determining whether a directory contains a project.

create() - Static method in class org.jboss.forge.project.dependencies.DependencyBuilder

Obtain a new DependencyBuilder instance.

create(Dependency) - Static method in class org.jboss.forge.project.dependencies.DependencyBuilder

create(String) - Static method in class org.jboss.forge.project.dependencies.DependencyBuilder

create(Dependency) - Static method in class org.jboss.forge.project.dependencies.DependencyQueryBuilder

create(DependencyBuilder) - Static method in class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

createBuilder() - Method in interface org.jboss.forge.project.facets.PackagingFacet

Return a new ProjectBuilder instance.

createFrom(File) - Method in class org.jboss.forge.resources.DependencyResource

createFrom(File) - Method in class org.jboss.forge.resources.DirectoryResource

createFrom(EnumConstant<JavaEnum>) - Method in class org.jboss.forge.resources.enumtype.EnumConstantResource

createFrom(File) - Method in class org.jboss.forge.resources.FileResource

Create a new Resource instance for the target file.

createFrom(Field<? extends JavaSource<?>>) - Method in class org.jboss.forge.resources.java.JavaFieldResource

createFrom(T) - Method in class org.jboss.forge.resources.java.JavaMemberResource

createFrom(Method) - Method in class org.jboss.forge.resources.java.JavaMethodResource

createFrom(File) - Method in class org.jboss.forge.resources.java.JavaResource

createFrom(File) - Method in class org.jboss.forge.resources.PropertiesFileResource

createFrom(T) - Method in interface org.jboss.forge.resources.Resource

Create a new resource instance for the target resource reference of the type that this current resource is.

createFrom(File) - Method in class org.jboss.forge.resources.UnknownFileResource

createFrom(URL) - Method in class org.jboss.forge.resources.URLResource

createFrom(T) - Method in class org.jboss.forge.resources.VirtualResource

createFromType(Class<T>, E) - Method in class org.jboss.forge.project.services.ResourceFactory

createNewFile() - Method in class org.jboss.forge.resources.FileResource

Create the file in the underlying resource system.

createProject(DirectoryResource) - Method in interface org.jboss.forge.project.locator.ProjectLocator

Attempt to locate a project root directory in the given folder.

createProject(DirectoryResource, Class<? extends Facet>...) - Method in class org.jboss.forge.project.services.ProjectFactory

createResource(char[], String) - Method in interface org.jboss.forge.project.facets.ResourceFacet

At the given path/filename relative to the project resources directory: ResourceFacet.getResourceFolder() - create a file containing the given bytes.

createTempResource() - Method in class org.jboss.forge.resources.DirectoryResource

createTempResource() - Method in class org.jboss.forge.resources.FileResource

createTestResource(char[], String) - Method in interface org.jboss.forge.project.facets.ResourceFacet

At the given path/filename relative to the project test resources directory: ResourceFacet.getTestResourceFolder() - create a file containing the given bytes.

createWebResource(char[], String) - Method in interface org.jboss.forge.project.facets.WebResourceFacet

At the given path/filename relative to the project Web Root directory: WebResourceFacet.getWebRootDirectory() - create a FileResource containing the given bytes.

createWebResource(String, String) - Method in interface org.jboss.forge.project.facets.WebResourceFacet

At the given path/filename relative to the project Web Root directory: WebResourceFacet.getWebRootDirectory() - create a FileResource containing the given String.

Current - Annotation Type in org.jboss.forge.shell.plugins

Used to @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.

cursorLeft(int) - Method in interface org.jboss.forge.shell.Shell

Move the cursor x the specified number of positions.

D

DefaultCommand - Annotation Type in org.jboss.forge.shell.plugins

Defines a @Command as the plugin default.

delete() - Method in class org.jboss.forge.resources.EntryResource

delete(boolean) - Method in class org.jboss.forge.resources.EntryResource

delete() - Method in class org.jboss.forge.resources.enumtype.EnumConstantResource

delete(boolean) - Method in class org.jboss.forge.resources.enumtype.EnumConstantResource

delete() - Method in class org.jboss.forge.resources.FileResource

Delete this file, non-recursively.

delete(boolean) - Method in class org.jboss.forge.resources.FileResource

Delete this Resource, and all child resources.

delete() - Method in class org.jboss.forge.resources.java.JavaFieldResource

delete(boolean) - Method in class org.jboss.forge.resources.java.JavaFieldResource

delete() - Method in class org.jboss.forge.resources.java.JavaMethodResource

delete(boolean) - Method in class org.jboss.forge.resources.java.JavaMethodResource

delete() - Method in interface org.jboss.forge.resources.Resource

Delete this resource, return true if successful, false if not.

delete(boolean) - Method in interface org.jboss.forge.resources.Resource

Delete this resource, return true if successful, false if not.

delete() - Method in class org.jboss.forge.resources.URLResource

delete(boolean) - Method in class org.jboss.forge.resources.URLResource

deleteOnExit() - Method in class org.jboss.forge.resources.FileResource

Requests that the file or directory denoted by this resource be deleted when the virtual machine terminates.

DeletionAware - Interface in org.jboss.forge.resources

If a Resource is deleted, and the Resource object implements this interface, the methods of this interface will be called.

Dependency - Interface in org.jboss.forge.project.dependencies

Represents a project library dependency.

DependencyBuilder - Class in org.jboss.forge.project.dependencies

Builder to create Dependency objects.

DependencyBuilder() - Constructor for class org.jboss.forge.project.dependencies.DependencyBuilder

DependencyFacet - Interface in org.jboss.forge.project.facets

DependencyFacet.KnownRepository - Enum in org.jboss.forge.project.facets

DependencyFilter - Interface in org.jboss.forge.project.dependencies

Used to filter Dependency objects in collections.

DependencyImpl - Class in org.jboss.forge.project.dependencies

This class is internal; instead use DependencyBuilder for Dependency creation & instantiation.

DependencyInstaller - Interface in org.jboss.forge.project.dependencies

Responsible for installing a given Dependency into the current project.

DependencyMetadata - Interface in org.jboss.forge.project.dependencies

Represents meta-information for a given Dependency including its dependency chain, configured DependencyRepository instances, and any managed dependency version information.

DependencyQuery - Interface in org.jboss.forge.project.dependencies

A parameter object which is used to search dependencies

DependencyQueryBuilder - Class in org.jboss.forge.project.dependencies

Builds a DependencyQuery object

DependencyQueryBuilder() - Constructor for class org.jboss.forge.project.dependencies.DependencyQueryBuilder

DependencyQueryBuilder(Dependency) - Constructor for class org.jboss.forge.project.dependencies.DependencyQueryBuilder

Deprecated.

Use DependencyQueryBuilder#create() instead.

DependencyRepository - Interface in org.jboss.forge.project.dependencies

DependencyRepositoryImpl - Class in org.jboss.forge.project.dependencies

DependencyRepositoryImpl(String, String) - Constructor for class org.jboss.forge.project.dependencies.DependencyRepositoryImpl

DependencyRepositoryImpl(DependencyFacet.KnownRepository) - Constructor for class org.jboss.forge.project.dependencies.DependencyRepositoryImpl

DependencyResolver - Class in org.jboss.forge.project.dependencies

DependencyResolver(Instance<DependencyResolverProvider>) - Constructor for class org.jboss.forge.project.dependencies.DependencyResolver

DependencyResolverProvider - Interface in org.jboss.forge.project.dependencies

Used to resolve Dependency versions, DependencyResource artifacts, and dependencies of a given Dependency

DependencyResource - Class in org.jboss.forge.resources

DependencyResource(ResourceFactory, File, Dependency) - Constructor for class org.jboss.forge.resources.DependencyResource

DirectoryResource - Class in org.jboss.forge.resources

A standard, build-in, resource for representing directories on the file-system.

DirectoryResource(ResourceFactory, File) - Constructor for class org.jboss.forge.resources.DirectoryResource

directWrite(String) - Method in interface org.jboss.forge.shell.integration.BufferManager

directWrite(String) - Method in enum org.jboss.forge.shell.integration.NoopBufferManager

directWriteMode() - Method in interface org.jboss.forge.shell.integration.BufferManager

Direct-write mode.

directWriteMode() - Method in enum org.jboss.forge.shell.integration.NoopBufferManager

directWriteMode() - Method in interface org.jboss.forge.shell.Shell

Place the shell output in direct-write mode.

doListResources() - Method in class org.jboss.forge.resources.AbstractResource

Strategy method for returning child resources.

doListResources() - Method in class org.jboss.forge.resources.DependencyResource

doListResources() - Method in class org.jboss.forge.resources.DirectoryResource

doListResources() - Method in class org.jboss.forge.resources.EntryResource

doListResources() - Method in class org.jboss.forge.resources.enumtype.EnumConstantResource

doListResources() - Method in class org.jboss.forge.resources.java.JavaFieldResource

doListResources() - Method in class org.jboss.forge.resources.java.JavaMemberResource

doListResources() - Method in class org.jboss.forge.resources.java.JavaMethodResource

doListResources() - Method in class org.jboss.forge.resources.java.JavaResource

doListResources() - Method in class org.jboss.forge.resources.PropertiesFileResource

doListResources() - Method in class org.jboss.forge.resources.UnknownFileResource

doListResources() - Method in class org.jboss.forge.resources.URLResource

E

EndOfStreamException - Exception in org.jboss.forge.shell.exceptions

Used to signal when the end of an InputStream has been reached.

EndOfStreamException() - Constructor for exception org.jboss.forge.shell.exceptions.EndOfStreamException

EndOfStreamException(String, Throwable) - Constructor for exception org.jboss.forge.shell.exceptions.EndOfStreamException

EndOfStreamException(String) - Constructor for exception org.jboss.forge.shell.exceptions.EndOfStreamException

EndOfStreamException(Throwable) - Constructor for exception org.jboss.forge.shell.exceptions.EndOfStreamException

EntryResource<K,V> - Class in org.jboss.forge.resources

Represents a Key-value entry

EntryResource(Resource<?>, K, V) - Constructor for class org.jboss.forge.resources.EntryResource

EnumConstantResource - Class in org.jboss.forge.resources.enumtype

EnumConstantResource(Resource<?>, EnumConstant<JavaEnum>) - Constructor for class org.jboss.forge.resources.enumtype.EnumConstantResource

equals(Object) - Method in class org.jboss.forge.project.BaseProject

equals(Object) - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

equals(Object) - Method in class org.jboss.forge.project.dependencies.DependencyImpl

equals(Object) - Method in class org.jboss.forge.project.dependencies.DependencyRepositoryImpl

equals(Object) - Method in class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

equals(Object) - Method in class org.jboss.forge.project.facets.BaseFacet

equals(Object) - Method in class org.jboss.forge.resources.AbstractResource

equals(Object) - Method in class org.jboss.forge.resources.DirectoryResource

equals(Object) - Method in class org.jboss.forge.resources.events.ResourceEvent

equals(Object) - Method in class org.jboss.forge.resources.events.ResourceRenamed

equals(Object) - Method in class org.jboss.forge.shell.PluginEntry

error(ShellPrintWriter, String) - Static method in class org.jboss.forge.shell.ShellMessages

ExcludedDependencyBuilder - Class in org.jboss.forge.project.dependencies

ExcludedDependencyBuilder(DependencyBuilder) - Constructor for class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

exec(boolean, String, String...) - Static method in class org.jboss.forge.shell.util.NativeSystemCall

Execute the given system command

execFromPath(String, String[], ShellPrintWriter, DirectoryResource) - Static method in class org.jboss.forge.shell.util.NativeSystemCall

Execute a native system command as if it were run from the given path.

execute(String) - Method in interface org.jboss.forge.shell.Shell

Execute a shell command.

execute(File) - Method in interface org.jboss.forge.shell.Shell

Execute a shell script from the specified file.

execute(File, String...) - Method in interface org.jboss.forge.shell.Shell

Execute a shell script from the specified file, passing the given arguments as input.

executeBuild(String...) - Method in interface org.jboss.forge.project.facets.PackagingFacet

Trigger the underlying build system to perform a build with the given arguments or flags.

executeProjectClass(String, String...) - Method in interface org.jboss.forge.project.facets.JavaExecutionFacet

exists() - Method in interface org.jboss.forge.project.Project

Return true if this project's file-system has been created and initialized; otherwise, return false.

exists() - Method in class org.jboss.forge.resources.FileResource

exists() - Method in interface org.jboss.forge.resources.Resource

Return true if this Resource exists, return false if not.

exists() - Method in class org.jboss.forge.resources.URLResource

exists() - Method in class org.jboss.forge.resources.VirtualResource

F

Facet - Interface in org.jboss.forge.project

Represents a standardized piece of a project on which certain Plugin types may rely for a set of domain-specific operations.

FacetActionAborted - Exception in org.jboss.forge.project.facets

Thrown when a user aborts installation of a given Facet.

FacetActionAborted() - Constructor for exception org.jboss.forge.project.facets.FacetActionAborted

FacetActionAborted(String, Throwable) - Constructor for exception org.jboss.forge.project.facets.FacetActionAborted

FacetActionAborted(String) - Constructor for exception org.jboss.forge.project.facets.FacetActionAborted

FacetActionAborted(Throwable) - Constructor for exception org.jboss.forge.project.facets.FacetActionAborted

FacetFactory - Class in org.jboss.forge.project.services

Responsible for instantiating Facets through CDI.

FacetFactory(FacetRegistry, BeanManager) - Constructor for class org.jboss.forge.project.services.FacetFactory

FacetInstalled - Class in org.jboss.forge.project.facets.events

Event fired when a Facet has been installed.

FacetInstalled(Facet) - Constructor for class org.jboss.forge.project.facets.events.FacetInstalled

FacetNotFoundException - Exception in org.jboss.forge.project.facets

An exception representing the state where a project facet was requested, but was not available.

FacetNotFoundException() - Constructor for exception org.jboss.forge.project.facets.FacetNotFoundException

FacetNotFoundException(String) - Constructor for exception org.jboss.forge.project.facets.FacetNotFoundException

FacetNotFoundException(Throwable) - Constructor for exception org.jboss.forge.project.facets.FacetNotFoundException

FacetNotFoundException(String, Throwable) - Constructor for exception org.jboss.forge.project.facets.FacetNotFoundException

FacetRegistry - Interface in org.jboss.forge.shell.project

FacetRemoved - Class in org.jboss.forge.project.facets.events

Fired when a Facet is removed from a project.

FacetRemoved(Facet) - Constructor for class org.jboss.forge.project.facets.events.FacetRemoved

file - Variable in class org.jboss.forge.resources.FileResource

FileResource<T extends FileResource<?>> - Class in org.jboss.forge.resources

A standard, built-in resource for representing files on the filesystem.

FileResource(ResourceFactory, File) - Constructor for class org.jboss.forge.resources.FileResource

Files - Class in org.jboss.forge.shell.util

Files() - Constructor for class org.jboss.forge.shell.util.Files

filter(ResourceFilter, Collection<E>) - Static method in class org.jboss.forge.shell.util.ResourceUtil

filterByType(Class<E>, I) - Static method in class org.jboss.forge.shell.util.ResourceUtil

findProject(DirectoryResource) - Method in class org.jboss.forge.project.services.ProjectFactory

findProjectRecursively(DirectoryResource) - Method in class org.jboss.forge.project.services.ProjectFactory

findProjectRootRecusively(DirectoryResource) - Method in class org.jboss.forge.project.services.ProjectFactory

flags - Variable in class org.jboss.forge.resources.AbstractResource

flush() - Method in interface org.jboss.forge.shell.ShellPrintWriter

Flush output.

flushBuffer() - Method in interface org.jboss.forge.shell.integration.BufferManager

Flush data to the lower-level buffer immediately.

flushBuffer() - Method in enum org.jboss.forge.shell.integration.NoopBufferManager

ForgeEnvironment - Interface in org.jboss.forge

format(int, String) - Method in interface org.jboss.forge.shell.util.ColumnPrinter.FormatCallback

format(ShellPrintWriter, String) - Static method in class org.jboss.forge.shell.util.JavaColorizer

Perform colorization of a Java source string.

from(String) - Static method in enum org.jboss.forge.project.dependencies.ScopeType

from(String) - Static method in enum org.jboss.forge.project.packaging.PackagingType

fromCoordinates(String) - Static method in class org.jboss.forge.shell.PluginEntry

fromFileSyntax(String) - Static method in class org.jboss.forge.shell.util.Packages

fromForgeConfiguration(Configuration) - Static method in class org.jboss.forge.shell.util.ProxySettings

fromHostAndPort(String, int) - Static method in class org.jboss.forge.shell.util.ProxySettings

fromHostPortAndCredentials(String, int, String, String) - Static method in class org.jboss.forge.shell.util.ProxySettings

fromString(String) - Static method in class org.jboss.forge.shell.util.Streams

G

getAbsoluteHeight() - Method in interface org.jboss.forge.shell.Shell

Return the absolute height of the console.

getAllCommands() - Method in interface org.jboss.forge.shell.command.PluginMetadata

Get a list of all commands defined by this plugin, regardless of the current Shell.getCurrentResource() scope or constraints.

getApiVersion() - Method in class org.jboss.forge.shell.PluginEntry

getArtifactId() - Method in interface org.jboss.forge.project.dependencies.Dependency

Get the minor-identifier for this Dependency.

getArtifactId() - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

getArtifactId() - Method in class org.jboss.forge.project.dependencies.DependencyImpl

getArtifactId() - Method in class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

getAttribute(String) - Method in class org.jboss.forge.project.BaseProject

getAttribute(String) - Method in interface org.jboss.forge.project.Project

Get an value from this project's internal attributes.

getBasePackage() - Method in interface org.jboss.forge.project.facets.JavaSourceFacet

Return the base Java Package for this project, returned as a String

getBasePackageResource() - Method in interface org.jboss.forge.project.facets.JavaSourceFacet

Return the base Java Package for this project, returned as a directory File

getBigDecimal(String) - Method in interface org.jboss.forge.env.Configuration

Get a BigDecimal associated with the given configuration key.

getBigDecimal(String, BigDecimal) - Method in interface org.jboss.forge.env.Configuration

Get a BigDecimal associated with the given configuration key.

getBigInteger(String) - Method in interface org.jboss.forge.env.Configuration

Get a BigInteger associated with the given configuration key.

getBigInteger(String, BigInteger) - Method in interface org.jboss.forge.env.Configuration

Get a BigInteger associated with the given configuration key.

getBoolean(String) - Method in interface org.jboss.forge.env.Configuration

Get a boolean associated with the given configuration key.

getBoolean(String, boolean) - Method in interface org.jboss.forge.env.Configuration

Get a boolean associated with the given configuration key.

getBoolean(String, Boolean) - Method in interface org.jboss.forge.env.Configuration

Get a Boolean associated with the given configuration key.

getBoxedType() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Return the boxed type for this option.

getBuffer() - Method in interface org.jboss.forge.shell.completer.CommandCompleterState

getBuffer() - Method in interface org.jboss.forge.shell.plugins.PipeOut

getBufferManager() - Method in interface org.jboss.forge.shell.Shell

Get buffer manager based on typed

getByte(String) - Method in interface org.jboss.forge.env.Configuration

Get a byte associated with the given configuration key.

getByte(String, byte) - Method in interface org.jboss.forge.env.Configuration

Get a byte associated with the given configuration key.

getByte(String, Byte) - Method in interface org.jboss.forge.env.Configuration

Get a Byte associated with the given configuration key.

getCandidates() - Method in interface org.jboss.forge.shell.completer.CommandCompleterState

getChild(String) - Method in class org.jboss.forge.resources.DirectoryResource

Obtain a reference to the child resource.

getChild(String) - Method in class org.jboss.forge.resources.FileResource

getChild(String) - Method in class org.jboss.forge.resources.java.JavaResource

getChild(String) - Method in interface org.jboss.forge.resources.Resource

Get a child of this resource.

getChild(String) - Method in class org.jboss.forge.resources.URLResource

getChild(String) - Method in class org.jboss.forge.resources.VirtualResource

getChildDirectory(String) - Method in class org.jboss.forge.resources.DirectoryResource

Obtain a reference to the child DirectoryResource.

getChildOfType(Class<T>, String) - Method in class org.jboss.forge.resources.DirectoryResource

Using the given type, obtain a reference to the child resource of the given type.

getClassifier() - Method in interface org.jboss.forge.project.dependencies.Dependency

Get the classifier for this Dependency

getClassifier() - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

getClassifier() - Method in class org.jboss.forge.project.dependencies.DependencyImpl

getClassifier() - Method in class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

getCommand(String) - Method in interface org.jboss.forge.shell.command.PluginMetadata

Get the command with the given name, if it exists in this plugin and is not overloaded in multiple Resource scopes.

getCommand(String, Class<? extends Resource<?>>) - Method in interface org.jboss.forge.shell.command.PluginMetadata

Get the command with the given name and Resource scope, if it exists in this plugin.

getCommand(String, Shell) - Method in interface org.jboss.forge.shell.command.PluginMetadata

Get the command with the given name if it exists in this plugin, and is available in the current Shell.getCurrentResource() scope.

getCommand() - Method in class org.jboss.forge.shell.events.CommandExecuted

getCommand() - Method in class org.jboss.forge.shell.events.CommandVetoed

getCommand() - Method in class org.jboss.forge.shell.events.PreCommandExecution

getCommands() - Method in interface org.jboss.forge.shell.command.PluginMetadata

Get a list of all commands defined by this plugin, if they are in scope.

getCommands(Shell) - Method in interface org.jboss.forge.shell.command.PluginMetadata

For the Shell.getCurrentResource() scope, return a list of all available commands defined by this plugin.

getCompatiblePackagingTypes(Class<?>) - Static method in class org.jboss.forge.shell.util.ConstraintInspector

Inspect the given Class for any dependencies to PackagingType types.

getCompleterType() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Return the type of the CommandCompleter for this option.

getCompletionTokens() - Method in class org.jboss.forge.shell.completer.PropertyCompleter

getCompletionTokens() - Method in class org.jboss.forge.shell.completer.SimpleTokenCompleter

Return a list of tokens to be considered as possible completions for the current input buffer.

getConfigDir() - Method in interface org.jboss.forge.shell.Shell

Return the file-system directory currently in use as the configuration directory.

getConfigDirectory() - Method in interface org.jboss.forge.ForgeEnvironment

Get the configuration directory.

getConfiguration() - Method in class org.jboss.forge.env.ConfigurationFacet

getContext() - Method in class org.jboss.forge.shell.events.CommandExecuted

getContext() - Method in class org.jboss.forge.shell.events.CommandVetoed

getContext() - Method in class org.jboss.forge.shell.events.PreCommandExecution

getContextDirectory(Resource<?>) - Static method in class org.jboss.forge.shell.util.ResourceUtil

getContextFile(Resource<?>) - Static method in class org.jboss.forge.shell.util.ResourceUtil

A simple utility method to locate the outermost contextual File reference for the specified resource.

getContextualInstance(BeanManager, Class<T>) - Static method in class org.jboss.forge.shell.util.BeanManagerUtils

getContextualInstance(BeanManager, Class<T>, Annotation...) - Static method in class org.jboss.forge.shell.util.BeanManagerUtils

getCurrentDirectory() - Method in interface org.jboss.forge.shell.Shell

Return the current working directory resource of the shell.

getCurrentProject() - Method in interface org.jboss.forge.shell.Shell

Return the Project on which this shell instance is currently operating.

getCurrentResource() - Method in interface org.jboss.forge.shell.Shell

Return the current working Resource of the shell.

getCurrentResourceScope() - Method in interface org.jboss.forge.shell.Shell

Return the type of the Resource on which the Shell is currently operating.

getDefaultCommand() - Method in interface org.jboss.forge.shell.command.PluginMetadata

Get the default command specified by this plugin.

getDefaultForgeDir() - Static method in class org.jboss.forge.shell.util.OSUtils

getDefaultForgePath() - Static method in class org.jboss.forge.shell.util.OSUtils

getDefaultValue() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Get the default value for this option.

getDependencies() - Method in interface org.jboss.forge.project.dependencies.DependencyMetadata

The direct dependencies of the Dependency for which this DependencyMetadata was retrieved.

getDependencies() - Method in class org.jboss.forge.project.dependencies.events.AddedDependencies

Return a list of all added Dependency objects

getDependencies() - Method in class org.jboss.forge.project.dependencies.events.RemovedDependencies

Return a list of all removed Dependency objects

getDependencies() - Method in interface org.jboss.forge.project.facets.DependencyFacet

Return an immutable list of all direct Dependencies contained within this project.

getDependenciesInScopes(ScopeType...) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Get a list of this Project's dependencies of the given ScopeType..

getDependency() - Method in interface org.jboss.forge.project.dependencies.DependencyMetadata

The Dependency for which this DependencyMetadata was retrieved.

getDependency() - Method in interface org.jboss.forge.project.dependencies.DependencyQuery

getDependency() - Method in class org.jboss.forge.project.dependencies.DependencyQueryBuilder

getDependency() - Method in class org.jboss.forge.resources.DependencyResource

getDependencyFilter() - Method in interface org.jboss.forge.project.dependencies.DependencyQuery

getDependencyFilter() - Method in class org.jboss.forge.project.dependencies.DependencyQueryBuilder

getDependencyRepositories() - Method in interface org.jboss.forge.project.dependencies.DependencyQuery

getDependencyRepositories() - Method in class org.jboss.forge.project.dependencies.DependencyQueryBuilder

getDescription() - Method in enum org.jboss.forge.project.packaging.PackagingType

getDescription() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Get the description text for this option.

getDirectDependency(Dependency) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Attempt to locate the given Dependency, if it exists in the Project direct dependency list, and return it.

getDouble(String) - Method in interface org.jboss.forge.env.Configuration

Get a double associated with the given configuration key.

getDouble(String, double) - Method in interface org.jboss.forge.env.Configuration

Get a double associated with the given configuration key.

getDouble(String, Double) - Method in interface org.jboss.forge.env.Configuration

Get a Double associated with the given configuration key.

getEffectiveDependencies() - Method in interface org.jboss.forge.project.facets.DependencyFacet

Return an immutable list of all Dependencies contained anywhere within this project's dependency hierarchy.

getEffectiveDependenciesInScopes(ScopeType...) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Get a list of this Project's dependencies of the given ScopeType, from anywhere in the dependency hierarchy.

getEffectiveDependency(Dependency) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Attempt to locate the given Dependency, if it exists anywhere in the Project dependency hierarchy, and return it.

getEffectiveManagedDependency(Dependency) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Searches Project and returns a managed dependency matching the given Dependency at any level of the project hierarchy; return null otherwise.

getEnumTypeResource(String) - Method in interface org.jboss.forge.project.facets.JavaSourceFacet

Deprecated.

Use JavaSourceFacet#getJavaResource(String instead

getEnumTypeResource(JavaEnum) - Method in interface org.jboss.forge.project.facets.JavaSourceFacet

Deprecated.

Use JavaSourceFacet.getJavaResource(JavaSource) instead

getEnvironment() - Method in interface org.jboss.forge.shell.Shell

Get the current Forge environment.

getExcludedDependencies() - Method in interface org.jboss.forge.project.dependencies.Dependency

Get a list of Dependency objects to be excluded from this Dependency's list of inclusions when it is included in a project.

getExcludedDependencies() - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

getExcludedDependencies() - Method in class org.jboss.forge.project.dependencies.DependencyImpl

getExcludedDependencies() - Method in class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

getFacet(Class<F>) - Method in class org.jboss.forge.project.BaseProject

getFacet() - Method in class org.jboss.forge.project.facets.events.FacetInstalled

getFacet() - Method in class org.jboss.forge.project.facets.events.FacetRemoved

getFacet(Class<F>) - Method in interface org.jboss.forge.project.Project

Return the instance of the requested Facet type, or throw a FacetNotFoundException if no Facet of that type is registered.

getFacet(Class<T>) - Method in class org.jboss.forge.project.services.FacetFactory

getFacetByName(String) - Method in class org.jboss.forge.project.services.FacetFactory

getFacetDependencies(Class<?>) - Static method in class org.jboss.forge.shell.util.ConstraintInspector

Inspect the given Class for any dependencies to Facet types.

getFacets() - Method in class org.jboss.forge.project.BaseProject

getFacets(Class<F>) - Method in class org.jboss.forge.project.BaseProject

getFacets() - Method in interface org.jboss.forge.project.Project

Return a Collection of the currently installed Facets.

getFacets(Class<F>) - Method in interface org.jboss.forge.project.Project

Return a Collection of the currently installed Facets matching the given type.

getFacets() - Method in class org.jboss.forge.project.services.FacetFactory

Deprecated.

Use #getFacetTypes() instead. This will be removed in a future release.

getFacetTypes() - Method in class org.jboss.forge.project.facets.events.InstallFacets

Get the facet types to be installed

getFacetTypes() - Method in class org.jboss.forge.project.facets.events.RemoveFacets

Get the facet types to be installed

getFacetTypes() - Method in class org.jboss.forge.project.services.FacetFactory

getFacetTypes() - Method in interface org.jboss.forge.shell.project.FacetRegistry

Return all known Facet types.

getFinalArtifact() - Method in interface org.jboss.forge.project.facets.PackagingFacet

Return the resource representing the fully built output artifact of this project.

getFinalName() - Method in interface org.jboss.forge.project.facets.PackagingFacet

Get the final name of this project's build output artifact.

getFlags() - Method in class org.jboss.forge.resources.AbstractResource

getFlags() - Method in interface org.jboss.forge.resources.Resource

getFloat(String) - Method in interface org.jboss.forge.env.Configuration

Get a float associated with the given configuration key.

getFloat(String, float) - Method in interface org.jboss.forge.env.Configuration

Get a float associated with the given configuration key.

getFloat(String, Float) - Method in interface org.jboss.forge.env.Configuration

Get a Float associated with the given configuration key.

getForgeHome() - Method in interface org.jboss.forge.ForgeEnvironment

Get the Forge Home directory.

getFrom() - Method in class org.jboss.forge.project.dependencies.events.UpdatedDependency

getFrom() - Method in class org.jboss.forge.project.dependencies.events.UpdatingDependency

getFullyQualifiedName() - Method in class org.jboss.forge.resources.AbstractResource

getFullyQualifiedName() - Method in class org.jboss.forge.resources.FileResource

getFullyQualifiedName() - Method in interface org.jboss.forge.resources.Resource

Return the fully qualified name of the resource (if applicable).

getGroupId() - Method in interface org.jboss.forge.project.dependencies.Dependency

Get the major identifier for this Dependency.

getGroupId() - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

getGroupId() - Method in class org.jboss.forge.project.dependencies.DependencyImpl

getGroupId() - Method in class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

getHeight() - Method in interface org.jboss.forge.shell.integration.BufferManager

Get height in lines

getHeight() - Method in enum org.jboss.forge.shell.integration.NoopBufferManager

getHeight() - Method in interface org.jboss.forge.shell.Shell

Return the current height, in characters, of the current shell console.

getHelp() - Method in interface org.jboss.forge.shell.command.CommandMetadata

Get the help text for this command.

getHelp() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Get the help text for this option.

getHelp() - Method in interface org.jboss.forge.shell.command.PluginMetadata

Get the help text for this plugin.

getId() - Method in interface org.jboss.forge.project.dependencies.DependencyRepository

getId() - Method in class org.jboss.forge.project.dependencies.DependencyRepositoryImpl

getId() - Method in enum org.jboss.forge.project.facets.DependencyFacet.KnownRepository

getIndex() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Get the index of this option in the receiving method signature parameter list.

getIndex() - Method in interface org.jboss.forge.shell.completer.CommandCompleterState

getInt(String) - Method in interface org.jboss.forge.env.Configuration

Get a int associated with the given configuration key.

getInt(String, int) - Method in interface org.jboss.forge.env.Configuration

Get a int associated with the given configuration key.

getInteger(String, Integer) - Method in interface org.jboss.forge.env.Configuration

Get an Integer associated with the given configuration key.

getJavaClassFromResource(Resource<?>) - Static method in class org.jboss.forge.shell.util.ResourceUtil

getJavaResource(String) - Method in interface org.jboss.forge.project.facets.JavaSourceFacet

Return the JavaClass at the given path relative to JavaSourceFacet.getSourceFolder().

getJavaResource(JavaSource<?>) - Method in interface org.jboss.forge.project.facets.JavaSourceFacet

Attempt to locate and re-parse the given JavaClass from its location on disk, relative to JavaSourceFacet.getSourceFolder().

getJavaSource() - Method in class org.jboss.forge.resources.java.JavaResource

Attempts to perform cast automatically.

getKey() - Method in class org.jboss.forge.resources.EntryResource

getKeys(String) - Method in interface org.jboss.forge.env.Configuration

Get the list of the keys contained in the configuration that match the specified prefix.

getKeys() - Method in interface org.jboss.forge.env.Configuration

Get the list of the keys contained in the configuration.

getKeys() - Method in class org.jboss.forge.resources.PropertiesFileResource

Returns the keys in this properties file

getLastBuffer() - Method in interface org.jboss.forge.shell.completer.CommandCompleterState

getLineSeparator() - Static method in class org.jboss.forge.shell.util.OSUtils

getList(String) - Method in interface org.jboss.forge.env.Configuration

Get a List of strings associated with the given configuration key.

getList(String, List<?>) - Method in interface org.jboss.forge.env.Configuration

Get a List of strings associated with the given configuration key.

getListener() - Method in interface org.jboss.forge.shell.spi.TriggeredAction

The ActionListener for which the actionPerformed method will be invoked when the trigger character is read.

getLong(String) - Method in interface org.jboss.forge.env.Configuration

Get a long associated with the given configuration key.

getLong(String, long) - Method in interface org.jboss.forge.env.Configuration

Get a long associated with the given configuration key.

getLong(String, Long) - Method in interface org.jboss.forge.env.Configuration

Get a Long associated with the given configuration key.

getManagedDependencies() - Method in interface org.jboss.forge.project.dependencies.DependencyMetadata

The managed dependencies of the Dependency for which this DependencyMetadata was retrieved.

getManagedDependencies() - Method in interface org.jboss.forge.project.facets.DependencyFacet

Return an immutable list of all direct managed Dependencies contained within this project.

getManagedDependency(Dependency) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Attempt to locate the given managed Dependency, if it exists in the Project, and return it.

getManagerInstance() - Method in class org.jboss.forge.project.services.ResourceFactory

getMessages() - Method in class org.jboss.forge.project.dependencies.events.UpdatingDependency

getMethod() - Method in interface org.jboss.forge.shell.command.CommandMetadata

Get the Method that implements this command.

getName() - Method in class org.jboss.forge.resources.DirectoryResource

getName() - Method in class org.jboss.forge.resources.EntryResource

getName() - Method in class org.jboss.forge.resources.enumtype.EnumConstantResource

getName() - Method in class org.jboss.forge.resources.FileResource

getName() - Method in class org.jboss.forge.resources.java.JavaFieldResource

getName() - Method in class org.jboss.forge.resources.java.JavaMemberResource

getName() - Method in class org.jboss.forge.resources.java.JavaMethodResource

getName() - Method in interface org.jboss.forge.resources.Resource

Return the common name of the resource.

getName() - Method in class org.jboss.forge.resources.URLResource

getName() - Method in interface org.jboss.forge.shell.command.CommandMetadata

Get the name of this command.

getName() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Get the name of this option.

getName() - Method in interface org.jboss.forge.shell.command.PluginMetadata

Get the name by which this plugin is referenced on the command line.

getName() - Method in class org.jboss.forge.shell.PluginEntry

getName(Class<?>) - Static method in class org.jboss.forge.shell.util.ConstraintInspector

Return the name of the given bean type.

getNamedOption(String) - Method in interface org.jboss.forge.shell.command.CommandMetadata

Get the option defined by the given name.

getNewLocation() - Method in class org.jboss.forge.resources.events.ResourceRenamed

getNewPackagingType() - Method in class org.jboss.forge.project.packaging.events.PackagingChanged

getNewProject() - Method in class org.jboss.forge.shell.events.ProjectChanged

getNewResource() - Method in class org.jboss.forge.shell.events.ResourceChanged

getNumOrderedOptions() - Method in interface org.jboss.forge.shell.command.CommandMetadata

Return the number of ordered (unnamed) options defined by this command.

getOldPackagingType() - Method in class org.jboss.forge.project.packaging.events.PackagingChanged

getOldProject() - Method in class org.jboss.forge.shell.events.ProjectChanged

getOldResource() - Method in class org.jboss.forge.shell.events.ResourceChanged

getOptionalResources() - Method in interface org.jboss.forge.resources.DeletionAware

Returns a List of additional Resource instances.

getOptionalResources() - Method in class org.jboss.forge.resources.java.JavaFieldResource

getOptionByAbsoluteIndex(int) - Method in interface org.jboss.forge.shell.command.CommandMetadata

Return the option at the given index in the plugin method signature, not the index of the option on the command line.

getOptionDescriptor() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Get the verbose description of this option.

getOptions() - Method in interface org.jboss.forge.shell.command.CommandMetadata

Return a list of all options defined by this command.

getOrCreateChildDirectory(String) - Method in class org.jboss.forge.resources.DirectoryResource

getOrderedOptionByIndex(int) - Method in interface org.jboss.forge.shell.command.CommandMetadata

Return the option at the given index as required on the command line, not the index of the option in the implementing method signature.

getOriginalIndex() - Method in interface org.jboss.forge.shell.completer.CommandCompleterState

getOriginalLocation() - Method in class org.jboss.forge.resources.events.ResourceRenamed

getOriginalStatement() - Method in class org.jboss.forge.shell.events.CommandExecuted

getOriginalStatement() - Method in class org.jboss.forge.shell.events.CommandMissing

getOriginalStatement() - Method in class org.jboss.forge.shell.events.CommandVetoed

getOriginalStatement() - Method in class org.jboss.forge.shell.events.PreCommandExecution

getOriginalTokens() - Method in interface org.jboss.forge.shell.completer.CommandCompleterState

getOsName() - Static method in class org.jboss.forge.shell.util.OSUtils

getOutputDependency() - Method in interface org.jboss.forge.project.facets.MetadataFacet

getPackagingType() - Method in interface org.jboss.forge.project.dependencies.Dependency

Get the specified packaging type of this Dependency

getPackagingType() - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

getPackagingType() - Method in class org.jboss.forge.project.dependencies.DependencyImpl

getPackagingType() - Method in class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

getPackagingType() - Method in interface org.jboss.forge.project.facets.PackagingFacet

Get the packaging type currently in use by this project.

getPackagingTypeEnum() - Method in interface org.jboss.forge.project.dependencies.Dependency

Get the PackagingType of this Dependency, if the type is not one of the default supported types, PackagingType.OTHER will be returned;

getPackagingTypeEnum() - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

getPackagingTypeEnum() - Method in class org.jboss.forge.project.dependencies.DependencyImpl

getPackagingTypeEnum() - Method in class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

getParameters() - Method in class org.jboss.forge.shell.events.CommandExecuted

getParameters() - Method in class org.jboss.forge.shell.events.CommandMissing

getParameters() - Method in class org.jboss.forge.shell.events.CommandVetoed

getParameters() - Method in class org.jboss.forge.shell.events.PreCommandExecution

getParent() - Method in class org.jboss.forge.resources.AbstractResource

getParent() - Method in class org.jboss.forge.resources.DirectoryResource

getParent() - Method in class org.jboss.forge.resources.FileResource

Get the parent of the current resource.

getParent() - Method in interface org.jboss.forge.resources.Resource

Get the parent of the current resource.

getParent() - Method in interface org.jboss.forge.shell.command.CommandMetadata

Return the PluginMetadata containing this command.

getParent() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Get the CommandMetadata defining this option.

getPluginDirectory() - Method in interface org.jboss.forge.ForgeEnvironment

Return the directory Forge is using to store and load third-party plugins.

getPluginEntry() - Method in class org.jboss.forge.shell.events.PluginInstalled

getPluginEntry() - Method in class org.jboss.forge.shell.events.PluginRemoved

getPluginMetadata(String) - Method in interface org.jboss.forge.shell.command.PluginRegistry

Get the PluginMetadata for the given plugin name.

getPluginMetadataForScopeAndConstraints(String, Shell) - Method in interface org.jboss.forge.shell.command.PluginRegistry

Resolves a single PluginMetadata instance representing the singular type that is in scope, and satisfied by the current project constraints such as RequiresProject or RequiresFacet

getPlugins() - Method in interface org.jboss.forge.shell.command.PluginRegistry

Get a map of all known plugin names and metadata.

getProject() - Method in class org.jboss.forge.project.dependencies.events.AddedDependencies

Get the Project from which this event was fired.

getProject() - Method in class org.jboss.forge.project.dependencies.events.RemovedDependencies

Get the Project from which this event was fired.

getProject() - Method in class org.jboss.forge.project.dependencies.events.UpdatedDependency

getProject() - Method in class org.jboss.forge.project.dependencies.events.UpdatingDependency

getProject() - Method in interface org.jboss.forge.project.Facet

Return the Project instance on which this Facet operates.

getProject() - Method in class org.jboss.forge.project.facets.BaseFacet

getProject() - Method in class org.jboss.forge.project.packaging.events.PackagingChanged

getProjectConfig(Project) - Method in interface org.jboss.forge.env.ConfigurationFactory

getProjectName() - Method in interface org.jboss.forge.project.facets.MetadataFacet

getProjectRoot() - Method in interface org.jboss.forge.project.Project

Get the File representing the root directory of this Project

getProjectVersion() - Method in interface org.jboss.forge.project.facets.MetadataFacet

getPrompt() - Method in interface org.jboss.forge.shell.Shell

Return the current shell prompt;

getPromptType() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Get the requested PromptType for this option.

getProperties(String) - Method in interface org.jboss.forge.env.Configuration

Get a list of Properties associated with the given configuration key.

getProperties() - Method in interface org.jboss.forge.ForgeEnvironment

Get a map of all configuration properties for the current Forge execution.

getProperties() - Method in interface org.jboss.forge.project.facets.DependencyFacet

Return a list of all build dependency properties.(Build properties such, as ${my.version}, can be used anywhere in a dependency, and will be expanded during building to their property value.)

getProperty(String) - Method in interface org.jboss.forge.env.Configuration

Gets a property from the configuration.

getProperty(String) - Method in interface org.jboss.forge.ForgeEnvironment

Get a named property for the current Forge execution

getProperty(String) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Get a build property by name.

getProperty(String) - Method in class org.jboss.forge.resources.PropertiesFileResource

Returns the value related to the key in this properties file

getProxyHost() - Method in class org.jboss.forge.shell.util.ProxySettings

getProxyPassword() - Method in class org.jboss.forge.shell.util.ProxySettings

getProxyPort() - Method in class org.jboss.forge.shell.util.ProxySettings

getProxyUserName() - Method in class org.jboss.forge.shell.util.ProxySettings

getRepositories() - Method in interface org.jboss.forge.project.dependencies.DependencyMetadata

The DependencyRepository instances used when building the Dependency, or any projects which inherit from it, for which this DependencyMetadata was retrieved.

getRepositories() - Method in interface org.jboss.forge.project.facets.DependencyFacet

Get the list of repositories for which this project is currently configured to use in dependency resolution.

getResource(String) - Method in interface org.jboss.forge.project.facets.ResourceFacet

Return the FileResource at the given path relative to ResourceFacet.getResourceFolder().

getResource() - Method in class org.jboss.forge.resources.events.ResourceEvent

getResource() - Method in class org.jboss.forge.shell.events.PickupResource

getResourceFactory() - Method in class org.jboss.forge.resources.AbstractResource

getResourceFactory() - Method in interface org.jboss.forge.resources.Resource

Return the ResourceFactory with which this Resource was created.

getResourceFolder() - Method in interface org.jboss.forge.project.facets.ResourceFacet

Get the DirectoryResource representing the folder this Project uses to store package-able, non-source documents (such as configuration files.)

getResourceFolders() - Method in interface org.jboss.forge.project.facets.ResourceFacet

Get a list of DirectoryResources representing the directories this project uses to contain Project non-source documents (such as configuration files.)

getResourceFrom(File) - Method in class org.jboss.forge.project.services.ResourceFactory

getResourceInputStream() - Method in class org.jboss.forge.resources.FileResource

getResourceInputStream() - Method in interface org.jboss.forge.resources.Resource

Get the InputStream represented by this Resource.

getResourceInputStream() - Method in class org.jboss.forge.resources.URLResource

getResourceInputStream() - Method in class org.jboss.forge.resources.VirtualResource

getResources() - Method in interface org.jboss.forge.resources.DeletionAware

Returns a List of additional Resource instances.

getResources() - Method in class org.jboss.forge.resources.java.JavaFieldResource

getResourceScopes() - Method in interface org.jboss.forge.shell.command.CommandMetadata

Return the set of Resource types for which this command is in scope, or available.

getResourceScopes() - Method in interface org.jboss.forge.shell.command.PluginMetadata

Get the Resource scopes for which this plugin is available.

getRuntimeVersion() - Method in interface org.jboss.forge.ForgeEnvironment

Return the current Forge version as a String.

getScope() - Method in enum org.jboss.forge.project.dependencies.ScopeType

getScopedConfiguration(ConfigurationScope) - Method in interface org.jboss.forge.env.Configuration

Get the underlying Configuration instance of the given ConfigurationScope type.

getScopeType() - Method in interface org.jboss.forge.project.dependencies.Dependency

Get the scope type of this Dependency

getScopeType() - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

getScopeType() - Method in class org.jboss.forge.project.dependencies.DependencyImpl

getScopeType() - Method in class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

Not implemented for Exclusions.

getScopeTypeEnum() - Method in interface org.jboss.forge.project.dependencies.Dependency

Get the ScopeType of this Dependency, if the type is not one of the default supported types, ScopeType.OTHER will be returned;

getScopeTypeEnum() - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

getScopeTypeEnum() - Method in class org.jboss.forge.project.dependencies.DependencyImpl

getScopeTypeEnum() - Method in class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

getSetupCommand() - Method in interface org.jboss.forge.shell.command.PluginMetadata

Get the "setup" command for this plugin.

getShort(String) - Method in interface org.jboss.forge.env.Configuration

Get a short associated with the given configuration key.

getShort(String, short) - Method in interface org.jboss.forge.env.Configuration

Get a short associated with the given configuration key.

getShort(String, Short) - Method in interface org.jboss.forge.env.Configuration

Get a Short associated with the given configuration key.

getShortName() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Get the short name for this option, if it exists; otherwise, return empty string.

getSlot() - Method in class org.jboss.forge.shell.PluginEntry

getSourceFolder() - Method in interface org.jboss.forge.project.facets.JavaSourceFacet

Get the DirectoryResource this Project uses to store package-able source documents (such as .java files.)

getSourceFolders() - Method in interface org.jboss.forge.project.facets.JavaSourceFacet

Get a list of DirectoryResources this project uses to contain Project source documents (such as .java files.)

getStatus() - Method in class org.jboss.forge.shell.events.CommandExecuted

getStatus() - Method in class org.jboss.forge.shell.events.PreShutdown

Get the status with which the shell is shutting down.

getStatus() - Method in class org.jboss.forge.shell.events.Shutdown

Get the status with which the shell should shut down.

getString(String) - Method in interface org.jboss.forge.env.Configuration

Get a string associated with the given configuration key.

getString(String, String) - Method in interface org.jboss.forge.env.Configuration

Get a string associated with the given configuration key.

getStringArray(String) - Method in interface org.jboss.forge.env.Configuration

Get an array of strings associated with the given configuration key.

getSystemPath() - Method in interface org.jboss.forge.project.dependencies.Dependency

Get the systemPath of this Dependency

getSystemPath() - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

getSystemPath() - Method in class org.jboss.forge.project.dependencies.DependencyImpl

getSystemPath() - Method in class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

getTestJavaResource(String) - Method in interface org.jboss.forge.project.facets.JavaSourceFacet

Return the JavaClass at the given path relative to JavaSourceFacet.getTestSourceFolder().

getTestJavaResource(JavaSource<?>) - Method in interface org.jboss.forge.project.facets.JavaSourceFacet

Attempt to locate and re-parse the given JavaClass from its location on disk, relative to JavaSourceFacet.getTestSourceFolder().

getTestResource(String) - Method in interface org.jboss.forge.project.facets.ResourceFacet

Attempt to locate a FileResource at the given path relative to ResourceFacet.getTestResourceFolder().

getTestResourceFolder() - Method in interface org.jboss.forge.project.facets.ResourceFacet

Get the 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.

getTestSourceFolder() - Method in interface org.jboss.forge.project.facets.JavaSourceFacet

Get the 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.

getTo() - Method in class org.jboss.forge.project.dependencies.events.UpdatedDependency

getTo() - Method in class org.jboss.forge.project.dependencies.events.UpdatingDependency

getTokens() - Method in interface org.jboss.forge.shell.completer.CommandCompleterState

getTopic() - Method in interface org.jboss.forge.shell.command.PluginMetadata

Get the topic text for this plugin.

getTopLevelPackage() - Method in interface org.jboss.forge.project.facets.MetadataFacet

getTrigger() - Method in interface org.jboss.forge.shell.spi.TriggeredAction

The char that is used to register the ActionListener as a TriggeredAction in the Shell.

getType() - Method in enum org.jboss.forge.project.packaging.PackagingType

getType() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Get the literal type of this option.

getType() - Method in interface org.jboss.forge.shell.command.PluginMetadata

Get the implementing Plugin class type for this PluginMetadata

getUnderlyingResourceObject() - Method in class org.jboss.forge.resources.EntryResource

getUnderlyingResourceObject() - Method in class org.jboss.forge.resources.enumtype.EnumConstantResource

getUnderlyingResourceObject() - Method in class org.jboss.forge.resources.FileResource

Get the actual underlying file resource that this resource instance represents, whether existing or non-existing.

getUnderlyingResourceObject() - Method in class org.jboss.forge.resources.java.JavaFieldResource

getUnderlyingResourceObject() - Method in class org.jboss.forge.resources.java.JavaMemberResource

getUnderlyingResourceObject() - Method in class org.jboss.forge.resources.java.JavaMethodResource

getUnderlyingResourceObject() - Method in interface org.jboss.forge.resources.Resource

Get the underlying object represented by this Resource

getUnderlyingResourceObject() - Method in class org.jboss.forge.resources.URLResource

getUrl() - Method in interface org.jboss.forge.project.dependencies.DependencyRepository

getUrl() - Method in class org.jboss.forge.project.dependencies.DependencyRepositoryImpl

getUrl() - Method in enum org.jboss.forge.project.facets.DependencyFacet.KnownRepository

getUserConfig() - Method in interface org.jboss.forge.env.ConfigurationFactory

getUserConfiguration() - Method in interface org.jboss.forge.ForgeEnvironment

Get the current User's configuration file.

getUserHomeDir() - Static method in class org.jboss.forge.shell.util.OSUtils

getUserHomePath() - Static method in class org.jboss.forge.shell.util.OSUtils

getValue() - Method in class org.jboss.forge.resources.EntryResource

getVersion() - Method in interface org.jboss.forge.project.dependencies.Dependency

Get the version of this Dependency.

getVersion() - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

getVersion() - Method in class org.jboss.forge.project.dependencies.DependencyImpl

getVersion() - Method in class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

Not implemented for Exclusions.

getWebResource(String) - Method in interface org.jboss.forge.project.facets.WebResourceFacet

Get the given FileResource relative to the project Web Root directory: WebResourceFacet.getWebRootDirectory()

getWebRootDirectories() - Method in interface org.jboss.forge.project.facets.WebResourceFacet

Get a list containing all possible Web Root DirectoryResources for the current project.

getWebRootDirectory() - Method in interface org.jboss.forge.project.facets.WebResourceFacet

Get the default Web Root directory (this is the DirectoryResource containing resources to be deployed to the web-root URL when the application is published.

getWidth() - Method in interface org.jboss.forge.shell.integration.BufferManager

Get width in lines

getWidth() - Method in enum org.jboss.forge.shell.integration.NoopBufferManager

getWidth() - Method in interface org.jboss.forge.shell.Shell

Return the current width, in characters, of the current shell console.

getWorkingDirectory() - Method in class org.jboss.forge.shell.events.Startup

getWorkingDirectory() - Static method in class org.jboss.forge.shell.util.Files

Returns the current working directory

H

hasAllFacets(Class<? extends Facet>...) - Method in class org.jboss.forge.project.BaseProject

hasAllFacets(Collection<Class<? extends Facet>>) - Method in class org.jboss.forge.project.BaseProject

hasAllFacets(Collection<Class<? extends Facet>>) - Method in interface org.jboss.forge.project.Project

Return true if this project has all Facets of the given types; otherwise, if any of the given facet types is missing, return false.

hasAllFacets(Class<? extends Facet>...) - Method in interface org.jboss.forge.project.Project

Return true if this project has all Facets of the given types; otherwise, if any of the given facet types is missing, return false.

hasAnnotation(Resource<?>, Class<? extends Annotation>) - Static method in class org.jboss.forge.shell.util.ResourceUtil

hasCommand(String, Class<? extends Resource<?>>) - Method in interface org.jboss.forge.shell.command.PluginMetadata

Return true if this plugin defines a command with the given name and Resource scope.

hasCommand(String, Shell) - Method in interface org.jboss.forge.shell.command.PluginMetadata

Return true if this plugin defines a command with the given name in the current Shell.getCurrentResourceScope()

hasCommands() - Method in interface org.jboss.forge.shell.command.PluginMetadata

Return true if this plugin has any commands.

hasCustomCompleter() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Return true if this option specifies a custom CommandCompleter.

hasDefaultCommand() - Method in interface org.jboss.forge.shell.command.PluginMetadata

Return true if this plugin has a default command.

hasDefaultValue() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Return true if this option has a default value.

hasDirectDependency(Dependency) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Return true if this Project contains a dependency matching the given Dependency; return false otherwise.

hasDirectManagedDependency(Dependency) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Return true if this Project contains a managed dependency matching the given Dependency; return false otherwise.

hasEffectiveDependency(Dependency) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Return true if the given Dependency exists anywhere in the project dependency hierarchy.

hasEffectiveManagedDependency(Dependency) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Return true if this Project contains a managed dependency matching the given Dependency at any level of the project hierarchy; return false otherwise.

hasFacet(Class<? extends Facet>) - Method in class org.jboss.forge.project.BaseProject

hasFacet(Class<? extends Facet>) - Method in interface org.jboss.forge.project.Project

Return true if this project has a facet of the given type; return false otherwise.

hashCode() - Method in class org.jboss.forge.project.BaseProject

hashCode() - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

hashCode() - Method in class org.jboss.forge.project.dependencies.DependencyImpl

hashCode() - Method in class org.jboss.forge.project.dependencies.DependencyRepositoryImpl

hashCode() - Method in class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

hashCode() - Method in class org.jboss.forge.project.facets.BaseFacet

hashCode() - Method in class org.jboss.forge.resources.AbstractResource

hashCode() - Method in class org.jboss.forge.resources.events.ResourceEvent

hashCode() - Method in class org.jboss.forge.resources.events.ResourceRenamed

hashCode() - Method in class org.jboss.forge.shell.PluginEntry

hasOption(String) - Method in interface org.jboss.forge.shell.command.CommandMetadata

Return true if this command has an OptionMetadata with the given name.

hasOptions() - Method in interface org.jboss.forge.shell.command.CommandMetadata

Return true if this command has any options.

hasOrderedOptions() - Method in interface org.jboss.forge.shell.command.CommandMetadata

Return true if this command accepts ordered options.

hasRepository(DependencyFacet.KnownRepository) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Return true if the given DependencyFacet.KnownRepository is already registered in this project's build system.

hasRepository(String) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Return true if the given repository URL is already registered in this project's build system.

hasSetupCommand() - Method in interface org.jboss.forge.shell.command.PluginMetadata

Return true if this plugin has a "setup" command.

hasShortOption(String) - Method in interface org.jboss.forge.shell.command.CommandMetadata

Return true if this command accepts options that declare a short name.

hasSuggestions() - Method in interface org.jboss.forge.shell.completer.CommandCompleterState

Help - Annotation Type in org.jboss.forge.shell.plugins

Supply help text for a Plugin Facet or other type.

HOME_ALIAS - Static variable in class org.jboss.forge.shell.util.Files

I

indexOfLastElement(List<?>) - Static method in class org.jboss.forge.shell.util.Lists

Return the index of the last element of this List, if any (size - 1), if the list is empty, return 0;

info(ShellPrintWriter, String) - Static method in class org.jboss.forge.shell.ShellMessages

init() - Method in class org.jboss.forge.project.services.ProjectFactory

install() - Method in class org.jboss.forge.env.ConfigurationFacet

install(Project, Dependency) - Method in interface org.jboss.forge.project.dependencies.DependencyInstaller

Install given Dependency with the default ScopeType.

install(Project, Dependency, DependencyFilter) - Method in interface org.jboss.forge.project.dependencies.DependencyInstaller

Install given Dependency with the default ScopeType, applying the given DependencyFilter.

install(Project, Dependency, ScopeType) - Method in interface org.jboss.forge.project.dependencies.DependencyInstaller

Install given Dependency with the given ScopeType.

install(Project, Dependency, ScopeType, DependencyFilter) - Method in interface org.jboss.forge.project.dependencies.DependencyInstaller

Install given Dependency with the given ScopeType and DependencyFilter.

install() - Method in interface org.jboss.forge.project.Facet

Perform necessary setup for this Facet to be considered installed in the given Project.

installFacet(Facet) - Method in class org.jboss.forge.project.BaseProject

installFacet(Facet) - Method in interface org.jboss.forge.project.Project

Install and register the given Facet.

InstallFacets - Class in org.jboss.forge.project.facets.events

Event to instruct Forge to install the given Facet into the current Project

InstallFacets(Class<? extends Facet>) - Constructor for class org.jboss.forge.project.facets.events.InstallFacets

Install the given facet without prompting for confirmation

InstallFacets(boolean, Class<? extends Facet>) - Constructor for class org.jboss.forge.project.facets.events.InstallFacets

Install the given facet but first prompt for confirmation.

InstallFacets(Class<? extends Facet>...) - Constructor for class org.jboss.forge.project.facets.events.InstallFacets

Install the given facets without prompting for confirmation

InstallFacets(boolean, Class<? extends Facet>...) - Constructor for class org.jboss.forge.project.facets.events.InstallFacets

Install the given facets but first prompt for confirmation.

installManaged(Project, Dependency) - Method in interface org.jboss.forge.project.dependencies.DependencyInstaller

Install given managed Dependency with the default ScopeType.

installManaged(Project, Dependency, DependencyFilter) - Method in interface org.jboss.forge.project.dependencies.DependencyInstaller

Install given managed Dependency with the default ScopeType, applying the given DependencyFilter.

installManaged(Project, Dependency, ScopeType) - Method in interface org.jboss.forge.project.dependencies.DependencyInstaller

Install given managed Dependency with the given ScopeType .

installManaged(Project, Dependency, ScopeType, DependencyFilter) - Method in interface org.jboss.forge.project.dependencies.DependencyInstaller

Install given managed Dependency with the given ScopeType and DependencyFilter.

installSingleFacet(Project, Class<? extends Facet>) - Method in class org.jboss.forge.project.services.ProjectFactory

instanceOf(PluginMetadata) - Method in interface org.jboss.forge.shell.command.PluginRegistry

Get the Plugin instance defined by the given PluginMetadata

intercept(String) - Method in interface org.jboss.forge.shell.spi.CommandInterceptor

Intercepts a command and returns it along with any modifications.

isAcceptDefaults() - Method in interface org.jboss.forge.shell.Shell

Return true if this Shell is currently set to accept prompt defaults automatically.

isAnsiSupported() - Method in interface org.jboss.forge.shell.Shell

Returns whether or not this shell supports ANSI escape codes.

isAuthenticationSupported() - Method in class org.jboss.forge.shell.util.ProxySettings

isBoolean() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Return true if this option is a boolean type.

isChildOf(Resource<?>, Resource<?>) - Static method in class org.jboss.forge.shell.util.ResourceUtil

isCommandOverloaded(String) - Method in interface org.jboss.forge.shell.command.PluginMetadata

Return true if this plugin is overloaded in multiple Resource scopes.

isDefault() - Method in interface org.jboss.forge.shell.command.CommandMetadata

Return true if this command is the default command for its declaring PluginMetadata

isDirectory() - Method in class org.jboss.forge.resources.FileResource

Return true if this FileResource exists and is actually a directory, otherwise return false;

isEmbedded() - Method in interface org.jboss.forge.ForgeEnvironment

Returns true if Forge is running in embedded mode (inside JBoss Tools for example)

isEmpty() - Method in interface org.jboss.forge.env.Configuration

Check if the configuration is empty.

isEnum() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Return true if this option is an enum type.

isExceptionHandlingEnabled() - Method in interface org.jboss.forge.shell.Shell

Return true if this shell is currently set to handle exceptions.

isExecuting() - Method in interface org.jboss.forge.shell.Shell

Return true if the Shell is currently executing a plugin; otherwise, return false.

isFinalTokenComplete() - Method in interface org.jboss.forge.shell.completer.CommandCompleterState

isFlagOnly() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Return true if this option is only a flag, and only has a short name, taking no value on the command line.

isFlagSet(ResourceFlag) - Method in class org.jboss.forge.resources.AbstractResource

isFlagSet(ResourceFlag) - Method in interface org.jboss.forge.resources.Resource

Return true if the given ResourceFlag is set.

isHistoryEnabled() - Method in interface org.jboss.forge.shell.Shell

Return true if this shell is currently keeping a record of command history.

isInstalled() - Method in class org.jboss.forge.env.ConfigurationFacet

isInstalled(Project, Dependency) - Method in interface org.jboss.forge.project.dependencies.DependencyInstaller

Returns whether or not the given Dependency is installed.

isInstalled() - Method in interface org.jboss.forge.project.Facet

Return true if the Facet is available for the given Project, false if otherwise.

isLinux() - Static method in class org.jboss.forge.shell.util.OSUtils

isNamed() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Return true if this option is named.

isOnline() - Method in interface org.jboss.forge.ForgeEnvironment

Return true if Forge is currently operating with the assumption that an Internet connection is available.

isOrdered() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Return true if this option is not named, and must be specified by order.

isOSX() - Static method in class org.jboss.forge.shell.util.OSUtils

isPiped() - Method in interface org.jboss.forge.shell.plugins.PipeOut

isPipeIn() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Return true if this option is the PipeIn

isPipeOut() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Return true if this option is the PipeOut

isPretend() - Method in interface org.jboss.forge.shell.Shell

Return true if this shell is currently running in pretend mode.

isRequired() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Return true if this option is required, and cannot be omitted on the command line.

isRestart() - Method in class org.jboss.forge.shell.events.Startup

isSetup() - Method in interface org.jboss.forge.shell.command.CommandMetadata

Return true if this command is the "setup" command.

isSetupAvailable(Shell) - Method in interface org.jboss.forge.shell.command.PluginMetadata

Return true if PluginMetadata.hasSetupCommand() returns true, and it is available in the current scope.

isSnapshot() - Method in interface org.jboss.forge.project.dependencies.Dependency

Returns true if this dependency version is a SNAPSHOT

isSnapshot() - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

isSnapshot() - Method in class org.jboss.forge.project.dependencies.DependencyImpl

isSnapshot() - Method in class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

isStale() - Method in class org.jboss.forge.resources.FileResource

Returns true if the underlying resource has been modified on the file system since it was initially loaded.

isVarargs() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Return true if this option accepts multiple values on the command line.

isVerbose() - Method in interface org.jboss.forge.shell.Shell

Return true if this shell is currently running in verbose mode.

isVetoed() - Method in class org.jboss.forge.project.dependencies.events.UpdatingDependency

isVetoed() - Method in class org.jboss.forge.shell.events.PreCommandExecution

isWaiting() - Method in class org.jboss.forge.shell.Wait

Returns true if the waiting spinner is currently being displayed; otherwise, return false.

isWindows() - Static method in class org.jboss.forge.shell.util.OSUtils

J

JAVA_KEYWORDS - Static variable in interface org.jboss.forge.shell.util.Patterns

A group of terms that are illegal to use as Java identifiers.

JavaColorizer - Class in org.jboss.forge.shell.util

Should be used to colorize a Java Source file or Java Source string snippit.

JavaColorizer() - Constructor for class org.jboss.forge.shell.util.JavaColorizer

JavaExecutionFacet - Interface in org.jboss.forge.project.facets

JavaFieldResource - Class in org.jboss.forge.resources.java

JavaFieldResource(JavaResource, Field<? extends JavaSource<?>>) - Constructor for class org.jboss.forge.resources.java.JavaFieldResource

JavaMemberResource<T extends org.jboss.forge.parser.java.Member> - Class in org.jboss.forge.resources.java

JavaMemberResource(Resource<?>, T) - Constructor for class org.jboss.forge.resources.java.JavaMemberResource

JavaMethodResource - Class in org.jboss.forge.resources.java

JavaMethodResource(Resource<?>, Method<? extends JavaSource<?>>) - Constructor for class org.jboss.forge.resources.java.JavaMethodResource

JavaPathspecParser - Class in org.jboss.forge.shell.util

Parser accepts a Java path, and provides a result set of resources based on the relative path provided.

JavaPathspecParser(JavaSourceFacet, String) - Constructor for class org.jboss.forge.shell.util.JavaPathspecParser

JavaResource - Class in org.jboss.forge.resources.java

JavaResource(ResourceFactory) - Constructor for class org.jboss.forge.resources.java.JavaResource

JavaResource(ResourceFactory, File) - Constructor for class org.jboss.forge.resources.java.JavaResource

JavaResourceVisitor - Interface in org.jboss.forge.resources.java

JavaSourceFacet - Interface in org.jboss.forge.project.facets

K

KeyListener - Interface in org.jboss.forge.shell.integration

A priority key listener.

keyPress(int) - Method in interface org.jboss.forge.shell.integration.KeyListener

Called for every keystroke in the shell.

L

lastElement(List<T>) - Static method in class org.jboss.forge.shell.util.Lists

Return the the last element of this List, if any.

lastModification - Variable in class org.jboss.forge.resources.FileResource

listResources() - Method in class org.jboss.forge.resources.AbstractResource

listResources(ResourceFilter) - Method in class org.jboss.forge.resources.AbstractResource

listResources() - Method in interface org.jboss.forge.resources.Resource

Return a list of child resources of the current resource.

listResources(ResourceFilter) - Method in interface org.jboss.forge.resources.Resource

Return a list of child resources of the current resource matching the given ResourceFilter.

Lists - Class in org.jboss.forge.shell.util

Lists() - Constructor for class org.jboss.forge.shell.util.Lists

locateRecursively(DirectoryResource, ProjectLocator) - Method in class org.jboss.forge.project.services.ProjectFactory

M

manage(InvocationContext) - Method in class org.jboss.forge.shell.squelch.SquelchingInterceptor

markUpToDate() - Method in class org.jboss.forge.resources.FileResource

Re-read the last modified timestamp for this resource.

matches(String) - Method in enum org.jboss.forge.shell.PromptType

MetadataFacet - Interface in org.jboss.forge.project.facets

mkdir() - Method in class org.jboss.forge.resources.FileResource

Create a new single directory for this resource.

mkdirs() - Method in class org.jboss.forge.resources.FileResource

Create all directories required for this resource to exist.

N

NativeSystemCall - Class in org.jboss.forge.shell.util

Executes native system commands.

NativeSystemCall() - Constructor for class org.jboss.forge.shell.util.NativeSystemCall

NonSnapshotDependencyFilter - Class in org.jboss.forge.project.dependencies

Filters non-snapshots dependencies

NonSnapshotDependencyFilter() - Constructor for class org.jboss.forge.project.dependencies.NonSnapshotDependencyFilter

NoopBufferManager - Enum in org.jboss.forge.shell.integration

notOrdered() - Method in interface org.jboss.forge.shell.command.OptionMetadata

Return true if this option is not ordered: E.g.

NullCommandCompleter - Class in org.jboss.forge.shell.completer

NullCommandCompleter() - Constructor for class org.jboss.forge.shell.completer.NullCommandCompleter

O

Option - Annotation Type in org.jboss.forge.shell.plugins

A command option.

OptionMetadata - Interface in org.jboss.forge.shell.command

Defines an option.

org.jboss.forge - package org.jboss.forge

org.jboss.forge.env - package org.jboss.forge.env

org.jboss.forge.project - package org.jboss.forge.project

org.jboss.forge.project.build - package org.jboss.forge.project.build

org.jboss.forge.project.dependencies - package org.jboss.forge.project.dependencies

org.jboss.forge.project.dependencies.events - package org.jboss.forge.project.dependencies.events

org.jboss.forge.project.facets - package org.jboss.forge.project.facets

org.jboss.forge.project.facets.events - package org.jboss.forge.project.facets.events

org.jboss.forge.project.locator - package org.jboss.forge.project.locator

org.jboss.forge.project.packaging - package org.jboss.forge.project.packaging

org.jboss.forge.project.packaging.events - package org.jboss.forge.project.packaging.events

org.jboss.forge.project.services - package org.jboss.forge.project.services

org.jboss.forge.resources - package org.jboss.forge.resources

org.jboss.forge.resources.enumtype - package org.jboss.forge.resources.enumtype

org.jboss.forge.resources.events - package org.jboss.forge.resources.events

org.jboss.forge.resources.java - package org.jboss.forge.resources.java

org.jboss.forge.shell - package org.jboss.forge.shell

org.jboss.forge.shell.command - package org.jboss.forge.shell.command

org.jboss.forge.shell.completer - package org.jboss.forge.shell.completer

org.jboss.forge.shell.events - package org.jboss.forge.shell.events

org.jboss.forge.shell.exceptions - package org.jboss.forge.shell.exceptions

org.jboss.forge.shell.integration - package org.jboss.forge.shell.integration

org.jboss.forge.shell.plugins - package org.jboss.forge.shell.plugins

org.jboss.forge.shell.project - package org.jboss.forge.shell.project

org.jboss.forge.shell.spi - package org.jboss.forge.shell.spi

org.jboss.forge.shell.squelch - package org.jboss.forge.shell.squelch

org.jboss.forge.shell.util - package org.jboss.forge.shell.util

OSUtils - Class in org.jboss.forge.shell.util

OSUtils() - Constructor for class org.jboss.forge.shell.util.OSUtils

P

Packages - Class in org.jboss.forge.shell.util

Packages() - Constructor for class org.jboss.forge.shell.util.Packages

PackagingChanged - Class in org.jboss.forge.project.packaging.events

This event is fired when the current Project's PackagingType is changed.

PackagingChanged(Project, PackagingType, PackagingType) - Constructor for class org.jboss.forge.project.packaging.events.PackagingChanged

PackagingFacet - Interface in org.jboss.forge.project.facets

A Facet representing this project's Packaging (JAR, WAR, EAR, etc...)

PackagingType - Enum in org.jboss.forge.project.packaging

pad(int) - Method in class org.jboss.forge.shell.util.ColumnPrinter

parent - Variable in class org.jboss.forge.resources.AbstractResource

parsePathspec(ResourceFactory, Resource<?>, String) - Static method in class org.jboss.forge.shell.util.ResourceUtil

PathspecParser - Class in org.jboss.forge.shell.util

Parser of UNIX-style pathspec.

PathspecParser(ResourceFactory, Resource<?>, String) - Constructor for class org.jboss.forge.shell.util.PathspecParser

pathspecToRegEx(String) - Static method in class org.jboss.forge.shell.util.PathspecParser

Patterns - Interface in org.jboss.forge.shell.util

PickupResource - Class in org.jboss.forge.shell.events

Signal the Shell to pick up the given resource.

PickupResource(Resource<?>) - Constructor for class org.jboss.forge.shell.events.PickupResource

PipeIn - Annotation Type in org.jboss.forge.shell.plugins

PipeOut - Interface in org.jboss.forge.shell.plugins

Plugin - Interface in org.jboss.forge.shell.plugins

A custom Plugin must implement this interface in order to be detected and installed at framework boot-time.

PluginEntry - Class in org.jboss.forge.shell

PluginEntry(String, String, String) - Constructor for class org.jboss.forge.shell.PluginEntry

PluginEntry(String, String) - Constructor for class org.jboss.forge.shell.PluginEntry

PluginEntry(String) - Constructor for class org.jboss.forge.shell.PluginEntry

PluginInstalled - Class in org.jboss.forge.shell.events

Fired when a plugin is installed

PluginInstalled(PluginEntry) - Constructor for class org.jboss.forge.shell.events.PluginInstalled

PluginMetadata - Interface in org.jboss.forge.shell.command

Defines a plugin.

PluginRegistry - Interface in org.jboss.forge.shell.command

Contains the collection of all installed and available plugins.

PluginRemoved - Class in org.jboss.forge.shell.events

Fired when a plugin is removed

PluginRemoved(PluginEntry) - Constructor for class org.jboss.forge.shell.events.PluginRemoved

PostStartup - Class in org.jboss.forge.shell.events

Fired by the Shell when it has successfully started up and is ready to accept user input.

PostStartup() - Constructor for class org.jboss.forge.shell.events.PostStartup

PreCommandExecution - Class in org.jboss.forge.shell.events

Fired before a plugin/command is executed

PreCommandExecution(CommandMetadata, String, Object[], Map<Object, Object>) - Constructor for class org.jboss.forge.shell.events.PreCommandExecution

PreShutdown - Class in org.jboss.forge.shell.events

Fired in response to receipt of the shell Shutdown command event.

PreShutdown(Shutdown.Status) - Constructor for class org.jboss.forge.shell.events.PreShutdown

PreStartup - Class in org.jboss.forge.shell.events

Fired by the Bootstrap when it has successfully started weld

PreStartup() - Constructor for class org.jboss.forge.shell.events.PreStartup

print(String) - Method in interface org.jboss.forge.shell.ShellPrintWriter

Print output to the console.

print(ShellColor, String) - Method in interface org.jboss.forge.shell.ShellPrintWriter

Print color output to the console.

println(String) - Method in interface org.jboss.forge.shell.ShellPrintWriter

Print output to the console, followed by the newline character.

println() - Method in interface org.jboss.forge.shell.ShellPrintWriter

Print a blank line to the console.

println(ShellColor, String) - Method in interface org.jboss.forge.shell.ShellPrintWriter

Print color output to the console, followed by the newline character.

printlnVerbose(String) - Method in interface org.jboss.forge.shell.Shell

Write output to the console, only if Shell.isVerbose() == true.

printlnVerbose(ShellColor, String) - Method in interface org.jboss.forge.shell.Shell

Write color output to the console, only if Shell.isVerbose() == true.

printOutColumns(List<String>, ShellPrintWriter, Shell, boolean) - Method in class org.jboss.forge.shell.util.ColumnPrinter

printOutColumns(List<String>, ShellPrintWriter, Shell, ColumnPrinter.FormatCallback, boolean) - Method in class org.jboss.forge.shell.util.ColumnPrinter

printOutColumns(List<String>, ShellColor, ShellPrintWriter, ColumnPrinter.OutputAttributes, ColumnPrinter.FormatCallback, boolean) - Method in class org.jboss.forge.shell.util.ColumnPrinter

printOutTables(List<String>, int, Shell) - Method in class org.jboss.forge.shell.util.ColumnPrinter

printOutTables(List<String>, boolean[], Shell) - Method in class org.jboss.forge.shell.util.ColumnPrinter

printOutTables(List<String>, boolean[], ShellPrintWriter, ColumnPrinter.FormatCallback) - Method in class org.jboss.forge.shell.util.ColumnPrinter

project - Variable in class org.jboss.forge.project.facets.BaseFacet

Project - Interface in org.jboss.forge.project

ProjectAssociationProvider - Interface in org.jboss.forge.project.services

ProjectBuilder - Interface in org.jboss.forge.project.build

Used to configure and execute the project build system.

ProjectChanged - Class in org.jboss.forge.shell.events

An event that notifies observers immediately after the current Project has changed.

ProjectChanged(Project, Project) - Constructor for class org.jboss.forge.shell.events.ProjectChanged

ProjectFactory - Class in org.jboss.forge.project.services

Responsible for instantiating project instances through CDI.

ProjectFactory(FacetFactory, BeanManager, Instance<ProjectLocator>) - Constructor for class org.jboss.forge.project.services.ProjectFactory

ProjectLocator - Interface in org.jboss.forge.project.locator

Locates project root directories, and creates instances of projects for that type.

ProjectModelException - Exception in org.jboss.forge.project

ProjectModelException() - Constructor for exception org.jboss.forge.project.ProjectModelException

ProjectModelException(String) - Constructor for exception org.jboss.forge.project.ProjectModelException

ProjectModelException(Throwable) - Constructor for exception org.jboss.forge.project.ProjectModelException

ProjectModelException(String, Throwable) - Constructor for exception org.jboss.forge.project.ProjectModelException

ProjectScoped - Annotation Type in org.jboss.forge.shell.project

Declares a bean as being scoped to the current Project.

prompt() - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input, and return as a String.

prompt(String) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input, first printing the given line, then return user input as a String.

prompt(String, String) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input, first printing the given line, then return user input as a String.

prompt(String, Class<T>) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input, first printing the given message, then return user input cast to the type provided.

prompt(String, Class<T>, T) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input, first printing the given line, then returning user input as a converted value.

promptAndSwallowCR() - Method in interface org.jboss.forge.shell.ShellPrompt

This works like prompt, however when a CR is received, the method returns the value, but does not produce a CR in the actual terminal buffer.

promptBoolean(String) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for boolean user input (Y/n), first printing the given message, then returning user input as a boolean.

promptBoolean(String, boolean) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for boolean user input (Y/n), first printing the given message, then returning user input as a boolean.

promptChoice(String, Object...) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input, first printing the given message, followed by an enumerated list of options (printing the String value of each item in the list.) Loop until the user enters a number corresponding to one of the options, then return the index of that option from the list.

promptChoice(String, List<?>) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input, first printing the given message, followed by an enumerated list of options (printing the String value of each item in the list.) Loop until the user enters a number corresponding to one of the options, then return the index of that option from the list.

promptChoice(String, Map<String, T>) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input, first printing the given message, followed by a keyed list of options.

promptChoiceTyped(String, List<T>) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input, first printing the given message, followed by an enumerated list of options (printing the String value of each item in the list.) Loop until the user enters a number corresponding to one of the options, then return that option from the list.

promptChoiceTyped(String, List<T>, T) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input, first printing the given message, followed by an enumerated list of options (printing the String value of each item in the list.) Loop until the user enters a number corresponding to one of the options, then return that option from the list.

promptCommon(String, PromptType) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input, first printing the given message, then returning user input as a String.

promptCommon(String, PromptType, String) - Method in interface org.jboss.forge.shell.ShellPrompt

Same as ShellPrompt.promptCommon(String, PromptType), but will default to a given value if user input is empty.

promptCompleter(String, Class<? extends CommandCompleter>) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input, first printing the given line, then returning user input with help from the given completer type.

promptEnum(String, Class<T>) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input in the form of an Enum, first printing the given message, then returning user input as a Enum.

promptEnum(String, Class<T>, T) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input in the form of an Enum, first printing the given message, then returning user input as a Enum.

promptFile(String) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input in the form of a file path, first printing the given message, then returning user input as a File.

promptFile(String, FileResource<?>) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input in the form of a file path, first printing the given message, then returning user input as a File.

promptMultiSelect(String, Set<T>) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input, first printing the given message, followed by a keyed list of options.

promptMultiSelect(String, T...) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input, first printing the given message, followed by a keyed list of options.

promptMultiSelect(String, Map<String, T>) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input, first printing the given message, followed by a keyed list of options.

promptMultiSelectWithWildcard(String, String, Set<T>) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input, first printing the given message, followed by a keyed list of options, including a "wildcard" option to select all.

promptMultiSelectWithWildcard(String, String, T...) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input, first printing the given message, followed by a keyed list of options, including a "wildcard" option to select all.

promptMultiSelectWithWildcard(String, String, Map<String, T>) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input, first printing the given message, followed by a keyed list of options, including a "wildcard" option to select all.

promptRegex(String, String) - Method in interface org.jboss.forge.shell.ShellPrompt

Prompt for user input (Y/n), first printing the given message, then returning user input as a String.

promptRegex(String, String, String) - Method in interface org.jboss.forge.shell.ShellPrompt

Same as ShellPrompt.promptRegex(String, String), but will default to a given value if user input is empty.

promptRequested() - Method in class org.jboss.forge.project.facets.events.InstallFacets

Return whether or not the caller has requested to prompt the user for confirmation

promptRequested() - Method in class org.jboss.forge.project.facets.events.RemoveFacets

Return whether or not the caller has requested to prompt the user for confirmation

promptSecret(String) - Method in interface org.jboss.forge.shell.ShellPrompt

First print the given message, prompt the user for input (masking keystrokes for secrecy,) then return user input.

promptSecret(String, String) - Method in interface org.jboss.forge.shell.ShellPrompt

First print the given message, prompt the user for input (masking keystrokes for secrecy,) then return user input.

PromptType - Enum in org.jboss.forge.shell

PropertiesFileResource - Class in org.jboss.forge.resources

A property based resource

PropertiesFileResource(ResourceFactory) - Constructor for class org.jboss.forge.resources.PropertiesFileResource

PropertiesFileResource(ResourceFactory, File) - Constructor for class org.jboss.forge.resources.PropertiesFileResource

PropertyCompleter - Class in org.jboss.forge.shell.completer

PropertyCompleter(Shell) - Constructor for class org.jboss.forge.shell.completer.PropertyCompleter

ProxySettings - Class in org.jboss.forge.shell.util

putAllProperties(Map<String, String>) - Method in class org.jboss.forge.resources.PropertiesFileResource

Adds all the properties and updates the file

putProperty(String, String) - Method in class org.jboss.forge.resources.PropertiesFileResource

Adds a property to this resource

Q

QueuedEvent - Annotation Type in org.jboss.forge

Used to qualify events which should be queued until the end of the current plugin execution.

R

readLine() - Method in interface org.jboss.forge.shell.Shell

Ask the current InputStream for data.

readLine(Character) - Method in interface org.jboss.forge.shell.Shell

Ask the current InputStream for input, masking keystrokes in the console with the given mask.

registerBufferManager(BufferManager) - Method in interface org.jboss.forge.shell.Shell

Register the buffer manager for the shell system

registerFacet(Facet) - Method in class org.jboss.forge.project.BaseProject

registerFacet(Facet) - Method in interface org.jboss.forge.project.Project

Add the given Facet to this Project's internal collection of installed facets.

registerKeyListener(KeyListener) - Method in interface org.jboss.forge.shell.Shell

Register a KeyListener object that will defined behavior when a given key is received from the Shell

registerSingleFacet(Project, Class<? extends Facet>) - Method in class org.jboss.forge.project.services.ProjectFactory

reify(Class<R>) - Method in class org.jboss.forge.resources.AbstractResource

reify(Class<R>) - Method in class org.jboss.forge.resources.FileResource

reify(Class<R>) - Method in interface org.jboss.forge.resources.Resource

Ask this 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.

removeAttribute(String) - Method in class org.jboss.forge.project.BaseProject

removeAttribute(String) - Method in interface org.jboss.forge.project.Project

Remove a value from this project's internal attributes.

RemovedDependencies - Class in org.jboss.forge.project.dependencies.events

Fired when dependencies are removed from the current Project

RemovedDependencies(Project, Dependency...) - Constructor for class org.jboss.forge.project.dependencies.events.RemovedDependencies

RemovedDependencies(Project, List<Dependency>) - Constructor for class org.jboss.forge.project.dependencies.events.RemovedDependencies

removeDependency(Dependency) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Remove the given Dependency from this facet's Project.

removeFacet(Facet) - Method in class org.jboss.forge.project.BaseProject

removeFacet(Facet) - Method in interface org.jboss.forge.project.Project

Remove the given Facet from this Project's internal collection of installed facets.

RemoveFacets - Class in org.jboss.forge.project.facets.events

Event to instruct Forge to install the given Facet into the current Project

RemoveFacets(Class<? extends Facet>) - Constructor for class org.jboss.forge.project.facets.events.RemoveFacets

Install the given facet without prompting for confirmation

RemoveFacets(boolean, Class<? extends Facet>) - Constructor for class org.jboss.forge.project.facets.events.RemoveFacets

Install the given facet but first prompt for confirmation.

RemoveFacets(Class<? extends Facet>...) - Constructor for class org.jboss.forge.project.facets.events.RemoveFacets

Install the given facets without prompting for confirmation

RemoveFacets(boolean, Class<? extends Facet>...) - Constructor for class org.jboss.forge.project.facets.events.RemoveFacets

Install the given facets but first prompt for confirmation.

removeManagedDependency(Dependency) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Remove the given managed Dependency from this facet's Project.

removeProperty(String) - Method in interface org.jboss.forge.ForgeEnvironment

Get a named property for the current Forge execution

removeProperty(String) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Remove a build property by name.

removeProperty(String) - Method in class org.jboss.forge.resources.PropertiesFileResource

Removes an entry on this file based on the properties file

removeRepository(String) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Remove the given DependencyRepository from the current project.

renameTo(String) - Method in class org.jboss.forge.resources.FileResource

Rename this resource to the given path.

renameTo(FileResource<?>) - Method in class org.jboss.forge.resources.FileResource

Rename this resource to the given FileResource

renderColor(ShellColor, String) - Method in interface org.jboss.forge.shell.ShellPrintWriter

Render a color for the current terminal emulation by encapsulating the string is the appropriate escape codes

replaceProperties(Map<String, String>) - Method in class org.jboss.forge.resources.PropertiesFileResource

Replaces all the occurrences

RequiresFacet - Annotation Type in org.jboss.forge.shell.plugins

The annotated element requires the given Facet

RequiresPackagingType - Annotation Type in org.jboss.forge.shell.plugins

The annotated element requires the given PackagingTypes

RequiresProject - Annotation Type in org.jboss.forge.shell.plugins

The annotated element requires an active Project

requiresProject(Class<?>) - Static method in class org.jboss.forge.shell.util.ConstraintInspector

Inspect the given Class type for a dependency on an active project.

RequiresResource - Annotation Type in org.jboss.forge.shell.plugins

Signals to the framework that in order for the annotated element to be visible, applicable, or "in scope," the current resource or any parent in its hierarchy must be of the declared Resource type.

resolve(ResourceFilter) - Method in class org.jboss.forge.shell.util.JavaPathspecParser

Resolve the results.

resolve() - Method in class org.jboss.forge.shell.util.JavaPathspecParser

resolve() - Method in class org.jboss.forge.shell.util.PathspecParser

Resolve the results.

resolveArtifacts(Dependency) - Method in class org.jboss.forge.project.dependencies.DependencyResolver

resolveArtifacts(Dependency, DependencyRepository) - Method in class org.jboss.forge.project.dependencies.DependencyResolver

resolveArtifacts(Dependency, List<DependencyRepository>) - Method in class org.jboss.forge.project.dependencies.DependencyResolver

resolveArtifacts(Dependency) - Method in interface org.jboss.forge.project.dependencies.DependencyResolverProvider

Resolve a set of DependencyResource artifacts matching the given query, searching in the default repository.

resolveArtifacts(Dependency, DependencyRepository) - Method in interface org.jboss.forge.project.dependencies.DependencyResolverProvider

Resolve a set of DependencyResource artifacts matching the given query, searching in only the given DependencyRepository.

resolveArtifacts(Dependency, List<DependencyRepository>) - Method in interface org.jboss.forge.project.dependencies.DependencyResolverProvider

Resolve a set of DependencyResource artifacts matching the given query, searching in only the given list of DependencyRepository instances.

resolveAvailableVersions(Dependency) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Given a Dependency with a populated groupId, versionId, and version range, identify the available artifacts in all known repositories for this project.

resolveAvailableVersions(String) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Given a groupid:versionid:version-range, identify and resolve all matching artifacts in all known DependencyRepository instances for this Project.

resolveAvailableVersions(DependencyQuery) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Using the given DependencyQuery, identify and resolve all matching Dependency results in configured DependencyRepository instances for this Project.

resolveDependencies(Dependency) - Method in class org.jboss.forge.project.dependencies.DependencyResolver

resolveDependencies(Dependency, DependencyRepository) - Method in class org.jboss.forge.project.dependencies.DependencyResolver

resolveDependencies(Dependency, List<DependencyRepository>) - Method in class org.jboss.forge.project.dependencies.DependencyResolver

resolveDependencies(Dependency) - Method in interface org.jboss.forge.project.dependencies.DependencyResolverProvider

Resolve a set of DependencyResource dependencies for the given query, searching in the default repository.

resolveDependencies(Dependency, DependencyRepository) - Method in interface org.jboss.forge.project.dependencies.DependencyResolverProvider

Resolve a set of DependencyResource dependencies for the given query, searching in only the given DependencyRepository.

resolveDependencies(Dependency, List<DependencyRepository>) - Method in interface org.jboss.forge.project.dependencies.DependencyResolverProvider

Resolve a set of DependencyResource dependencies for the given query, searching in only the given list of DependencyRepository instances.

resolveDependencyMetadata(Dependency) - Method in class org.jboss.forge.project.dependencies.DependencyResolver

resolveDependencyMetadata(Dependency, DependencyRepository) - Method in class org.jboss.forge.project.dependencies.DependencyResolver

resolveDependencyMetadata(Dependency, List<DependencyRepository>) - Method in class org.jboss.forge.project.dependencies.DependencyResolver

resolveDependencyMetadata(Dependency) - Method in interface org.jboss.forge.project.dependencies.DependencyResolverProvider

Resolve DependencyMetadata for a given Dependency, searching the default repository.

resolveDependencyMetadata(Dependency, DependencyRepository) - Method in interface org.jboss.forge.project.dependencies.DependencyResolverProvider

Resolve DependencyMetadata for a given Dependency, searching only the given DependencyRepository.

resolveDependencyMetadata(Dependency, List<DependencyRepository>) - Method in interface org.jboss.forge.project.dependencies.DependencyResolverProvider

Resolve DependencyMetadata for a given Dependency, searching only the given DependencyRepository instances.

resolveProperties(Dependency) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Resolve properties in the given dependency, converting them to their actual values.

resolveVersions(Dependency) - Method in class org.jboss.forge.project.dependencies.DependencyResolver

Deprecated.

Use DependencyResolver.resolveVersions(DependencyQuery)

resolveVersions(Dependency, DependencyRepository) - Method in class org.jboss.forge.project.dependencies.DependencyResolver

Deprecated.

Use DependencyResolver.resolveVersions(DependencyQuery)

resolveVersions(Dependency, List<DependencyRepository>) - Method in class org.jboss.forge.project.dependencies.DependencyResolver

Deprecated.

Use DependencyResolver.resolveVersions(DependencyQuery)

resolveVersions(DependencyQuery) - Method in class org.jboss.forge.project.dependencies.DependencyResolver

Resolve a set of Dependency versions matching the given query.

resolveVersions(Dependency) - Method in interface org.jboss.forge.project.dependencies.DependencyResolverProvider

Resolve a set of Dependency versions matching the given query, searching in the default repository.

resolveVersions(Dependency, DependencyRepository) - Method in interface org.jboss.forge.project.dependencies.DependencyResolverProvider

Resolve a set of Dependency versions matching the given query, searching in only the given DependencyRepository.

resolveVersions(Dependency, List<DependencyRepository>) - Method in interface org.jboss.forge.project.dependencies.DependencyResolverProvider

Resolve a set of Dependency versions matching the given query, searching in only the given list of DependencyRepository instances.

Resource<T> - Interface in org.jboss.forge.resources

A Resource is an abstraction on top of usable items within a Forge project.

ResourceChanged - Class in org.jboss.forge.shell.events

An event that notifies observers immediately after the current Resource has been changed to a new Resource.

ResourceChanged(Resource<?>, Resource<?>) - Constructor for class org.jboss.forge.shell.events.ResourceChanged

ResourceCreated - Class in org.jboss.forge.resources.events

Fired when a Resource has been created.

ResourceCreated(Resource<?>) - Constructor for class org.jboss.forge.resources.events.ResourceCreated

ResourceDeleted - Class in org.jboss.forge.resources.events

Fired when a Resource has been deleted.

ResourceDeleted(Resource<?>) - Constructor for class org.jboss.forge.resources.events.ResourceDeleted

ResourceEvent - Class in org.jboss.forge.resources.events

ResourceEvent(Resource<?>) - Constructor for class org.jboss.forge.resources.events.ResourceEvent

ResourceException - Exception in org.jboss.forge.resources

Represents a generic Exception thrown by the Forge Resource API

ResourceException() - Constructor for exception org.jboss.forge.resources.ResourceException

ResourceException(String, Throwable) - Constructor for exception org.jboss.forge.resources.ResourceException

ResourceException(String) - Constructor for exception org.jboss.forge.resources.ResourceException

ResourceException(Throwable) - Constructor for exception org.jboss.forge.resources.ResourceException

ResourceFacet - Interface in org.jboss.forge.project.facets

ResourceFactory - Class in org.jboss.forge.project.services

ResourceFactory() - Constructor for class org.jboss.forge.project.services.ResourceFactory

resourceFactory - Variable in class org.jboss.forge.resources.AbstractResource

ResourceFilter - Interface in org.jboss.forge.resources

Used to filter Resource instances during a given operation.

ResourceFlag - Enum in org.jboss.forge.resources

ResourceHandles - Annotation Type in org.jboss.forge.resources

Declares a resource handler for specified wildcards.

ResourceIOException - Exception in org.jboss.forge.resources

ResourceIOException() - Constructor for exception org.jboss.forge.resources.ResourceIOException

ResourceIOException(String) - Constructor for exception org.jboss.forge.resources.ResourceIOException

ResourceIOException(String, Throwable) - Constructor for exception org.jboss.forge.resources.ResourceIOException

ResourceIOException(Throwable) - Constructor for exception org.jboss.forge.resources.ResourceIOException

ResourceModified - Class in org.jboss.forge.resources.events

Fired when a Resource has been modified.

ResourceModified(Resource<?>) - Constructor for class org.jboss.forge.resources.events.ResourceModified

ResourceRenamed - Class in org.jboss.forge.resources.events

ResourceRenamed(Resource<?>, String, String) - Constructor for class org.jboss.forge.resources.events.ResourceRenamed

ResourceScoped - Annotation Type in org.jboss.forge.shell.project

Declares a bean as being scoped to the current Resource.

ResourceUtil - Class in org.jboss.forge.shell.util

A set of utilities to work with the resources API.

ResourceUtil() - Constructor for class org.jboss.forge.shell.util.ResourceUtil

Root - Interface in org.jboss.forge

Marks the root of the Forge API packages.

runTests(boolean) - Method in interface org.jboss.forge.project.build.ProjectBuilder

Enable or disable test execution during build.

S

saveEnumTypeSource(JavaEnum) - Method in interface org.jboss.forge.project.facets.JavaSourceFacet

Deprecated.

Use JavaSourceFacet.saveJavaSource(JavaSource)

saveJavaSource(JavaSource<?>) - Method in interface org.jboss.forge.project.facets.JavaSourceFacet

Create or update a Java file in the primary source directory: JavaSourceFacet.getSourceFolder() - use information in the given JavaSource to determine the appropriate package; packages will be created if necessary.

saveTestJavaSource(JavaSource<?>) - Method in interface org.jboss.forge.project.facets.JavaSourceFacet

Create or update a Java file in the primary test source directory: JavaSourceFacet.getTestSourceFolder() - use information in the given JavaSource to determine the appropriate package; packages will be created if necessary.

scan(ProcessBean<Resource<?>>, BeanManager) - Method in class org.jboss.forge.project.services.ResourceFactory

scan() - Method in interface org.jboss.forge.shell.Shell

Wait for input.

ScopeType - Enum in org.jboss.forge.project.dependencies

Represents the various dependency scopes.

scratch - Variable in class org.jboss.forge.resources.FileResource

scratchFile - Variable in class org.jboss.forge.resources.FileResource

search() - Method in class org.jboss.forge.shell.util.PathspecParser

Perform a search, by doing a breadth-first traversal of the resource tree for resources that match the path string.

setAcceptDefaults(boolean) - Method in interface org.jboss.forge.shell.Shell

Set this Shell to accept prompt defaults automatically.

setAnsiSupported(boolean) - Method in interface org.jboss.forge.shell.Shell

Controls the shell's usage of ANSI escape code support.

setArtifactId(String) - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

setArtifactId(String) - Method in class org.jboss.forge.project.dependencies.DependencyImpl

setArtifactId(String) - Method in class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

setAttribute(String, Object) - Method in class org.jboss.forge.project.BaseProject

setAttribute(String, Object) - Method in interface org.jboss.forge.project.Project

Set a value in this project's internal attributes.

setBufferPosition(int, int) - Method in interface org.jboss.forge.shell.integration.BufferManager

Set buffer position.

setBufferPosition(int, int) - Method in enum org.jboss.forge.shell.integration.NoopBufferManager

setClassifier(String) - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

setClassifier(String) - Method in class org.jboss.forge.project.dependencies.DependencyImpl

setCommand(CommandMetadata) - Method in class org.jboss.forge.shell.events.CommandVetoed

setContents(String) - Method in class org.jboss.forge.resources.FileResource

Set the contents of this FileResource to the given String

setContents(char[]) - Method in class org.jboss.forge.resources.FileResource

Set the contents of this FileResource to the given character array.

setContents(InputStream) - Method in class org.jboss.forge.resources.FileResource

setContents(JavaSource<?>) - Method in class org.jboss.forge.resources.java.JavaResource

setCurrentResource(Resource<?>) - Method in interface org.jboss.forge.shell.Shell

Set the Resource on which the shell should operate.

setDefaultPrompt() - Method in interface org.jboss.forge.shell.Shell

Reset the shell prompt to default.

setExceptionHandlingEnabled(boolean) - Method in interface org.jboss.forge.shell.Shell

Toggle exception handling.

setExcludedDependencies(List<Dependency>) - Method in class org.jboss.forge.project.dependencies.DependencyImpl

setFilter(DependencyFilter) - Method in class org.jboss.forge.project.dependencies.DependencyQueryBuilder

setFinalName(String) - Method in interface org.jboss.forge.project.facets.PackagingFacet

Set the final name of this project's build output artifact.

setFlag(ResourceFlag) - Method in class org.jboss.forge.resources.AbstractResource

setFlag(ResourceFlag) - Method in interface org.jboss.forge.resources.Resource

Set the given ResourceFlag.

setGroupId(String) - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

setGroupId(String) - Method in class org.jboss.forge.project.dependencies.DependencyImpl

setGroupId(String) - Method in class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

setHistory(List<String>) - Method in interface org.jboss.forge.shell.ShellHistory

setHistoryEnabled(boolean) - Method in interface org.jboss.forge.shell.Shell

Toggle whether or not this shell should keep a record of command history.

setHistoryOutputStream(OutputStream) - Method in interface org.jboss.forge.shell.ShellHistory

setIndex(int) - Method in interface org.jboss.forge.shell.completer.CommandCompleterState

setInputStream(InputStream) - Method in interface org.jboss.forge.shell.Shell

Set the stream from which the shell should read input.

setManager(PostStartup, Instance<BeanManager>) - Method in class org.jboss.forge.project.services.ResourceFactory

setOriginalStatement(String) - Method in class org.jboss.forge.shell.events.CommandVetoed

setOutputStream(OutputStream) - Method in interface org.jboss.forge.shell.Shell

Set the stream to which the shell should print output.

setPackagingType(PackagingType) - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

setPackagingType(String) - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

setPackagingType(PackagingType) - Method in class org.jboss.forge.project.dependencies.DependencyImpl

setPackagingType(String) - Method in class org.jboss.forge.project.dependencies.DependencyImpl

setPackagingType(PackagingType) - Method in interface org.jboss.forge.project.facets.PackagingFacet

Set the packaging type currently in use by this project.

setParameters(Object[]) - Method in class org.jboss.forge.shell.events.CommandVetoed

setPiped(boolean) - Method in interface org.jboss.forge.shell.plugins.PipeOut

setPretendWindows(boolean) - Static method in class org.jboss.forge.shell.util.OSUtils

setProject(Project) - Method in interface org.jboss.forge.project.Facet

Initialize this Facet for operation on the given Project.

setProject(Project) - Method in class org.jboss.forge.project.facets.BaseFacet

setProjectName(String) - Method in interface org.jboss.forge.project.facets.MetadataFacet

setPrompt(String) - Method in interface org.jboss.forge.shell.Shell

Set the current shell prompt, followed by '> '.

setProperty(String, Object) - Method in interface org.jboss.forge.env.Configuration

Set a property, this will replace any previously set values.

setProperty(String, Object) - Method in interface org.jboss.forge.ForgeEnvironment

Set a configuration property for the current Forge execution.

setProperty(String, String) - Method in interface org.jboss.forge.project.facets.DependencyFacet

Set a build dependency property.

setRepositories(DependencyRepository...) - Method in class org.jboss.forge.project.dependencies.DependencyQueryBuilder

setRepositories(Iterable<DependencyRepository>) - Method in class org.jboss.forge.project.dependencies.DependencyQueryBuilder

setScope(ScopeType) - Method in class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

setScopeType(ScopeType) - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

setScopeType(String) - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

setScopeType(ScopeType) - Method in class org.jboss.forge.project.dependencies.DependencyImpl

setScopeType(String) - Method in class org.jboss.forge.project.dependencies.DependencyImpl

setSystemPath(String) - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

setSystemPath(String) - Method in class org.jboss.forge.project.dependencies.DependencyImpl

setTopLevelPackage(String) - Method in interface org.jboss.forge.project.facets.MetadataFacet

SetupCommand - Annotation Type in org.jboss.forge.shell.plugins

Defines a @Command to be used when performing setup for a Plugin.

setVerbose(boolean) - Method in interface org.jboss.forge.shell.Shell

Toggle verbose mode.

setVersion(String) - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

setVersion(String) - Method in class org.jboss.forge.project.dependencies.DependencyImpl

setVersion(String) - Method in class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

Shell - Interface in org.jboss.forge.shell

ShellColor - Enum in org.jboss.forge.shell

ShellHistory - Interface in org.jboss.forge.shell

ShellMessages - Class in org.jboss.forge.shell

Used to generate properly formatted status messages.

ShellMessages() - Constructor for class org.jboss.forge.shell.ShellMessages

ShellPrintWriter - Interface in org.jboss.forge.shell

ShellPrompt - Interface in org.jboss.forge.shell

Shutdown - Class in org.jboss.forge.shell.events

Fired as a signal to the shell that it should shut down now.

Shutdown() - Constructor for class org.jboss.forge.shell.events.Shutdown

Defaults to Shutdown.Status.NORMAL

Shutdown(Shutdown.Status) - Constructor for class org.jboss.forge.shell.events.Shutdown

Inform the shell to shut down with the given Shutdown.Status, now.

Shutdown.Status - Enum in org.jboss.forge.shell.events

Status of the shell during shutdown.

SimpleTokenCompleter - Class in org.jboss.forge.shell.completer

The simplest possible command option completer.

SimpleTokenCompleter() - Constructor for class org.jboss.forge.shell.completer.SimpleTokenCompleter

SLASH - Static variable in class org.jboss.forge.shell.util.Files

Squelched - Annotation Type in org.jboss.forge.shell.squelch

InterceptorBinding that disables STDOUT and STDERR during wrapped invocations.

SquelchingInterceptor - Class in org.jboss.forge.shell.squelch

SquelchingInterceptor() - Constructor for class org.jboss.forge.shell.squelch.SquelchingInterceptor

start() - Method in class org.jboss.forge.shell.Wait

Start waiting, printing the default message.

start(String) - Method in class org.jboss.forge.shell.Wait

Start waiting.

Startup - Class in org.jboss.forge.shell.events

Fired as a signal to the shell to bootstrap and accept user input.

Startup() - Constructor for class org.jboss.forge.shell.events.Startup

Startup(File) - Constructor for class org.jboss.forge.shell.events.Startup

Startup(File, boolean) - Constructor for class org.jboss.forge.shell.events.Startup

stop() - Method in class org.jboss.forge.shell.Wait

Stop waiting.

Streams - Class in org.jboss.forge.shell.util

Stream utilities.

Streams() - Constructor for class org.jboss.forge.shell.util.Streams

subset(String) - Method in interface org.jboss.forge.env.Configuration

Return a decorator Configuration containing every key from the current Configuration that starts with the specified prefix.

success(ShellPrintWriter, String) - Static method in class org.jboss.forge.shell.ShellMessages

T

TempResourceCreated - Class in org.jboss.forge.resources.events

Fired when a temporary Resource has been created.

TempResourceCreated(Resource<?>) - Constructor for class org.jboss.forge.resources.events.TempResourceCreated

toCoordinates() - Method in interface org.jboss.forge.project.dependencies.Dependency

Return a string represenging this dependency in the form of a standard identifier.

toCoordinates() - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

toCoordinates() - Method in class org.jboss.forge.project.dependencies.DependencyImpl

toCoordinates() - Method in class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

toCoordinates() - Method in class org.jboss.forge.shell.PluginEntry

toFileSyntax(String) - Static method in class org.jboss.forge.shell.util.Packages

Convert a package name to file directory syntax.

toId(Dependency) - Static method in class org.jboss.forge.project.dependencies.DependencyBuilder

Convenience method which should be used to convert a Dependency object into its id representation, for example: "groupId:artifactId:::version", "groupId:artifactId:packaging::version" or "groupId:artifactId:packaging:classifier:version"

toModuleId() - Method in class org.jboss.forge.shell.PluginEntry

Topic - Annotation Type in org.jboss.forge.shell.plugins

toString(Dependency) - Static method in class org.jboss.forge.project.dependencies.DependencyBuilder

Convenience method which should be used to convert a Dependency object into its string representation, for example: "groupId:artifactId:version:scope:packaging"

toString() - Method in class org.jboss.forge.project.dependencies.DependencyBuilder

toString() - Method in class org.jboss.forge.project.dependencies.DependencyImpl

toString() - Method in class org.jboss.forge.project.dependencies.DependencyRepositoryImpl

toString() - Method in class org.jboss.forge.project.dependencies.ExcludedDependencyBuilder

toString() - Method in enum org.jboss.forge.project.packaging.PackagingType

toString() - Method in class org.jboss.forge.resources.DependencyResource

toString() - Method in class org.jboss.forge.resources.DirectoryResource

toString() - Method in class org.jboss.forge.resources.enumtype.EnumConstantResource

toString() - Method in class org.jboss.forge.resources.java.JavaFieldResource

toString() - Method in class org.jboss.forge.resources.java.JavaMemberResource

toString() - Method in class org.jboss.forge.resources.java.JavaMethodResource

toString() - Method in class org.jboss.forge.resources.java.JavaResource

toString() - Method in class org.jboss.forge.resources.PropertiesFileResource

toString() - Method in class org.jboss.forge.resources.UnknownFileResource

toString() - Method in class org.jboss.forge.shell.PluginEntry

toString(InputStream) - Static method in class org.jboss.forge.shell.util.Streams

Return a String containing the contents of the given InputStream

toValidPackageName(String) - Static method in class org.jboss.forge.shell.util.Packages

TriggeredAction - Interface in org.jboss.forge.shell.spi

Allows the shell to register an ActionListener that is performed when the corresponding character is being read by the ConsoleReader.

U

uninstall() - Method in interface org.jboss.forge.project.Facet

Remove this Facet from its Project, and perform any necessary cleanup.

uninstall() - Method in class org.jboss.forge.project.facets.BaseFacet

UnknownFileResource - Class in org.jboss.forge.resources

Represents any regular file which Forge does not hav any special handler for.

UnknownFileResource(ResourceFactory) - Constructor for class org.jboss.forge.resources.UnknownFileResource

UnknownFileResource(ResourceFactory, File) - Constructor for class org.jboss.forge.resources.UnknownFileResource

unregisterFacet(Facet) - Method in class org.jboss.forge.project.BaseProject

unregisterFacet(Facet) - Method in interface org.jboss.forge.project.Project

Remove the given Facet from this Project's internal collection of installed facets.

unsetFlag(ResourceFlag) - Method in class org.jboss.forge.resources.AbstractResource

unsetFlag(ResourceFlag) - Method in interface org.jboss.forge.resources.Resource

Unset the given ResourceFlag.

unzip(File, File) - Static method in class org.jboss.forge.shell.util.Files

Unzips a specific file into a target directory

UpdatedDependency - Class in org.jboss.forge.project.dependencies.events

Fired when a dependency is finishes updating

UpdatedDependency(Project, Dependency, Dependency) - Constructor for class org.jboss.forge.project.dependencies.events.UpdatedDependency

UpdatingDependency - Class in org.jboss.forge.project.dependencies.events

Fired when a dependency is being updated.

UpdatingDependency(Project, Dependency, Dependency) - Constructor for class org.jboss.forge.project.dependencies.events.UpdatingDependency

URLResource - Class in org.jboss.forge.resources

Represents an URL

URLResource(ResourceFactory, URL) - Constructor for class org.jboss.forge.resources.URLResource

usableWithResource(Class<? extends Resource>) - Method in interface org.jboss.forge.shell.command.CommandMetadata

Return true if this command is usable with the given resource scope.

usableWithScope(Class<? extends Resource>) - Method in interface org.jboss.forge.shell.command.PluginMetadata

Return true if this plugin is usable in the given Resource scope

V

value() - Method in class org.jboss.forge.shell.plugins.AliasLiteral

valueOf(String) - Static method in enum org.jboss.forge.env.ConfigurationScope

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

valueOf(String) - Static method in enum org.jboss.forge.project.dependencies.ScopeType

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

valueOf(String) - Static method in enum org.jboss.forge.project.facets.DependencyFacet.KnownRepository

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

valueOf(String) - Static method in enum org.jboss.forge.project.packaging.PackagingType

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

valueOf(String) - Static method in enum org.jboss.forge.resources.ResourceFlag

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

valueOf(String) - Static method in enum org.jboss.forge.shell.events.CommandExecuted.Status

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

valueOf(String) - Static method in enum org.jboss.forge.shell.events.Shutdown.Status

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

valueOf(String) - Static method in enum org.jboss.forge.shell.integration.NoopBufferManager

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

valueOf(String) - Static method in enum org.jboss.forge.shell.PromptType

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

valueOf(String) - Static method in enum org.jboss.forge.shell.ShellColor

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

values() - Static method in enum org.jboss.forge.env.ConfigurationScope

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

values() - Static method in enum org.jboss.forge.project.dependencies.ScopeType

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

values() - Static method in enum org.jboss.forge.project.facets.DependencyFacet.KnownRepository

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

values() - Static method in enum org.jboss.forge.project.packaging.PackagingType

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

values() - Static method in enum org.jboss.forge.resources.ResourceFlag

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

values() - Static method in enum org.jboss.forge.shell.events.CommandExecuted.Status

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

values() - Static method in enum org.jboss.forge.shell.events.Shutdown.Status

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

values() - Static method in enum org.jboss.forge.shell.integration.NoopBufferManager

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

values() - Static method in enum org.jboss.forge.shell.PromptType

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

values() - Static method in enum org.jboss.forge.shell.ShellColor

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

veto(String) - Method in class org.jboss.forge.project.dependencies.events.UpdatingDependency

Abort the Update.

veto() - Method in class org.jboss.forge.shell.events.PreCommandExecution

Vetoes the execution of this command

VirtualResource<T> - Class in org.jboss.forge.resources

VirtualResource(Resource<?>) - Constructor for class org.jboss.forge.resources.VirtualResource

VirtualResource(ResourceFactory, Resource<?>) - Constructor for class org.jboss.forge.resources.VirtualResource

visit(JavaResource) - Method in interface org.jboss.forge.resources.java.JavaResourceVisitor

Called when a Java File is found.

visitJavaSources(JavaResourceVisitor) - Method in interface org.jboss.forge.project.facets.JavaSourceFacet

Recursively loops over all the source directories and for each java file it finds, calls the visitor.

visitJavaTestSources(JavaResourceVisitor) - Method in interface org.jboss.forge.project.facets.JavaSourceFacet

Recursively loops over all the test source directories and for each java file it finds, calls the visitor.

W

Wait - Class in org.jboss.forge.shell

Display a "Please wait" spinner for the user, until cancelled.

Wait(Shell) - Constructor for class org.jboss.forge.shell.Wait

warn(ShellPrintWriter, String) - Static method in class org.jboss.forge.shell.ShellMessages

WebResourceFacet - Interface in org.jboss.forge.project.facets

A Facet containing APIs to interact with Java Web Projects

write(int) - Method in interface org.jboss.forge.shell.integration.BufferManager

write(byte) - Method in interface org.jboss.forge.shell.integration.BufferManager

Write a single byte to the buffer.

write(byte[]) - Method in interface org.jboss.forge.shell.integration.BufferManager

Write a byte array to the buffer.

write(byte[], int, int) - Method in interface org.jboss.forge.shell.integration.BufferManager

Write a byte array to the buffer with offset

write(String) - Method in interface org.jboss.forge.shell.integration.BufferManager

write(int) - Method in enum org.jboss.forge.shell.integration.NoopBufferManager

write(byte) - Method in enum org.jboss.forge.shell.integration.NoopBufferManager

write(byte[]) - Method in enum org.jboss.forge.shell.integration.NoopBufferManager

write(byte[], int, int) - Method in enum org.jboss.forge.shell.integration.NoopBufferManager

write(String) - Method in enum org.jboss.forge.shell.integration.NoopBufferManager

write(int) - Method in interface org.jboss.forge.shell.ShellPrintWriter

Write the given bytes to the console.

write(byte) - Method in interface org.jboss.forge.shell.ShellPrintWriter

write(byte[]) - Method in interface org.jboss.forge.shell.ShellPrintWriter

write(byte[], int, int) - Method in interface org.jboss.forge.shell.ShellPrintWriter

write(InputStream, OutputStream) - Static method in class org.jboss.forge.shell.util.Streams

writeToHistory(String) - Method in interface org.jboss.forge.shell.ShellHistory

A B C D E F G H I J K L M N O P Q R S T U V W