org.jboss.forge.addon.projects.facets

Interface PackagingFacet

All Superinterfaces:

Facet<Project>, ProjectFacet, ProvidedProjectFacet

public interface PackagingFacet
extends ProvidedProjectFacet

A Facet representing this project's Packaging (JAR, WAR, EAR, etc...)

Author:

Lincoln Baxter, III

Method Summary

Methods

Modifier and Type	Method and Description
ProjectBuilder	createBuilder() Return a new ProjectBuilder instance.
Resource<?>	executeBuild(String... args) Trigger the underlying build system to perform a build with the given arguments or flags.
Resource<?>	getFinalArtifact() Return the resource representing the fully built output artifact of this project.
String	getFinalName() Get the final name of this project's build output artifact.
String	getPackagingType() Get the packaging type currently in use by this project.
void	setFinalName(String finalName) Set the final name of this project's build output artifact.
void	setPackagingType(String type) Set the packaging type currently in use by this project.

Methods inherited from interface org.jboss.forge.addon.facets.Facet

getFaceted, install, isInstalled, uninstall

Method Detail

setPackagingType

void setPackagingType(String type)

Set the packaging type currently in use by this project. For example, JAR, WAR,... etc.

getPackagingType

String getPackagingType()

Get the packaging type currently in use by this project. For example, JAR, WAR,... etc.

getFinalArtifact

Resource<?> getFinalArtifact()

Return the resource representing the fully built output artifact of this project. For example, if the project builds a JAR file, this method must return the Resource representing that JAR file.

createBuilder

ProjectBuilder createBuilder()

Return a new ProjectBuilder instance. This object is responsible for executing a build with custom options.

executeBuild

Resource<?> executeBuild(String... args)

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

Returns:

The final build artifact if building succeeded, otherwise return null

See Also:

#getFinalArtifact()}

getFinalName

String getFinalName()

Get the final name of this project's build output artifact. This represents the name without file extension.

setFinalName

void setFinalName(String finalName)

Set the final name of this project's build output artifact. This represents the name without file extension.