org.apache.maven.plugin.eclipse

Class EclipseSourceDir

java.lang.Object

org.apache.maven.plugin.eclipse.EclipseSourceDir

All Implemented Interfaces:

java.lang.Comparable

public class EclipseSourceDir
extends java.lang.Object
implements java.lang.Comparable

Represent an eclipse source dir. Eclipse has no "main", "test" or "resource" concepts, so two source dirs with the same path are equal.

source directories should always have a null output value.

Version:

$Id: EclipseSourceDir.java 1154368 2011-08-05 20:13:42Z rfscholte $

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List	exclude List
private boolean	filtering
private java.util.List	include List
private boolean	isResource
private java.lang.String	output source directories should always have a null output value.
private java.lang.String	path
private static java.lang.String	PATTERN_SEPARATOR
private boolean	test

Constructor Summary

Constructors

Constructor and Description
EclipseSourceDir(java.lang.String path, java.lang.String output, boolean isResource, boolean test, java.util.List include, java.util.List exclude, boolean filtering)

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object obj)
boolean	equals(java.lang.Object obj)
java.util.List	getExclude() Getter for exclude.
java.lang.String	getExcludeAsString()
java.util.List	getInclude() Getter for include.
java.lang.String	getIncludeAsString()
java.lang.String	getOutput() Getter for output.
java.lang.String	getPath() Getter for path.
int	hashCode()
boolean	isFiltering() Wheter this resource should be copied with filtering.
boolean	isResource() Getter for isResource.
boolean	isTest() Getter for test.
boolean	merge(EclipseSourceDir mergeWith) Merge with the provided directory.
void	setExclude(java.util.List exclude) Setter for exclude.
void	setFiltering(boolean filtering) Wheter this resource should be copied with filtering.
void	setInclude(java.util.List include) Setter for include.
void	setOutput(java.lang.String output) Setter for output.
void	setPath(java.lang.String path) Setter for path.
void	setTest(boolean test) Setter for test.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PATTERN_SEPARATOR

private static final java.lang.String PATTERN_SEPARATOR

See Also:

Constant Field Values

path

private java.lang.String path

output

private java.lang.String output

source directories should always have a null output value.

include

private java.util.List include

List

exclude

private java.util.List exclude

List

isResource

private boolean isResource

test

private boolean test

filtering

private boolean filtering

Constructor Detail

EclipseSourceDir

public EclipseSourceDir(java.lang.String path,
                        java.lang.String output,
                        boolean isResource,
                        boolean test,
                        java.util.List include,
                        java.util.List exclude,
                        boolean filtering)

Parameters:

path - the eclipse source directory

output - path output directory

isResource - true if the directory only contains resources, false if a compilation directory

test - true if is a test directory, false otherwise

include - a string in the eclipse pattern format for the include filter

exclude - a string in the eclipse pattern format for the exclude filter

filtering - true if filtering should be applied, false otherwise. Note: Filtering will only be applied if this become a "special directory" by being nested within the default output directory.

Method Detail

getExclude

public java.util.List getExclude()

Getter for exclude.

Returns:

Returns the exclude. Never null.

setExclude

public void setExclude(java.util.List exclude)

Setter for exclude.

Parameters:

exclude - The exclude to set.

getInclude

public java.util.List getInclude()

Getter for include.

Returns:

Returns the include. Never null.

setInclude

public void setInclude(java.util.List include)

Setter for include.

Parameters:

include - The include to set.

getExcludeAsString

public java.lang.String getExcludeAsString()

Returns:

Returns the exclude as a string pattern suitable for eclipse

getIncludeAsString

public java.lang.String getIncludeAsString()

Returns:

Returns the include as a string pattern suitable for eclipse

getOutput

public java.lang.String getOutput()

Getter for output.

source directories should always have a null output value.

Returns:

Returns the output.

setOutput

public void setOutput(java.lang.String output)

Setter for output.

Parameters:

output - The output to set.

getPath

public java.lang.String getPath()

Getter for path.

Returns:

Returns the path.

setPath

public void setPath(java.lang.String path)

Setter for path. Converts \\ to / in path.

Parameters:

path - The path to set.

isTest

public boolean isTest()

Getter for test.

Returns:

Returns the test.

setTest

public void setTest(boolean test)

Setter for test.

Parameters:

test - The test to set.

isResource

public boolean isResource()

Getter for isResource.

Returns:

Returns the isResource.

isFiltering

public boolean isFiltering()

Wheter this resource should be copied with filtering.

setFiltering

public void setFiltering(boolean filtering)

Wheter this resource should be copied with filtering.

Parameters:

filtering - filter resources

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

compareTo

public int compareTo(java.lang.Object obj)

Specified by:

compareTo in interface java.lang.Comparable

See Also:

Comparable.compareTo(java.lang.Object)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

merge

public boolean merge(EclipseSourceDir mergeWith)
              throws org.apache.maven.plugin.MojoExecutionException

Merge with the provided directory.

If one directory is a source and the other is a resource directory then the result will be a source directory and any includes or excludes will be removed since Eclipse has no "main", "test" or "resource" concepts. The output directory will be the source directories value.

If the two directories are the same resources type (i.e isResource is equal) then the result will be the same resource type with the includes from each merged together (duplicates will be removed), similarly for the excludes. No effort is made to ensure that the includes and excludes are disjointed sets. Please fix your pom instead.

No support for cases where the test, or filtering values are not identical.

Parameters:

mergeWith - the directory to merge with

Throws:

org.apache.maven.plugin.MojoExecutionException - test or filtering values are not identical, or isResource true and output are not identical