Forge - Projects API 2.0.0.Alpha4
A B C D E F G H I M O P R S W 

A

AbstractProject - Class in org.jboss.forge.projects
Convenience base class for Project implementations.
AbstractProject() - Constructor for class org.jboss.forge.projects.AbstractProject
 
addArguments(String...) - Method in interface org.jboss.forge.projects.building.ProjectBuilder
Manually add an argument to be passed to the underlying build system.
addDirectDependency(Dependency) - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Add the given Dependency to this Project's immediate list of dependencies.
addDirectManagedDependency(Dependency) - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Add the given managed Dependency to this Project's immediate list of managed dependencies.
addManagedDependency(Dependency) - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Add the given managed Dependency to this Project's immediate list of managed dependencies.
addProjectListener(ProjectListener) - Method in interface org.jboss.forge.projects.ProjectFactory
Register a listener for project events
addRepository(String, String) - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Add a repository to the project build system.
associate(Project, DirectoryResource) - Method in interface org.jboss.forge.projects.ProjectAssociationProvider
Create a parent-child association between the given Project and the given parent directory.

B

build() - Method in interface org.jboss.forge.projects.building.ProjectBuilder
Execute the build, returning the final product as a Resource.
BuildException - Exception in org.jboss.forge.projects.building
Represents an exception during project building.
BuildException() - Constructor for exception org.jboss.forge.projects.building.BuildException
 
BuildException(String, Throwable) - Constructor for exception org.jboss.forge.projects.building.BuildException
 
BuildException(String) - Constructor for exception org.jboss.forge.projects.building.BuildException
 
BuildException(Throwable) - Constructor for exception org.jboss.forge.projects.building.BuildException
 

C

canAssociate(Project, DirectoryResource) - Method in interface org.jboss.forge.projects.ProjectAssociationProvider
Return true if this provide is capable of creating a parent-child association between the given Project and the given parent directory.
containsProject(DirectoryResource) - Method in interface org.jboss.forge.projects.ProjectLocator
Returns true if the given DirectoryResource contains an existing Project.
createBuilder() - Method in interface org.jboss.forge.projects.facets.PackagingFacet
Return a new ProjectBuilder instance.
createProject(DirectoryResource) - Method in interface org.jboss.forge.projects.ProjectFactory
Create a Project in the specified DirectoryResource.
createProject(DirectoryResource, Iterable<Class<? extends ProjectFacet>>) - Method in interface org.jboss.forge.projects.ProjectFactory
Create a Project with the given ProjectFacet types in the specified DirectoryResource.
createProject(DirectoryResource) - Method in interface org.jboss.forge.projects.ProjectLocator
Create a new or existing Project with the given DirectoryResource as Project.getProjectRoot().
createResource(char[], String) - Method in interface org.jboss.forge.projects.facets.ResourceFacet
At the given path/filename relative to the project resources directory: ResourceFacet.getResourceFolder() - create a file containing the given bytes.
createTempProject() - Method in interface org.jboss.forge.projects.ProjectFactory
Create a Project in a temporary location.
createTestResource(char[], String) - Method in interface org.jboss.forge.projects.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.projects.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.projects.facets.WebResourceFacet
At the given path/filename relative to the project Web Root directory: WebResourceFacet.getWebRootDirectory() - create a FileResource containing the given String.

D

DependencyFacet - Interface in org.jboss.forge.projects.facets
 
DependencyInstaller - Interface in org.jboss.forge.projects.dependencies
Responsible for installing a given Dependency into the current project.

E

equals(Object) - Method in class org.jboss.forge.projects.AbstractProject
 
executeBuild(String...) - Method in interface org.jboss.forge.projects.facets.PackagingFacet
Trigger the underlying build system to perform a build with the given arguments or flags.

F

findProject(DirectoryResource) - Method in interface org.jboss.forge.projects.ProjectFactory
Locate a Project in the ancestry of the given DirectoryResource.
findProject(DirectoryResource, Predicate<Project>) - Method in interface org.jboss.forge.projects.ProjectFactory
Locate a Project in the ancestry of the given DirectoryResource.

G

getAttribute(Object) - Method in class org.jboss.forge.projects.AbstractProject
 
getAttribute(Object) - Method in interface org.jboss.forge.projects.Project
Get a value from this project's internal attributes.
getDependencies() - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Return an immutable list of all direct DependencyNodeUtil contained within this project.
getDependenciesInScopes(String...) - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Get a list of this Project's dependencies of the given scopes..
getDirectDependency(Dependency) - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Attempt to locate the given Dependency, if it exists in the Project direct dependency list, and return it.
getEffectiveDependencies() - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Return an immutable list of all DependencyNodeUtil contained anywhere within this project's dependency hierarchy.
getEffectiveDependenciesInScopes(String...) - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Get a list of this Project's dependencies of the given scopes, from anywhere in the dependency hierarchy.
getEffectiveDependency(Dependency) - Method in interface org.jboss.forge.projects.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.projects.facets.DependencyFacet
Searches Project and returns a managed dependency matching the given Dependency at any level of the project hierarchy; return null otherwise.
getFinalArtifact() - Method in interface org.jboss.forge.projects.facets.PackagingFacet
Return the resource representing the fully built output artifact of this project.
getFinalName() - Method in interface org.jboss.forge.projects.facets.PackagingFacet
Get the final name of this project's build output artifact.
getManagedDependencies() - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Return an immutable list of all direct managed DependencyNodeUtil contained within this project.
getManagedDependency(Dependency) - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Attempt to locate the given managed Dependency, if it exists in the Project, and return it.
getNewType() - Method in class org.jboss.forge.projects.events.PackagingChanged
 
getOutputDependency() - Method in interface org.jboss.forge.projects.facets.MetadataFacet
 
getPackagingType() - Method in interface org.jboss.forge.projects.facets.PackagingFacet
Get the packaging type currently in use by this project.
getPreviousType() - Method in class org.jboss.forge.projects.events.PackagingChanged
 
getProject() - Method in class org.jboss.forge.projects.events.PackagingChanged
 
getProjectName() - Method in interface org.jboss.forge.projects.facets.MetadataFacet
 
getProjectRoot() - Method in interface org.jboss.forge.projects.Project
Get the DirectoryResource representing the root directory of this Project.
getProjectVersion() - Method in interface org.jboss.forge.projects.facets.MetadataFacet
 
getProperties() - Method in interface org.jboss.forge.projects.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.projects.facets.DependencyFacet
Get a build property by name.
getRepositories() - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Get the list of repositories for which this project is currently configured to use in dependency resolution.
getRequiredFacets() - Method in interface org.jboss.forge.projects.ProjectType
Return all Facet Class types required by a project of this type.
getResource(String) - Method in interface org.jboss.forge.projects.facets.ResourceFacet
Return the FileResource at the given path relative to ResourceFacet.getResourceFolder().
getResourceFolder() - Method in interface org.jboss.forge.projects.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.projects.facets.ResourceFacet
Get a list of DirectoryResources representing the directories this project uses to contain Project non-source documents (such as configuration files.)
getSetupFlow() - Method in interface org.jboss.forge.projects.ProjectType
Return the UIWizardStep Class that begins project configuration of this type.
getTestResource(String) - Method in interface org.jboss.forge.projects.facets.ResourceFacet
Attempt to locate a FileResource at the given path relative to ResourceFacet.getTestResourceFolder().
getTestResourceFolder() - Method in interface org.jboss.forge.projects.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.
getTopLevelPackage() - Method in interface org.jboss.forge.projects.facets.MetadataFacet
 
getType() - Method in interface org.jboss.forge.projects.ProjectType
Return the human-readable project type.
getWebResource(String) - Method in interface org.jboss.forge.projects.facets.WebResourceFacet
Get the given FileResource relative to the project Web Root directory: WebResourceFacet.getWebRootDirectory()
getWebRootDirectories() - Method in interface org.jboss.forge.projects.facets.WebResourceFacet
Get a list containing all possible Web Root DirectoryResources for the current project.
getWebRootDirectory() - Method in interface org.jboss.forge.projects.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.

H

hasDirectDependency(Dependency) - Method in interface org.jboss.forge.projects.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.projects.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.projects.facets.DependencyFacet
Return true if the given Dependency exists anywhere in the project dependency hierarchy.
hasEffectiveManagedDependency(Dependency) - Method in interface org.jboss.forge.projects.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.
hashCode() - Method in class org.jboss.forge.projects.AbstractProject
 
hasRepository(String) - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Return true if the given repository URL is already registered in this project's build system.

I

install(Project, Dependency) - Method in interface org.jboss.forge.projects.dependencies.DependencyInstaller
Install the given Dependency.
installManaged(Project, Dependency) - Method in interface org.jboss.forge.projects.dependencies.DependencyInstaller
Install a managed Dependency matching the given Dependency.
isInstalled(Project, Dependency) - Method in interface org.jboss.forge.projects.dependencies.DependencyInstaller
Returns true if the given Dependency.

M

MetadataFacet - Interface in org.jboss.forge.projects.facets
 

O

org.jboss.forge.projects - package org.jboss.forge.projects
 
org.jboss.forge.projects.building - package org.jboss.forge.projects.building
 
org.jboss.forge.projects.dependencies - package org.jboss.forge.projects.dependencies
 
org.jboss.forge.projects.events - package org.jboss.forge.projects.events
 
org.jboss.forge.projects.facets - package org.jboss.forge.projects.facets
 

P

PackagingChanged - Class in org.jboss.forge.projects.events
Fired when a Project is configured to produce a new PackagingFacet#getString()
PackagingChanged() - Constructor for class org.jboss.forge.projects.events.PackagingChanged
 
PackagingChanged(Project, String, String) - Constructor for class org.jboss.forge.projects.events.PackagingChanged
 
PackagingFacet - Interface in org.jboss.forge.projects.facets
A Facet representing this project's Packaging (JAR, WAR, EAR, etc...)
Project - Interface in org.jboss.forge.projects
Describes a set of Resource instances that represent a unit of work.
ProjectAssociationProvider - Interface in org.jboss.forge.projects
 
ProjectBuilder - Interface in org.jboss.forge.projects.building
Used to configure and execute the project build system.
projectCreated(Project) - Method in interface org.jboss.forge.projects.ProjectListener
 
ProjectFacet - Interface in org.jboss.forge.projects
A Facet specifically for use in Project instances.
ProjectFactory - Interface in org.jboss.forge.projects
Used to create new or obtain references to existing Project instances.
ProjectListener - Interface in org.jboss.forge.projects
Listens for project actions
ProjectLocator - Interface in org.jboss.forge.projects
Locates project root directories, and creates instances of projects for that type.
ProjectType - Interface in org.jboss.forge.projects
Provides additional project configuration for use during new project creation.

R

removeAttribute(Object) - Method in class org.jboss.forge.projects.AbstractProject
 
removeAttribute(Object) - Method in interface org.jboss.forge.projects.Project
Remove a value from this project's internal attributes.
removeDependency(Dependency) - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Remove the given Dependency from this facet's Project.
removeManagedDependency(Dependency) - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Remove the given managed Dependency from this facet's Project.
removeProperty(String) - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Remove a build property by name.
removeRepository(String) - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Remove the given DependencyRepository from the current project.
resolveAvailableVersions(Dependency) - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Given a Dependency with a populated groupId, versionId, and version range, identify the available Coordinate in all known repositories for this project.
resolveAvailableVersions(String) - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Given a groupid:versionid:version-range, identify and resolve all matching Coordinate in all known DependencyRepository instances for this Project.
resolveAvailableVersions(DependencyQuery) - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Using the given DependencyQuery, identify and resolve all matching Coordinate results in configured DependencyRepository instances for this Project.
resolveProperties(Dependency) - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Resolve properties in the given dependency, converting them to their actual values.
ResourceFacet - Interface in org.jboss.forge.projects.facets
 
runTests(boolean) - Method in interface org.jboss.forge.projects.building.ProjectBuilder
Enable or disable test execution during build.

S

setAttribute(Object, Object) - Method in class org.jboss.forge.projects.AbstractProject
 
setAttribute(Object, Object) - Method in interface org.jboss.forge.projects.Project
Set a value in this project's internal attributes.
setFinalName(String) - Method in interface org.jboss.forge.projects.facets.PackagingFacet
Set the final name of this project's build output artifact.
setPackagingType(String) - Method in interface org.jboss.forge.projects.facets.PackagingFacet
Set the packaging type currently in use by this project.
setProjectName(String) - Method in interface org.jboss.forge.projects.facets.MetadataFacet
 
setProjectVersion(String) - Method in interface org.jboss.forge.projects.facets.MetadataFacet
 
setProperty(String, String) - Method in interface org.jboss.forge.projects.facets.DependencyFacet
Set a build dependency property.
setTopLevelPackage(String) - Method in interface org.jboss.forge.projects.facets.MetadataFacet
 

W

WebResourceFacet - Interface in org.jboss.forge.projects.facets
A Facet containing APIs to interact with Java Web Projects
A B C D E F G H I M O P R S W 
Forge - Projects API 2.0.0.Alpha4

Copyright © 2013 JBoss by Red Hat. All Rights Reserved.