org.apache.maven.doxia.linkcheck.model.LinkcheckFile Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of doxia-linkcheck Show documentation
Show all versions of doxia-linkcheck Show documentation
Doxia linkcheck is a tool to check the validity of links
/*
* $Id$
*/
package org.apache.maven.doxia.linkcheck.model;
//---------------------------------/
//- Imported classes and packages -/
//---------------------------------/
import java.util.Date;
/**
*
* The <file> to be checked.
*
*
* @version $Revision$ $Date$
*/
public class LinkcheckFile
implements java.io.Serializable
{
//--------------------------/
//- Class/Member Variables -/
//--------------------------/
/**
*
* The file to check as String Object.
*
*/
private String absolutePath;
/**
*
* The relative path of the file.
*
*/
private String relativePath;
/**
*
* The number of successful links in this file.
*
*/
private int successful = -1;
/**
*
* The number of unsuccessful links in this file.
*
*/
private int unsuccessful = -1;
/**
* Field results.
*/
private java.util.List/**/ results;
//-----------/
//- Methods -/
//-----------/
/**
* Method addResult.
*
* @param linkcheckFileResult
*/
public void addResult( LinkcheckFileResult linkcheckFileResult )
{
if ( !(linkcheckFileResult instanceof LinkcheckFileResult) )
{
throw new ClassCastException( "LinkcheckFile.addResults(linkcheckFileResult) parameter must be instanceof " + LinkcheckFileResult.class.getName() );
}
getResults().add( linkcheckFileResult );
} //-- void addResult( LinkcheckFileResult )
/**
* Method equals.
*
* @param other
* @return boolean
*/
public boolean equals( Object other )
{
if ( this == other )
{
return true;
}
if ( !( other instanceof LinkcheckFile ) )
{
return false;
}
LinkcheckFile that = (LinkcheckFile) other;
boolean result = true;
result = result && ( getAbsolutePath() == null ? that.getAbsolutePath() == null : getAbsolutePath().equals( that.getAbsolutePath() ) );
result = result && ( getRelativePath() == null ? that.getRelativePath() == null : getRelativePath().equals( that.getRelativePath() ) );
result = result && successful == that.successful;
result = result && unsuccessful == that.unsuccessful;
result = result && ( getResults() == null ? that.getResults() == null : getResults().equals( that.getResults() ) );
return result;
} //-- boolean equals( Object )
/**
* Get
* The file to check as String Object.
*
*
* @return String
*/
public String getAbsolutePath()
{
return this.absolutePath;
} //-- String getAbsolutePath()
/**
* Get
* The relative path of the file.
*
*
* @return String
*/
public String getRelativePath()
{
return this.relativePath;
} //-- String getRelativePath()
/**
* Method getResults.
*
* @return List
*/
public java.util.List/**/ getResults()
{
if ( this.results == null )
{
this.results = new java.util.ArrayList/**/();
}
return this.results;
} //-- java.util.List/**/ getResults()
/**
* Get
* The number of successful links in this file.
*
*
* @return int
*/
public int getSuccessful()
{
return this.successful;
} //-- int getSuccessful()
/**
* Get
* The number of unsuccessful links in this file.
*
*
* @return int
*/
public int getUnsuccessful()
{
return this.unsuccessful;
} //-- int getUnsuccessful()
/**
* Method hashCode.
*
* @return int
*/
public int hashCode()
{
int result = 17;
result = 37 * result + ( absolutePath != null ? absolutePath.hashCode() : 0 );
result = 37 * result + ( relativePath != null ? relativePath.hashCode() : 0 );
result = 37 * result + (int) successful;
result = 37 * result + (int) unsuccessful;
result = 37 * result + ( results != null ? results.hashCode() : 0 );
return result;
} //-- int hashCode()
/**
* Method removeResult.
*
* @param linkcheckFileResult
*/
public void removeResult( LinkcheckFileResult linkcheckFileResult )
{
if ( !(linkcheckFileResult instanceof LinkcheckFileResult) )
{
throw new ClassCastException( "LinkcheckFile.removeResults(linkcheckFileResult) parameter must be instanceof " + LinkcheckFileResult.class.getName() );
}
getResults().remove( linkcheckFileResult );
} //-- void removeResult( LinkcheckFileResult )
/**
* Set
* The file to check as String Object.
*
*
* @param absolutePath
*/
public void setAbsolutePath( String absolutePath )
{
this.absolutePath = absolutePath;
} //-- void setAbsolutePath( String )
/**
* Set
* The relative path of the file.
*
*
* @param relativePath
*/
public void setRelativePath( String relativePath )
{
this.relativePath = relativePath;
} //-- void setRelativePath( String )
/**
* Set
* All error details in this file.
*
*
* @param results
*/
public void setResults( java.util.List/**/ results )
{
this.results = results;
} //-- void setResults( java.util.List )
/**
* Set
* The number of successful links in this file.
*
*
* @param successful
*/
public void setSuccessful( int successful )
{
this.successful = successful;
} //-- void setSuccessful( int )
/**
* Set
* The number of unsuccessful links in this file.
*
*
* @param unsuccessful
*/
public void setUnsuccessful( int unsuccessful )
{
this.unsuccessful = unsuccessful;
} //-- void setUnsuccessful( int )
/**
* Method toString.
*
* @return String
*/
public java.lang.String toString()
{
StringBuffer buf = new StringBuffer();
buf.append( "absolutePath = '" );
buf.append( getAbsolutePath() );
buf.append( "'" );
buf.append( "\n" );
buf.append( "relativePath = '" );
buf.append( getRelativePath() );
buf.append( "'" );
buf.append( "\n" );
buf.append( "successful = '" );
buf.append( getSuccessful() );
buf.append( "'" );
buf.append( "\n" );
buf.append( "unsuccessful = '" );
buf.append( getUnsuccessful() );
buf.append( "'" );
buf.append( "\n" );
buf.append( "results = '" );
buf.append( getResults() );
buf.append( "'" );
return buf.toString();
} //-- java.lang.String toString()
/**
* Get the number of links for this file depending the level wanted.
*
* {@link LinkcheckFileResult#ERROR_LEVEL}
* {@link LinkcheckFileResult#UNKNOWN_LEVEL}
* {@link LinkcheckFileResult#VALID_LEVEL}
* {@link LinkcheckFileResult#WARNING_LEVEL}
*
* @param level the restricted level
* @return 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.
*/
public int getNumberOfLinks( int level )
{
if ( results == null )
{
return -1;
}
if ( !( level == LinkcheckFileResult.ERROR_LEVEL || level == LinkcheckFileResult.WARNING_LEVEL
|| level == LinkcheckFileResult.VALID_LEVEL || level == LinkcheckFileResult.UNKNOWN_LEVEL ) )
{
throw new UnsupportedOperationException( "This level [" + level + "] is unsupported." );
}
int number = 0;
for ( java.util.Iterator it = results.iterator(); it.hasNext(); )
{
LinkcheckFileResult linkcheckFileResult = (LinkcheckFileResult) it.next();
if ( linkcheckFileResult.getStatusLevel() == level )
{
number++;
}
}
return number;
}
/**
* Get the number of links for this file.
*
* @param level
* @return
*/
public int getNumberOfLinks()
{
if ( results == null )
{
return -1;
}
return results.size();
}
}