MavenProject (SciJava Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.minimaven.MavenProject

All Implemented Interfaces:

Comparable<MavenProject>
```
public class MavenProject
extends Object
implements Comparable<MavenProject>
```
This class represents a parsed pom.xml file.
Every pom.xml file is parsed into an instance of this class; the tree of projects shares a BuildEnvironment instance.

Author:

Johannes Schindelin

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`buildFromSource`
`protected boolean`	`built`
`protected MavenProject[]`	`children`
`protected Coordinate`	`coordinate`
`protected List<Coordinate>`	`dependencies`
`protected List<Coordinate>`	`dependencyManagement`
`protected File`	`directory`
`protected BuildEnvironment`	`env`
`protected boolean`	`includeImplementationBuild`
`protected String`	`mainClass`
`protected List<String>`	`modules`
`protected String`	`packaging`
`protected MavenProject`	`parent`
`protected Coordinate`	`parentCoordinate`
`protected Map<String,String>`	`properties`
`protected Set<String>`	`repositories`
`protected String`	`sourceDirectory`
`protected String`	`sourceVersion`
`protected File`	`target`
`protected String`	`targetVersion`

Constructor Summary

Constructors
Modifier Constructor and Description

protected MavenProject(BuildEnvironment miniMaven, File directory, MavenProject parent)

Constructors
Modifier	Constructor and Description
`protected`	`MavenProject(BuildEnvironment miniMaven, File directory, MavenProject parent)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected MavenProject`	`addChild(MavenProject child)`
`protected MavenProject`	`addModule(String name)`
`protected long`	`addRecursively(List<String> list, File directory, String extension, File targetDirectory, String targetExtension, boolean includeUpToDates)`
`protected void`	`addToJarRecursively(JarOutputStream out, File directory, String prefix)`
`void`	`append(StringBuilder builder, String indent)`
`protected boolean`	`arrayContainsString(String[] array, String key)`
`void`	`build()` Compiles the project.
`void`	`build(boolean makeJar)` Compiles the project and optionally builds the .jar artifact.
`void`	`build(boolean makeJar, boolean forceBuild)` Compiles the project and optionally builds the .jar artifact.
`void`	`build(boolean makeJar, boolean forceBuild, boolean includeSources)` Compiles the project and optionally builds the .jar artifact.
`void`	`buildAndInstall()` Builds the artifact and installs it and its dependencies into ${imagej.app.directory}.
`void`	`buildAndInstall(File ijDir)` Builds the project an its dependencies, and installs them into the given ImageJ.app/ directory structure.
`void`	`buildAndInstall(File ijDir, boolean forceBuild)` Builds the project an its dependencies, and installs them into the given ImageJ.app/ directory structure.
`void`	`buildJar()` Builds the artifact.
`protected MavenProject`	`cacheAndReturn(String key, MavenProject pom)`
`protected void`	`checkParentTag(String tag, String string1, String string2)`
`boolean`	`checkUpToDate(boolean includingJar)`
`void`	`clean()`
`void`	`clean(File ijDir)`
`int`	`compareTo(MavenProject other)`
`void`	`copyDependencies(File directory, boolean onlyNewer)` Copy the runtime dependencies
`protected void`	`download()`
`protected void`	`download(Coordinate dependency, boolean quiet)`
`void`	`downloadDependencies()`
`boolean`	`equals(Object other)`
`Coordinate`	`expand(Coordinate dependency)`
`String`	`expand(String string)`
`protected MavenProject`	`findInMultiProjects(Coordinate dependency)`
`protected String`	`findLocallyCachedVersion(String path)`
`MavenProject`	`findPOM(Coordinate dependency, boolean quiet, boolean downloadAutomatically)`
`String`	`getArtifactId()`
`boolean`	`getBuildFromSource()`
`MavenProject[]`	`getChildren()`
`String`	`getClassPath(boolean forCompile)`
`Coordinate`	`getCoordinate()`
`Set<MavenProject>`	`getDependencies()`
`Set<MavenProject>`	`getDependencies(boolean excludeOptionals, boolean downloadAutomatically, String... excludeScopes)`
`void`	`getDependencies(Set<MavenProject> result, boolean excludeOptionals, boolean downloadAutomatically, Set<String> exclusions, String... excludeScopes)`
`List<Coordinate>`	`getDirectDependencies()`
`File`	`getDirectory()`
`String`	`getGAV()`
`String`	`getGroupId()`
`String`	`getJarName()`
`String`	`getMainClass()`
`String`	`getPackaging()`
`MavenProject`	`getParent()`
`String`	`getProperty(String key)` Returns the (possibly project-specific) value of a property.
`protected Set<String>`	`getRepositories()`
`protected void`	`getRepositories(Set<String> result)`
`MavenProject`	`getRoot()`
`File`	`getSourceDirectory()`
`String`	`getSourcePath()`
`File`	`getTarget()`
`String`	`getVersion()`
`int`	`hashCode()`
`boolean`	`isJAR()` True iff artifact is a JAR file (i.e., `getPackaging()` is "jar" or "bundle").
`protected boolean`	`maybeDownloadAutomatically(Coordinate dependency, boolean quiet, boolean downloadAutomatically)`
`String`	`toString()`
`protected long`	`updateRecursively(File source, File target, boolean dryRun)`
`boolean`	`upToDate(boolean includingJar)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

env
```
protected final BuildEnvironment env
```

buildFromSource
```
protected boolean buildFromSource
```

built
```
protected boolean built
```

directory
```
protected File directory
```

target
```
protected File target
```

sourceDirectory
```
protected String sourceDirectory
```

parent
```
protected MavenProject parent
```

children
```
protected MavenProject[] children
```

coordinate
```
protected Coordinate coordinate
```

parentCoordinate
```
protected Coordinate parentCoordinate
```

properties

protected Map<String,String> properties

modules
```
protected List<String> modules
```

dependencies

protected List<Coordinate> dependencies

dependencyManagement

protected List<Coordinate> dependencyManagement

repositories
```
protected Set<String> repositories
```

sourceVersion
```
protected String sourceVersion
```

targetVersion
```
protected String targetVersion
```

mainClass
```
protected String mainClass
```

includeImplementationBuild

protected boolean includeImplementationBuild

packaging
```
protected String packaging
```

Constructor Detail

MavenProject

protected MavenProject(BuildEnvironment miniMaven,
                       File directory,
                       MavenProject parent)

Method Detail

addModule

protected MavenProject addModule(String name)
                          throws IOException,
                                 ParserConfigurationException,
                                 SAXException

Throws:: IOException; ParserConfigurationException; SAXException

addChild

protected MavenProject addChild(MavenProject child)

clean

public void clean()
           throws IOException,
                  ParserConfigurationException,
                  SAXException

Throws:: IOException; ParserConfigurationException; SAXException

clean

public void clean(File ijDir)
           throws IOException,
                  ParserConfigurationException,
                  SAXException

Throws:: IOException; ParserConfigurationException; SAXException

downloadDependencies

public void downloadDependencies()
                          throws IOException,
                                 ParserConfigurationException,
                                 SAXException

Throws:: IOException; ParserConfigurationException; SAXException

download

protected void download()
                 throws FileNotFoundException

Throws:: FileNotFoundException

download

protected void download(Coordinate dependency,
                        boolean quiet)
                 throws FileNotFoundException

Throws:: FileNotFoundException

upToDate

public boolean upToDate(boolean includingJar)
                 throws IOException,
                        ParserConfigurationException,
                        SAXException

Throws:: IOException; ParserConfigurationException; SAXException

checkUpToDate

public boolean checkUpToDate(boolean includingJar)
                      throws IOException,
                             ParserConfigurationException,
                             SAXException

Throws:: IOException; ParserConfigurationException; SAXException

getSourceDirectory
```
public File getSourceDirectory()
```

getSourcePath
```
public String getSourcePath()
```

addToJarRecursively

protected void addToJarRecursively(JarOutputStream out,
                                   File directory,
                                   String prefix)
                            throws IOException

Throws:: IOException

buildAndInstall

public void buildAndInstall()
                     throws JavaCompiler.CompileError,
                            IOException,
                            ParserConfigurationException,
                            SAXException

Builds the artifact and installs it and its dependencies into ${imagej.app.directory}.

If the property imagej.app.directory does not point to a valid directory, the install step is skipped.

Throws:: JavaCompiler.CompileError; IOException; ParserConfigurationException; SAXException

buildAndInstall
```
public void buildAndInstall(File ijDir)
                     throws JavaCompiler.CompileError,
                            IOException,
                            ParserConfigurationException,
                            SAXException
```
Builds the project an its dependencies, and installs them into the given ImageJ.app/ directory structure.
If the property imagej.app.directory does not point to a valid directory, the install step is skipped.

Parameters:

ijDir - the ImageJ.app/ directory

Throws:

JavaCompiler.CompileError

IOException

ParserConfigurationException

SAXException

buildAndInstall
```
public void buildAndInstall(File ijDir,
                            boolean forceBuild)
                     throws JavaCompiler.CompileError,
                            IOException,
                            ParserConfigurationException,
                            SAXException
```
Builds the project an its dependencies, and installs them into the given ImageJ.app/ directory structure.
If the property imagej.app.directory does not point to a valid directory, the install step is skipped.

Parameters:

ijDir - the ImageJ.app/ directory

forceBuild - recompile even if the artifact is up-to-date

Throws:

JavaCompiler.CompileError

IOException

ParserConfigurationException

SAXException

buildJar

public void buildJar()
              throws JavaCompiler.CompileError,
                     IOException,
                     ParserConfigurationException,
                     SAXException

Builds the artifact.

Throws:: JavaCompiler.CompileError; IOException; ParserConfigurationException; SAXException

build

public void build()
           throws JavaCompiler.CompileError,
                  IOException,
                  ParserConfigurationException,
                  SAXException

Compiles the project.

Throws:: JavaCompiler.CompileError; IOException; ParserConfigurationException; SAXException

build

public void build(boolean makeJar)
           throws JavaCompiler.CompileError,
                  IOException,
                  ParserConfigurationException,
                  SAXException

Compiles the project and optionally builds the .jar artifact.

Parameters:: makeJar - build a .jar file
Throws:: JavaCompiler.CompileError; IOException; ParserConfigurationException; SAXException

build

public void build(boolean makeJar,
                  boolean forceBuild)
           throws JavaCompiler.CompileError,
                  IOException,
                  ParserConfigurationException,
                  SAXException

Compiles the project and optionally builds the .jar artifact.

Parameters:: makeJar - build a .jar file; forceBuild - for recompilation even if the artifact is up-to-date
Throws:: JavaCompiler.CompileError; IOException; ParserConfigurationException; SAXException

build

public void build(boolean makeJar,
                  boolean forceBuild,
                  boolean includeSources)
           throws JavaCompiler.CompileError,
                  IOException,
                  ParserConfigurationException,
                  SAXException

Compiles the project and optionally builds the .jar artifact.

Parameters:: makeJar - build a .jar file; forceBuild - for recompilation even if the artifact is up-to-date; includeSources - include sources if building a .jar file
Throws:: JavaCompiler.CompileError; IOException; ParserConfigurationException; SAXException

addRecursively

protected long addRecursively(List<String> list,
                              File directory,
                              String extension,
                              File targetDirectory,
                              String targetExtension,
                              boolean includeUpToDates)

updateRecursively

protected long updateRecursively(File source,
                                 File target,
                                 boolean dryRun)
                          throws IOException

Throws:: IOException

getCoordinate
```
public Coordinate getCoordinate()
```

getGAV
```
public String getGAV()
```

getGroupId
```
public String getGroupId()
```

getArtifactId
```
public String getArtifactId()
```

getVersion
```
public String getVersion()
```

getJarName
```
public String getJarName()
```

getMainClass
```
public String getMainClass()
```

getPackaging
```
public String getPackaging()
```

isJAR
```
public boolean isJAR()
```
True iff artifact is a JAR file (i.e., getPackaging() is "jar" or "bundle").

getTarget
```
public File getTarget()
```

getDirectory
```
public File getDirectory()
```

getBuildFromSource
```
public boolean getBuildFromSource()
```

getClassPath

public String getClassPath(boolean forCompile)
                    throws IOException,
                           ParserConfigurationException,
                           SAXException

Throws:: IOException; ParserConfigurationException; SAXException

copyDependencies

public void copyDependencies(File directory,
                             boolean onlyNewer)
                      throws IOException,
                             ParserConfigurationException,
                             SAXException

Copy the runtime dependencies

Parameters:: directory - where to copy the files to; onlyNewer - whether to copy the files only if the sources are newer
Throws:: IOException; ParserConfigurationException; SAXException

getDependencies

public Set<MavenProject> getDependencies()
                                  throws IOException,
                                         ParserConfigurationException,
                                         SAXException

Throws:: IOException; ParserConfigurationException; SAXException

getDependencies

public Set<MavenProject> getDependencies(boolean excludeOptionals,
                                         boolean downloadAutomatically,
                                         String... excludeScopes)
                                  throws IOException,
                                         ParserConfigurationException,
                                         SAXException

Throws:: IOException; ParserConfigurationException; SAXException

getDependencies

public void getDependencies(Set<MavenProject> result,
                            boolean excludeOptionals,
                            boolean downloadAutomatically,
                            Set<String> exclusions,
                            String... excludeScopes)
                     throws IOException,
                            ParserConfigurationException,
                            SAXException

Throws:: IOException; ParserConfigurationException; SAXException

getDirectDependencies

public List<Coordinate> getDirectDependencies()

arrayContainsString

protected boolean arrayContainsString(String[] array,
                                      String key)

expand

public Coordinate expand(Coordinate dependency)

expand
```
public String expand(String string)
```

getProperty
```
public String getProperty(String key)
```
Returns the (possibly project-specific) value of a property.
System properties override project-specific properties to allow the user to overrule a setting by specifying it on the command-line.

Parameters:

key - the name of the property

Returns:

the value of the property

getParent
```
public MavenProject getParent()
```

getChildren
```
public MavenProject[] getChildren()
```

getRoot
```
public MavenProject getRoot()
```

getRepositories

protected Set<String> getRepositories()

getRepositories

protected void getRepositories(Set<String> result)

findPOM

public MavenProject findPOM(Coordinate dependency,
                            boolean quiet,
                            boolean downloadAutomatically)
                     throws IOException,
                            ParserConfigurationException,
                            SAXException

Throws:: IOException; ParserConfigurationException; SAXException

findInMultiProjects

protected MavenProject findInMultiProjects(Coordinate dependency)
                                    throws IOException,
                                           ParserConfigurationException,
                                           SAXException

Throws:: IOException; ParserConfigurationException; SAXException

cacheAndReturn

protected MavenProject cacheAndReturn(String key,
                                      MavenProject pom)

maybeDownloadAutomatically

protected boolean maybeDownloadAutomatically(Coordinate dependency,
                                             boolean quiet,
                                             boolean downloadAutomatically)

findLocallyCachedVersion

protected String findLocallyCachedVersion(String path)
                                   throws IOException

Throws:: IOException

checkParentTag

protected void checkParentTag(String tag,
                              String string1,
                              String string2)

compareTo
```
public int compareTo(MavenProject other)
```
Specified by:

compareTo in interface Comparable<MavenProject>

equals
```
public boolean equals(Object other)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

append

public void append(StringBuilder builder,
                   String indent)

Class MavenProject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

env

buildFromSource

built

directory

target

sourceDirectory

parent

children

coordinate

parentCoordinate

properties

modules

dependencies

dependencyManagement

repositories

sourceVersion

targetVersion

mainClass

includeImplementationBuild

packaging

Constructor Detail

MavenProject

Method Detail

addModule

addChild

clean

clean

downloadDependencies

download

download

upToDate

checkUpToDate

getSourceDirectory

getSourcePath

addToJarRecursively

buildAndInstall

buildAndInstall

buildAndInstall

buildJar

build

build

build

build

addRecursively

updateRecursively

getCoordinate

getGAV

getGroupId

getArtifactId

getVersion

getJarName

getMainClass

getPackaging

isJAR

getTarget

getDirectory

getBuildFromSource

getClassPath

copyDependencies

getDependencies

getDependencies

getDependencies

getDirectDependencies

arrayContainsString

expand

expand

getProperty

getParent

getChildren

getRoot

getRepositories

getRepositories

findPOM

findInMultiProjects