org.apache.maven.plugin.linkcheck
Class LinkCheck

java.lang.Object
  extended byorg.apache.maven.plugin.linkcheck.LinkCheck

public final class LinkCheck
extends Object

The main bean to be called whenever a set of documents should have their links checked.

Version:
$Id: LinkCheck.java 532339 2007-04-25 12:28:56Z ltheussl $
Author:
Ben Walding, Carlos Sanchez, Arnaud Heritier

Constructor Summary
LinkCheck()
           
 
Method Summary
 void doExecute()
          Execute task.
 void findFiles(List allFiles, File base)
           
 File getBasedir()
          Get the base directory for the change log generator.
 String getCache()
          Returns the cacheFile.
 String getExclude()
          Returns the exclude.
 List getFiles()
           
 LinkValidatorManager getLinkValidatorManager()
           
 String getMethod()
           
 String getOutputEncoding()
          Returns the outputEncoding.
 Object getProject()
           
 void setBasedir(File base)
          Set the base directory for the change log generator.
 void setCache(String cache)
          Sets the cacheFile.
 void setExclude(String exclude)
          Sets the exclude, a string with exclude locations delimited by the space character, the comma character, the tab character, the newline character, the carriage-return character, and the form-feed character.
 void setMethod(String method)
           
 void setOutput(File output)
          Set the output file for the log.
 void setOutputEncoding(String outputEncoding)
          Sets the outputEncoding.
 void setProject(Object project)
          Sets the project.
 String toXML()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LinkCheck

public LinkCheck()
Method Detail

getBasedir

public File getBasedir()
Get the base directory for the change log generator.

Returns:
the base directory

setBasedir

public void setBasedir(File base)
Set the base directory for the change log generator.

Parameters:
base - the base directory

getCache

public String getCache()
Returns the cacheFile.

Returns:
String

setCache

public void setCache(String cache)
Sets the cacheFile.


getExclude

public String getExclude()
Returns the exclude.

Returns:
String

setExclude

public void setExclude(String exclude)
Sets the exclude, a string with exclude locations delimited by the space character, the comma character, the tab character, the newline character, the carriage-return character, and the form-feed character.

Parameters:
exclude - The exclude to set

getMethod

public String getMethod()
Returns:
the method

setMethod

public void setMethod(String method)
Parameters:
method - the method to set

getFiles

public List getFiles()

getLinkValidatorManager

public LinkValidatorManager getLinkValidatorManager()

setOutput

public void setOutput(File output)
Set the output file for the log.

Parameters:
output - the output file

getOutputEncoding

public String getOutputEncoding()
Returns the outputEncoding.

Returns:
String

setOutputEncoding

public void setOutputEncoding(String outputEncoding)
Sets the outputEncoding.

Parameters:
outputEncoding - The outputEncoding to set

getProject

public Object getProject()
Returns:
Project

setProject

public void setProject(Object project)
Sets the project.

Parameters:
project - The project to set

findFiles

public void findFiles(List allFiles,
                      File base)

doExecute

public void doExecute()
               throws FileNotFoundException,
                      IOException,
                      UnsupportedEncodingException
Execute task.

Throws:
FileNotFoundException - if ChangeLog#base doesn't exist
IOException - if there are problems running CVS
UnsupportedEncodingException - if the underlying platform doesn't support ISO-8859-1 encoding

toXML

public String toXML()


Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.