SourcesFileMarkerHandler (Apache Maven Dependency Plugin 2.10 API)

java.lang.Object
- org.apache.maven.plugin.dependency.utils.markers.DefaultFileMarkerHandler
- - org.apache.maven.plugin.dependency.utils.markers.SourcesFileMarkerHandler

All Implemented Interfaces:

MarkerHandler
```
public class SourcesFileMarkerHandler
extends DefaultFileMarkerHandler
```
Version:

$Id: SourcesFileMarkerHandler.html 937155 2015-01-21 21:53:50Z khmarbaise $

Author:

Brian Fox

Field Summary
- Fields inherited from class org.apache.maven.plugin.dependency.utils.markers.DefaultFileMarkerHandler
  artifact, markerFilesDirectory

Constructor Summary

Constructors
Constructor and Description
`SourcesFileMarkerHandler(Artifact artifact, File markerFilesDirectory, boolean isResolved)`
`SourcesFileMarkerHandler(File markerFilesDirectory)`

Method Summary

Methods
Modifier and Type	Method and 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(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.plugin.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 Detail
  - SourcesFileMarkerHandler
```
public SourcesFileMarkerHandler(File markerFilesDirectory)
```
  - SourcesFileMarkerHandler
```
public SourcesFileMarkerHandler(Artifact artifact,
                        File markerFilesDirectory,
                        boolean isResolved)
```
- Method Detail
  - 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 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:
    
    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(Artifact theArtifact)
                      throws MojoExecutionException
```
    Specified by:
    
    isMarkerOlder in interface MarkerHandler
    
    Overrides:
    
    isMarkerOlder in class DefaultFileMarkerHandler
    
    Throws:
    
    MojoExecutionException
  - setMarker
```
public void setMarker()
               throws MojoExecutionException
```
    Specified by:
    
    setMarker in interface MarkerHandler
    
    Overrides:
    
    setMarker in class DefaultFileMarkerHandler
    
    Throws:
    
    MojoExecutionException
  - clearMarker
```
public boolean clearMarker()
                    throws 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
    
    MojoExecutionException
  - isResolved
```
public boolean isResolved()
```
    Returns:
    Returns the resolved.
  - setResolved
```
public void setResolved(boolean isResolved)
```
    Parameters:
    isResolved - The resolved to set.

Class SourcesFileMarkerHandler

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

SourcesFileMarkerHandler

SourcesFileMarkerHandler

Method Detail

getMarkerFile

getMarkerFile

isMarkerSet

isMarkerOlder

setMarker

clearMarker

isResolved

setResolved