org.apache.maven.doxia.linkcheck.model
Class LinkcheckFile

java.lang.Object
  org.apache.maven.doxia.linkcheck.model.LinkcheckFile

All Implemented Interfaces:

Serializable

public class LinkcheckFile
extends Object
implements Serializable

The <file> to be checked.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

LinkcheckFile()

Method Summary

void	addResult(LinkcheckFileResult linkcheckFileResult) Method addResult.
boolean	equals(Object other) Method equals.
String	getAbsolutePath() Get The file to check as String Object.
int	getNumberOfLinks() Get the number of links for this file.
int	getNumberOfLinks(int level) Get the number of links for this file depending the level wanted.
String	getRelativePath() Get The relative path of the file.
List	getResults() Method getResults.
int	getSuccessful() Get The number of successful links in this file.
int	getUnsuccessful() Get The number of unsuccessful links in this file.
int	hashCode() Method hashCode.
void	removeResult(LinkcheckFileResult linkcheckFileResult) Method removeResult.
void	setAbsolutePath(String absolutePath) Set The file to check as String Object.
void	setRelativePath(String relativePath) Set The relative path of the file.
void	setResults(List results) Set All error details in this file.
void	setSuccessful(int successful) Set The number of successful links in this file.
void	setUnsuccessful(int unsuccessful) Set The number of unsuccessful links in this file.
String	toString() Method toString.

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkcheckFile

public LinkcheckFile()

Method Detail

addResult

public void addResult(LinkcheckFileResult linkcheckFileResult)

Method addResult.

Parameters:

linkcheckFileResult -

equals

public boolean equals(Object other)

Method equals.

Overrides:

equals in class Object

Parameters:

other -

Returns:

boolean

getAbsolutePath

public String getAbsolutePath()

Get The file to check as String Object.

Returns:

String

getRelativePath

public String getRelativePath()

Get The relative path of the file.

Returns:

String

getResults

public List getResults()

Method getResults.

Returns:

List

getSuccessful

public int getSuccessful()

Get The number of successful links in this file.

Returns:

int

getUnsuccessful

public int getUnsuccessful()

Get The number of unsuccessful links in this file.

Returns:

int

hashCode

public int hashCode()

Method hashCode.

Overrides:

hashCode in class Object

Returns:

int

removeResult

public void removeResult(LinkcheckFileResult linkcheckFileResult)

Method removeResult.

Parameters:

linkcheckFileResult -

setAbsolutePath

public void setAbsolutePath(String absolutePath)

Set The file to check as String Object.

Parameters:

absolutePath -

setRelativePath

public void setRelativePath(String relativePath)

Set The relative path of the file.

Parameters:

relativePath -

setResults

public void setResults(List results)

Set All error details in this file.

Parameters:

results -

setSuccessful

public void setSuccessful(int successful)

Set The number of successful links in this file.

Parameters:

successful -

setUnsuccessful

public void setUnsuccessful(int unsuccessful)

Set The number of unsuccessful links in this file.

Parameters:

unsuccessful -

toString

public String toString()

Method toString.

Overrides:

toString in class Object

Returns:

String

getNumberOfLinks

public int getNumberOfLinks(int level)

Get the number of links for this file depending the level wanted. LinkcheckFileResult.ERROR_LEVEL LinkcheckFileResult.UNKNOWN_LEVEL LinkcheckFileResult.VALID_LEVEL LinkcheckFileResult.WARNING_LEVEL

Parameters:

level - the restricted level

Returns:

the number of links for the restrict level, -1 if the level is not a valid one or no results was found.

Throws:

UnsupportedOperationException - if the level is unsupported.

getNumberOfLinks

public int getNumberOfLinks()

Get the number of links for this file.

Parameters:

level -

Returns: