Package org.apache.maven.plugins.dependency.utils.markers

Class SourcesFileMarkerHandler

java.lang.Object

org.apache.maven.plugins.dependency.utils.markers.DefaultFileMarkerHandler

org.apache.maven.plugins.dependency.utils.markers.SourcesFileMarkerHandler

All Implemented Interfaces:

MarkerHandler

public class SourcesFileMarkerHandler
extends DefaultFileMarkerHandler

Author:

Brian Fox

Field Summary

Fields inherited from class org.apache.maven.plugins.dependency.utils.markers.DefaultFileMarkerHandler

artifact, markerFilesDirectory

Constructor Summary

Constructors

Constructor	Description
SourcesFileMarkerHandler(File markerFilesDirectory)
SourcesFileMarkerHandler(org.apache.maven.artifact.Artifact artifact, File markerFilesDirectory, boolean isResolved)

Method Summary

Modifier and Type	Method	Description
boolean	clearMarker()	Deletes the file or directory denoted by this abstract pathname.
File	getMarkerFile()	Returns properly formatted File.
protected File	getMarkerFile(boolean res)	Get MarkerFile, exposed for unit testing purposes.
boolean	isMarkerOlder(org.apache.maven.artifact.Artifact theArtifact)
boolean	isMarkerSet()	Tests whether the file or directory denoted by this abstract pathname exists.
boolean	isResolved()
void	setMarker()
void	setResolved(boolean isResolved)

Methods inherited from class org.apache.maven.plugins.dependency.utils.markers.DefaultFileMarkerHandler

getArtifact, getMarkerFilesDirectory, setArtifact, setMarkerFilesDirectory

Methods inherited from class java.lang.Object

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

Constructor Details

SourcesFileMarkerHandler

public SourcesFileMarkerHandler(File markerFilesDirectory)

Parameters:

markerFilesDirectory - the marker files directory

SourcesFileMarkerHandler

public SourcesFileMarkerHandler(org.apache.maven.artifact.Artifact artifact,
 File markerFilesDirectory,
 boolean isResolved)

Parameters:

artifact - Artifact

markerFilesDirectory - marker files directory

isResolved - true/false

Method Details

getMarkerFile

public File getMarkerFile()

Returns properly formatted File.

Overrides:

getMarkerFile in class DefaultFileMarkerHandler

Returns:

file object for marker. The file is not guaranteed to exist.

getMarkerFile

protected File getMarkerFile(boolean res)

Get MarkerFile, exposed for unit testing purposes.

Parameters:

res - resolved or not

Returns:

marker file for this artifact

isMarkerSet

public boolean isMarkerSet()
                    throws org.apache.maven.plugin.MojoExecutionException

Tests whether the file or directory denoted by this abstract pathname exists.

Specified by:

isMarkerSet in interface MarkerHandler

Overrides:

isMarkerSet in class DefaultFileMarkerHandler

Returns:

true if and only if the file or directory denoted by this abstract pathname exists; false otherwise

Throws:

org.apache.maven.plugin.MojoExecutionException - if a security manager exists and its SecurityManager.checkRead(java.lang.String) method denies read access to the file or directory

isMarkerOlder

public boolean isMarkerOlder(org.apache.maven.artifact.Artifact theArtifact)
                      throws org.apache.maven.plugin.MojoExecutionException

Specified by:

isMarkerOlder in interface MarkerHandler

Overrides:

isMarkerOlder in class DefaultFileMarkerHandler

Parameters:

theArtifact - Artifact

Returns:

true/false

Throws:

org.apache.maven.plugin.MojoExecutionException - in case of an error

setMarker

public void setMarker()
               throws org.apache.maven.plugin.MojoExecutionException

Specified by:

setMarker in interface MarkerHandler

Overrides:

setMarker in class DefaultFileMarkerHandler

Throws:

org.apache.maven.plugin.MojoExecutionException - in case of an error

clearMarker

public boolean clearMarker()
                    throws org.apache.maven.plugin.MojoExecutionException

Deletes the file or directory denoted by this abstract pathname. If this pathname denotes a directory, then the directory must be empty in order to be deleted.

Specified by:

clearMarker in interface MarkerHandler

Overrides:

clearMarker in class DefaultFileMarkerHandler

Returns:

true if and only if the file or directory is successfully deleted; false otherwise

Throws:

SecurityException - if a security manager exists and its SecurityManager.checkDelete(java.lang.String) method denies delete access to the file

org.apache.maven.plugin.MojoExecutionException - in case of an error

isResolved

public boolean isResolved()

Returns:

returns the resolved

setResolved

public void setResolved(boolean isResolved)

Parameters:

isResolved - the resolved to set