org.jboss.shrinkwrap.resolver.api.maven.embedded

Interface BuiltProject

public interface BuiltProject

Author:

Matous Jobanek

Method Summary

Modifier and Type	Method and Description
List<org.jboss.shrinkwrap.api.Archive>	getArchives() Returns a list of all supported Archives found in the first level of the build target directory.
<A extends org.jboss.shrinkwrap.api.Archive<?>> List<A>	getArchives(Class<A> type) Returns a list of all Archives of the given type of Archive found in the first level of the build target directory.
org.jboss.shrinkwrap.api.Archive	getDefaultBuiltArchive() Tries to find an Archive with a default name.
int	getMavenBuildExitCode() Returns an exit code of a Maven build set for this instance.
String	getMavenLog() Returns a log of a Maven build of this project.
org.apache.maven.model.Model	getModel() Returns an instance of Model representing the set and parsed POM file
BuiltProject	getModule(String moduleName) Returns an instance of BuiltProject representing module with the given name.
List<BuiltProject>	getModules() Returns a list of instances of BuiltProject representing all modules specified in the POM file.
File	getTargetDirectory() Returns a File representing a build target directory
void	setMavenBuildExitCode(int mavenBuildExitCode) Sets the given exit code of a Maven build for this instance.
void	setMavenLog(String mavenLog) Sets the given log a Maven build for this instance

Method Detail

getDefaultBuiltArchive

org.jboss.shrinkwrap.api.Archive getDefaultBuiltArchive()

Tries to find an Archive with a default name.

As a "default archive name" is understood:

• either combination of artifactId + version + packaging suffix
• or a finalName set in <build> section of project's POM file + packaging suffix

If no archive with a corresponding name is found, then null is returned

Returns:

An Archive with a default name. If no archive is found then null is returned

getModule

BuiltProject getModule(String moduleName)

Returns an instance of BuiltProject representing module with the given name. The name has to equal to the string specified in current project POM file

Parameters:

moduleName - Name of the required module

Returns:

An instance of BuiltProject representing module with the given name.

getModules

List<BuiltProject> getModules()

Returns a list of instances of BuiltProject representing all modules specified in the POM file.

Returns:

A list of instances of BuiltProject representing all modules specified in the POM file.

getTargetDirectory

File getTargetDirectory()

Returns a File representing a build target directory

Returns:

A File representing a build target directory

getArchives

List<org.jboss.shrinkwrap.api.Archive> getArchives()

Returns a list of all supported Archives found in the first level of the build target directory. If no target directory is present then null is returned.

Returns:

A list of all supported Archives found in the first level of the build target directory. If no target directory is present then null is returned.

getArchives

<A extends org.jboss.shrinkwrap.api.Archive<?>> List<A> getArchives(Class<A> type)

Returns a list of all Archives of the given type of Archive found in the first level of the build target directory. If no target directory is present then null is returned.

Type Parameters:

A - The required type of Archive

Parameters:

type - The required type of Archive

Returns:

A list of all Archives of the given type of Archive found in the first level of the build target directory. If no target directory is present then null is returned.

getModel

org.apache.maven.model.Model getModel()

Returns an instance of Model representing the set and parsed POM file

Returns:

An instance of Model representing the set and parsed POM file

getMavenLog

String getMavenLog()

Returns a log of a Maven build of this project. If no log has been retrieved and set, then null is returned.

NOTE: Please be aware that if you retrieve this instance of BuiltProject from the EmbeddedMaven build and you use the method EmbeddedMaven.withMavenInvokerSet(InvocationRequest, Invoker) for it, then no Maven log is set by default and this method returns null!

Returns:

A log of a Maven build of this project. If no log has been retrieved and set, then null is returned.

setMavenLog

void setMavenLog(String mavenLog)

Sets the given log a Maven build for this instance

Parameters:

mavenLog - The log of a Maven build to be set

getMavenBuildExitCode

int getMavenBuildExitCode()

Returns an exit code of a Maven build set for this instance. Default value is 0

Returns:

An exit code of a Maven build set for this instance. Default value is 0

setMavenBuildExitCode

void setMavenBuildExitCode(int mavenBuildExitCode)

Sets the given exit code of a Maven build for this instance. Default value is 0

Parameters:

mavenBuildExitCode - The exit code of a Maven build to be set. Default value is 0