org.apache.jackrabbit.filevault.maven.packaging

Class ImportPackageBuilder

java.lang.Object

org.apache.jackrabbit.filevault.maven.packaging.ImportPackageBuilder

public class ImportPackageBuilder
extends Object

The import package builder is used to analyze the classes and dependencies of the project and calculate the import-package statement for this package.

Constructor Summary

Constructors

Constructor and Description
ImportPackageBuilder()

Method Summary

Modifier and Type	Method and Description
ImportPackageBuilder	analyze() analyzes the imports
String	createExportPackageReport() generates a package report
Map<String,aQute.bnd.header.Attrs>	getImportParameters() returns the import parameter header.
ImportPackageBuilder	withClassFileDirectory(File classes) Sets the class files directory
ImportPackageBuilder	withDependenciesFromProject(org.apache.maven.project.MavenProject project) defines the project from which the artifacts should be loaded.
ImportPackageBuilder	withFilter(org.apache.maven.artifact.resolver.filter.ArtifactFilter filter) defines the filter for the project artifact
ImportPackageBuilder	withIncludeUnused(boolean includeUnused) defines if unused packages should be included if no classes exist in the project.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImportPackageBuilder

public ImportPackageBuilder()

Method Detail

withClassFileDirectory

@Nonnull
public ImportPackageBuilder withClassFileDirectory(File classes)

Sets the class files directory

Parameters:

classes - the directory

Returns:

this.

withDependenciesFromProject

@Nonnull
public ImportPackageBuilder withDependenciesFromProject(@Nonnull
                                                                 org.apache.maven.project.MavenProject project)

defines the project from which the artifacts should be loaded. The current implementation requires the filter to be set before calling this method.

Parameters:

project - the maven project

Returns:

this

withIncludeUnused

@Nonnull
public ImportPackageBuilder withIncludeUnused(boolean includeUnused)

defines if unused packages should be included if no classes exist in the project.

Parameters:

includeUnused - true to include unused.

Returns:

this

withFilter

@Nonnull
public ImportPackageBuilder withFilter(@Nonnull
                                                org.apache.maven.artifact.resolver.filter.ArtifactFilter filter)

defines the filter for the project artifact

Parameters:

filter - the filter

Returns:

this

analyze

@Nonnull
public ImportPackageBuilder analyze()
                                      throws IOException

analyzes the imports

Returns:

this

Throws:

IOException - if an error occurrs.

getImportParameters

@Nonnull
public Map<String,aQute.bnd.header.Attrs> getImportParameters()

returns the import parameter header. only available after analyze()

Returns:

the parameters

createExportPackageReport

@Nonnull
public String createExportPackageReport()

generates a package report

Returns:

the report