You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@creadur.apache.org by po...@apache.org on 2014/07/27 21:04:52 UTC
svn commit: r1613829 - in /creadur/rat/trunk: ./
apache-rat-core/src/main/java/org/apache/rat/
apache-rat-core/src/main/java/org/apache/rat/analysis/
apache-rat-core/src/main/java/org/apache/rat/analysis/license/
apache-rat-core/src/main/java/org/apach...
Author: pottlinger
Date: Sun Jul 27 19:04:51 2014
New Revision: 1613829
URL: http://svn.apache.org/r1613829
Log:
RAT-165: https://issues.apache.org/jira/browse/RAT-165
Added new system property rat.skip:boolean to be able to skip plugin execution.
Added last days commits to RELEASE_NOTES for 0.11-SNAPSHOT and in webpage templates (no rebuild triggered):
- changed webpage's year to 2014
- integrated mvn default goal in Quick start
- fixed dozens of JavaDoc problems with Java8's javadoc that made maven-site-plugin:3.3 fail.
- Updated to maven-plugin-tools-javadoc, maven-plugin-plugin 3.3 (from 3.2) in the process of getting a solution for https://jira.codehaus.org/browse/MPLUGIN-237
Minor refactorings
- to reduce amount of deprecation warnings: use org.junit.Assert instead of junit.framework.Assert
- add String constants
- removed [WARNING] Deprecated @component for project field in org.apache.rat.mp.RatReportMojo/RatCheckMojo.: replace with @parameter name="${project}" @readonly in abstract super class
- removed unnecessary public keywords in some interfaces
Modified:
creadur/rat/trunk/RELEASE_NOTES.txt
creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/Report.java
creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/ReportConfiguration.java
creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/analysis/IHeaderMatcher.java
creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/analysis/license/CopyrightHeader.java
creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/annotation/AbstractLicenceAppender.java
creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/annotation/ApacheV2LicenceAppender.java
creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/api/Document.java
creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/api/MetaData.java
creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/api/MimeTyper.java
creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/MonolithicFileDocument.java
creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/ArchiveGuesser.java
creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/BinaryGuesser.java
creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/NoteGuesser.java
creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/report/IReportable.java
creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/report/RatReport.java
creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/report/claim/ClaimStatistic.java
creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/walker/ArchiveWalker.java
creadur/rat/trunk/apache-rat-core/src/test/java/org/apache/rat/analysis/license/MITLicenseTest.java
creadur/rat/trunk/apache-rat-plugin/pom.xml
creadur/rat/trunk/apache-rat-plugin/src/main/java/org/apache/rat/mp/AbstractRatMojo.java
creadur/rat/trunk/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckMojo.java
creadur/rat/trunk/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatReportMojo.java
creadur/rat/trunk/apache-rat-tasks/src/main/java/org/apache/rat/anttasks/Report.java
creadur/rat/trunk/apache-rat-tasks/src/test/java/org/apache/rat/anttasks/AbstractRatAntTaskTest.java
creadur/rat/trunk/apache-rat-tasks/src/test/java/org/apache/rat/anttasks/ReportTest.java
creadur/rat/trunk/pom.xml
creadur/rat/trunk/src/site/apt/index.apt.vm
creadur/rat/trunk/src/site/site.xml
Modified: creadur/rat/trunk/RELEASE_NOTES.txt
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/RELEASE_NOTES.txt?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/RELEASE_NOTES.txt (original)
+++ creadur/rat/trunk/RELEASE_NOTES.txt Sun Jul 27 19:04:51 2014
@@ -1,3 +1,18 @@
+Rat 0.11 - SNAPSHOT (not yet released)
+========
+tbd
+
+ * tbd
+ * Issues resolved (see http://issues.apache.org/jira):
+ * New feature
+ * [RAT-164] New boolean system property 'rat.skip' to skip RAT plugin execution externally.
+ * Bugs fixed:
+ * [RAT-162] CDDL1License matches slow with large inputs, use cache instead of recompiling patterns (thanks to Andrew Gaul)
+ * Improvements
+ * [RAT-165] Introduce mvn default goal to ease build process, you can run the build by just launching mvn without any arguments.
+ * [RAT-148] Remove unnecessary method call in LicenseAddingReport (thanks to Chris A. Mattmann)
+ * Fixed javadoc warnings during build, upgraded maven's generation plugins to avoid warnings in generated code (https://jira.codehaus.org/browse/MPLUGIN-237)
+
Rat 0.10
========
The main change is RAT-138 - Rat 0.9 could run much slower than 0.8 on some input.
Modified: creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/Report.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/Report.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/Report.java (original)
+++ creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/Report.java Sun Jul 27 19:04:51 2014
@@ -258,7 +258,12 @@ public class Report {
}
/**
+ * @param out - the output stream to receive the styled report
+ * @throws Exception in case of errors.
+ *
* @deprecated use {@link #report(PrintStream, ReportConfiguration)} instead
+ *
+ * @return the currently collected numerical statistics.
*/
@Deprecated
public ClaimStatistic report(PrintStream out) throws Exception {
@@ -268,7 +273,12 @@ public class Report {
}
/**
+ * @param out - the output stream to receive the styled report
+ * @param configuration - current configuration options.
+ * @throws Exception in case of errors.
+ *
* @since Rat 0.8
+ * @return the currently collected numerical statistics.
*/
public ClaimStatistic report(PrintStream out,
ReportConfiguration configuration)
@@ -307,8 +317,8 @@ public class Report {
* Output a report in the default style and default licence
* header matcher.
*
- * @param out - the output stream to recieve the styled report
- * @throws Exception
+ * @param out - the output stream to receive the styled report
+ * @throws Exception in case of errors.
* @deprecated use {@link #styleReport(PrintStream, ReportConfiguration)} instead
*/
@Deprecated
@@ -324,7 +334,7 @@ public class Report {
*
* @param out - the output stream to recieve the styled report
* @param configuration the configuration to use
- * @throws Exception
+ * @throws Exception in case of errors.
* @since Rat 0.8
*/
public void styleReport(PrintStream out,
@@ -343,10 +353,12 @@ public class Report {
* @param out the stream to write the report to
* @param base the files or directories to report on
* @param style an input stream representing the stylesheet to use for styling the report
- * @throws IOException
- * @throws TransformerConfigurationException
- * @throws InterruptedException
- * @throws RatException
+ * @param pConfiguration current report configuration.
+ *
+ * @throws IOException in case of I/O errors.
+ * @throws TransformerConfigurationException in case of XML errors.
+ * @throws InterruptedException in case of threading errors.
+ * @throws RatException in case of internal errors.
*/
public static void report(PrintStream out, IReportable base, final InputStream style,
ReportConfiguration pConfiguration)
@@ -361,11 +373,15 @@ public class Report {
* @param out the writer to write the report to
* @param base the files or directories to report on
* @param style an input stream representing the stylesheet to use for styling the report
- * @throws IOException
- * @throws TransformerConfigurationException
- * @throws FileNotFoundException
- * @throws InterruptedException
- * @throws RatException
+ * @param pConfiguration current report configuration.
+ *
+ * @throws FileNotFoundException in case of I/O errors.
+ * @throws IOException in case of I/O errors.
+ * @throws TransformerConfigurationException in case of XML errors.
+ * @throws InterruptedException in case of threading errors.
+ * @throws RatException in case of internal errors.
+ *
+ * @return the currently collected numerical statistics.
*/
public static ClaimStatistic report(Writer out, IReportable base, final InputStream style,
ReportConfiguration pConfiguration)
@@ -386,8 +402,12 @@ public class Report {
*
* @param container the files or directories to report on
* @param out the writer to write the report to
- * @throws IOException
- * @throws RatException
+ * @param pConfiguration current report configuration.
+ *
+ * @throws IOException in case of I/O errors.
+ * @throws RatException in case of internal errors.
+ *
+ * @return the currently collected numerical statistics.
*/
public static ClaimStatistic report(final IReportable container, final Writer out,
ReportConfiguration pConfiguration) throws IOException, RatException {
Modified: creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/ReportConfiguration.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/ReportConfiguration.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/ReportConfiguration.java (original)
+++ creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/ReportConfiguration.java Sun Jul 27 19:04:51 2014
@@ -36,6 +36,7 @@ public class ReportConfiguration {
/**
* Returns the header matcher.
+ * @return the header matcher.
*/
public IHeaderMatcher getHeaderMatcher() {
return headerMatcher;
@@ -43,6 +44,7 @@ public class ReportConfiguration {
/**
* Sets the header matcher.
+ * @param headerMatcher header matcher.
*/
public void setHeaderMatcher(IHeaderMatcher headerMatcher) {
this.headerMatcher = headerMatcher;
@@ -50,6 +52,7 @@ public class ReportConfiguration {
/**
* Returns the set of approved license names.
+ * @return the set of approved license names.
*/
public ILicenseFamily[] getApprovedLicenseNames() {
return approvedLicenseNames;
@@ -57,13 +60,14 @@ public class ReportConfiguration {
/**
* Sets the set of approved license names.
+ * @param approvedLicenseNames set of approved license names.
*/
public void setApprovedLicenseNames(ILicenseFamily[] approvedLicenseNames) {
this.approvedLicenseNames = approvedLicenseNames;
}
/**
- * If Rat is adding license headers: Returns the optional
+ * @return If Rat is adding license headers: Returns the optional
* copyright message. This value is ignored, if no
* license headers are added.
* @see #isAddingLicenses()
@@ -77,13 +81,14 @@ public class ReportConfiguration {
* copyright message. This value is ignored, if no
* license headers are added.
* @see #setAddingLicenses(boolean)
+ * @param copyrightMessage message to set.
*/
public void setCopyrightMessage(String copyrightMessage) {
this.copyrightMessage = copyrightMessage;
}
/**
- * If Rat is adding license headers: Returns, whether adding
+ * @return If Rat is adding license headers: Returns, whether adding
* license headers is enforced. This value is ignored, if no
* license headers are added.
* @see #isAddingLicenses()
@@ -97,13 +102,14 @@ public class ReportConfiguration {
* license headers is enforced. This value is ignored, if no
* license headers are added.
* @see #isAddingLicenses()
+ * @param addingLicensesForced enable/disable forcibly adding licenses.
*/
public void setAddingLicensesForced(boolean addingLicensesForced) {
this.addingLicensesForced = addingLicensesForced;
}
/**
- * Returns, whether Rat should add missing license headers.
+ * @return Returns, whether Rat should add missing license headers.
* @see #isAddingLicensesForced()
* @see #getCopyrightMessage()
*/
@@ -115,10 +121,10 @@ public class ReportConfiguration {
* Returns, whether Rat should add missing license headers.
* @see #setAddingLicensesForced(boolean)
* @see #setCopyrightMessage(String)
+ * @param addingLicenses enabled/disables adding of licenses.
*/
public void setAddingLicenses(boolean addingLicenses) {
this.addingLicenses = addingLicenses;
}
-
}
Modified: creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/analysis/IHeaderMatcher.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/analysis/IHeaderMatcher.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/analysis/IHeaderMatcher.java (original)
+++ creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/analysis/IHeaderMatcher.java Sun Jul 27 19:04:51 2014
@@ -22,7 +22,6 @@ import org.apache.rat.api.Document;
/**
* Matches text headers to known licenses.
- *
*/
public interface IHeaderMatcher {
@@ -30,14 +29,17 @@ public interface IHeaderMatcher {
* Resets this matches.
* Subsequent calls to {@link #match} will accumulate new text.
*/
- public void reset();
+ void reset();
/**
* Matches the text accumulated to licenses.
* TODO probably a poor design choice - hope to fix later
- * @param subject TODO
+ * @param subject current document.
* @param line next line of text, not null
- * @return TODO
+ *
+ * @return whether the current line matched in the document.
+ *
+ * @throws RatHeaderAnalysisException in case of internal RAT errors.
*/
- public boolean match(Document subject, String line) throws RatHeaderAnalysisException;
+ boolean match(Document subject, String line) throws RatHeaderAnalysisException;
}
Modified: creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/analysis/license/CopyrightHeader.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/analysis/license/CopyrightHeader.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/analysis/license/CopyrightHeader.java (original)
+++ creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/analysis/license/CopyrightHeader.java Sun Jul 27 19:04:51 2014
@@ -32,15 +32,16 @@ import org.apache.rat.api.MetaData.Datum
*
* <p>The matching is done case insensitive</p>
*
- * <ul>Example supported Copyright header lines, using copyright owner "FooBar"
+ * Example supported Copyright header lines, using copyright owner "FooBar"
+ * <ul>
* <li>* Copyright 2010 FooBar. *</li>
* <li>* Copyright 2010-2012 FooBar. *</li>
* <li>*copyright 2012 foobar*</li>
* </ul>
*
* <p>Note also that the copyright owner is appended to the regex pattern, so
- * can support additional regex but also requires escaping where needed,<br/>
- * e.g. use "FooBar \(www\.foobar\.com\)" for matching "FooBar (www.foobar.com)" </p>
+ * can support additional regex but also requires escaping where needed,<br>
+ * e.g. use "FooBar \(www\.foobar\.com\)" for matching "FooBar (www.foobar.com)"</p>
*
* @since Rat 0.9
*/
Modified: creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/annotation/AbstractLicenceAppender.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/annotation/AbstractLicenceAppender.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/annotation/AbstractLicenceAppender.java (original)
+++ creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/annotation/AbstractLicenceAppender.java Sun Jul 27 19:04:51 2014
@@ -39,7 +39,8 @@ import java.util.Map;
*
*/
public abstract class AbstractLicenceAppender {
- private static final int TYPE_UNKNOWN = 0;
+ private static final String DOT = ".";
+ private static final int TYPE_UNKNOWN = 0;
private static final int TYPE_JAVA = 1;
private static final int TYPE_XML = 2;
private static final int TYPE_HTML = 3;
@@ -188,9 +189,9 @@ public abstract class AbstractLicenceApp
/**
* Append the default licence header to the supplied document.
*
- * @param document
+ * @param document document to append to.
* @throws IOException
- * if there is a problem either reading or writing the file
+ * if there is a problem while reading or writing the file
*/
public void append(File document) throws IOException {
int type = getType(document);
@@ -341,13 +342,13 @@ public abstract class AbstractLicenceApp
/**
* Detect the type of document.
*
- * @param document
+ * @param document to retrieve type from.
* @return not null
* @TODO use existing mechanism to detect the type of a file and record it in the report output, thus we will not need this duplication here.
*/
protected int getType(File document) {
String path = document.getPath();
- int lastDot = path.lastIndexOf(".");
+ int lastDot = path.lastIndexOf(DOT);
if (lastDot >= 0 && lastDot < path.length() - 1) {
String ext = path.substring(lastDot + 1);
Integer type = EXT2TYPE.get(ext);
@@ -363,14 +364,15 @@ public abstract class AbstractLicenceApp
* to true then files will be modified directly, otherwise
* new files will be created alongside the existing files.
*
- * @param b
+ * @param force force flag.
*/
- public void setForce(boolean b) {
- isForced = b;
+ public void setForce(boolean force) {
+ isForced = force;
}
/**
- * Get the licence header for a document.
+ * @return Get the licence header of a document.
+ * @param document document to extract from.
*/
public abstract String getLicenceHeader(File document);
Modified: creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/annotation/ApacheV2LicenceAppender.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/annotation/ApacheV2LicenceAppender.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/annotation/ApacheV2LicenceAppender.java (original)
+++ creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/annotation/ApacheV2LicenceAppender.java Sun Jul 27 19:04:51 2014
@@ -42,9 +42,9 @@ public class ApacheV2LicenceAppender ext
/**
* Create a licence appender with the given copyright line. This should be of
- * the form "Copyright 2008 Foo"
+ * the form "Copyright 2008 Foo"
*
- * @param copyright
+ * @param copyright copyright line.
*/
public ApacheV2LicenceAppender(String copyright) {
super();
Modified: creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/api/Document.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/api/Document.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/api/Document.java (original)
+++ creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/api/Document.java Sun Jul 27 19:04:51 2014
@@ -26,7 +26,7 @@ import org.apache.rat.document.Composite
public interface Document {
- public String getName();
+ String getName();
/**
* Reads the content of this document.
@@ -35,24 +35,24 @@ public interface Document {
* @throws CompositeDocumentException if this document can only be read as
* a composite archive
*/
- public Reader reader() throws IOException;
+ Reader reader() throws IOException;
/**
* Streams the document's contents.
* @return not null
* @throws IOException when stream could not be opened
*/
- public InputStream inputStream() throws IOException;
+ InputStream inputStream() throws IOException;
/**
* Gets data describing this resource.
* @return not null
*/
- public MetaData getMetaData();
+ MetaData getMetaData();
/**
* Is this a composite document?
* @return true if composite, false otherwise
*/
- public boolean isComposite();
+ boolean isComposite();
}
Modified: creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/api/MetaData.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/api/MetaData.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/api/MetaData.java (original)
+++ creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/api/MetaData.java Sun Jul 27 19:04:51 2014
@@ -178,7 +178,7 @@ public class MetaData {
/**
* Adds a new datum.
* Existing data with the same name are not replaced.
- * @param datum
+ * @param datum datum to add.
* @see #set(org.apache.rat.api.MetaData.Datum)
*/
public void add(final Datum datum) {
Modified: creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/api/MimeTyper.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/api/MimeTyper.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/api/MimeTyper.java (original)
+++ creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/api/MimeTyper.java Sun Jul 27 19:04:51 2014
@@ -30,8 +30,8 @@ public interface MimeTyper {
* Guesses the mime type for the given content.
* @param inputStream not null
* @param name possibly null
- * @return not null
- * @throws IOException
+ * @return guessed content type, not null.
+ * @throws IOException in case of I/O errors.
*/
- public ContentType type(final InputStream inputStream, String name) throws IOException;
+ ContentType type(final InputStream inputStream, String name) throws IOException;
}
Modified: creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/MonolithicFileDocument.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/MonolithicFileDocument.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/MonolithicFileDocument.java (original)
+++ creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/MonolithicFileDocument.java Sun Jul 27 19:04:51 2014
@@ -31,20 +31,24 @@ import org.apache.rat.api.Document;
public class MonolithicFileDocument extends AbstractMonolithicDocument {
- private final File file;
+ private static final String UTF_8 = "UTF-8";
+ private static final String FILE_URL_PREFIX = "file";
+
+ private final File file;
/**
- * Creates a new instance. The document is read from the
- * given URL.
+ * @return Creates and returns a new instance.
+ *
+ * @param url The document is read from the given URL.
*/
public static Document newInstance(final URL url) {
- if ("file".equals(url.getProtocol())) {
+ if (FILE_URL_PREFIX.equals(url.getProtocol())) {
final File f = new File(url.getFile());
return new MonolithicFileDocument(f);
}
return new AbstractMonolithicDocument(url.toExternalForm()){
public Reader reader() throws IOException {
- return new InputStreamReader(inputStream(), "UTF-8");
+ return new InputStreamReader(inputStream(), UTF_8);
}
public InputStream inputStream() throws IOException {
@@ -53,16 +57,16 @@ public class MonolithicFileDocument exte
};
}
- public MonolithicFileDocument(final File file) {
+ public MonolithicFileDocument(final File file) {
super(DocumentImplUtils.toName(file));
this.file = file;
}
- public Reader reader() throws IOException {
+ public Reader reader() throws IOException {
return new FileReader(file);
}
- public InputStream inputStream() throws IOException {
+ public InputStream inputStream() throws IOException {
return new FileInputStream(file);
}
}
Modified: creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/ArchiveGuesser.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/ArchiveGuesser.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/ArchiveGuesser.java (original)
+++ creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/ArchiveGuesser.java Sun Jul 27 19:04:51 2014
@@ -24,7 +24,8 @@ import org.apache.rat.api.Document;
public class ArchiveGuesser {
- public static final String[] ARCHIVE_EXTENSIONS = {
+ private static final String DOT = ".";
+ public static final String[] ARCHIVE_EXTENSIONS = {
"jar", "gz",
"zip", "tar",
"bz", "bz2",
@@ -36,18 +37,23 @@ public class ArchiveGuesser {
"ods", "odt",
};
+ /**
+ * @param document the current document.
+ * @return whether the given document is an archive.
+ */
public static final boolean isArchive(final Document document) {
return isArchive(document.getName());
}
/**
- * Is a file by that name an archive?
+ * @return Is a file by that name an archive?
+ * @param name file name to check against.
*/
public static final boolean isArchive(final String name) {
if (name == null) {return false;}
String nameToLower = name.toLowerCase(Locale.US);
for (int i = 0; i < ArchiveGuesser.ARCHIVE_EXTENSIONS.length; i++) {
- if (nameToLower.endsWith("." + ArchiveGuesser.ARCHIVE_EXTENSIONS[i])) {
+ if (nameToLower.endsWith(DOT + ArchiveGuesser.ARCHIVE_EXTENSIONS[i])) {
return true;
}
}
Modified: creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/BinaryGuesser.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/BinaryGuesser.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/BinaryGuesser.java (original)
+++ creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/BinaryGuesser.java Sun Jul 27 19:04:51 2014
@@ -32,11 +32,13 @@ import java.util.Locale;
import org.apache.rat.api.Document;
/**
- * TODO: factor into MIME guesser and MIME->binary guesser
+ * TODO: factor into MIME guesser and MIME->binary guesser
*/
public class BinaryGuesser {
- private static boolean isBinaryDocument(Document document) {
+ private static final String DOT = ".";
+
+ private static boolean isBinaryDocument(Document document) {
boolean result = false;
InputStream stream = null;
try
@@ -80,7 +82,9 @@ public class BinaryGuesser {
}
/**
- * Do the first few bytes of the stream hint at a binary file?
+ * @param in the file to check.
+ *
+ * @return Do the first few bytes of the stream hint at a binary file?
*
* <p>Any IOException is swallowed internally and the test returns
* false.</p>
@@ -103,7 +107,9 @@ public class BinaryGuesser {
}
/**
- * Do the first few bytes of the stream hint at a binary file?
+ * @param in the file to check.
+ *
+ * @return Do the first few bytes of the stream hint at a binary file?
*
* <p>Any IOException is swallowed internally and the test returns
* false.</p>
@@ -148,12 +154,19 @@ public class BinaryGuesser {
return false;
}
+
+ /**
+ *
+ * @param name current file name.
+ * @return whether given name is binary.
+ */
public static final boolean isBinaryData(final String name) {
return extensionMatches(name, DATA_EXTENSIONS);
}
/**
- * Is a file by that name a known non-binary file?
+ * @return Is a file by that name a known non-binary file?
+ * @param name current file name.
*/
public static final boolean isNonBinary(final String name) {
if (name == null) {return false;}
@@ -161,6 +174,10 @@ public class BinaryGuesser {
BinaryGuesser.NON_BINARY_EXTENSIONS);
}
+ /**
+ * @return Is a file by that name an executable/binary file?
+ * @param name current file name.
+ */
public static final boolean isExecutable(final String name) {
return name.equals(BinaryGuesser.JAVA) || extensionMatches(name, EXE_EXTENSIONS)
|| containsExtension(name, EXE_EXTENSIONS);
@@ -169,7 +186,7 @@ public class BinaryGuesser {
public static boolean containsExtension(final String name,
final String[] exts) {
for (int i = 0; i < exts.length; i++) {
- if (name.indexOf("." + exts[i] + ".") >= 0) {
+ if (name.indexOf(DOT + exts[i] + DOT) >= 0) {
return true;
}
}
@@ -179,7 +196,7 @@ public class BinaryGuesser {
public static boolean extensionMatches(final String name,
final String[] exts) {
for (int i = 0; i < exts.length; i++) {
- if (name.endsWith("." + exts[i])) {
+ if (name.endsWith(DOT + exts[i])) {
return true;
}
}
@@ -199,7 +216,8 @@ public class BinaryGuesser {
}
/**
- * Is a file by that name a known binary file?
+ * @return Is a file by that name a known binary file?
+ * @param name file name.
*/
public static final boolean isBinary(final String name) {
if (name == null) {return false;}
Modified: creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/NoteGuesser.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/NoteGuesser.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/NoteGuesser.java (original)
+++ creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/NoteGuesser.java Sun Jul 27 19:04:51 2014
@@ -25,8 +25,8 @@ import org.apache.rat.api.Document;
public class NoteGuesser {
-
- public static final String[] NOTE_FILE_NAMES = {
+ private static final String DOT = ".";
+ public static final String[] NOTE_FILE_NAMES = {
"NOTICE", "LICENSE",
"LICENSE.TXT", "NOTICE.TXT",
"INSTALL", "INSTALL.TXT",
@@ -52,7 +52,8 @@ public class NoteGuesser {
};
/**
- * Is a file by that name a note file?
+ * @return Is a file by that name a note file?
+ * @param name file name.
*/
public static final boolean isNote(final String name) {
if (name == null) {return false;}
@@ -65,7 +66,7 @@ public class NoteGuesser {
}
for (int i = 0; i < NoteGuesser.NOTE_FILE_EXTENSIONS.length; i++) {
- if (normalisedName.endsWith("." + NoteGuesser.NOTE_FILE_EXTENSIONS[i])) {
+ if (normalisedName.endsWith(DOT + NoteGuesser.NOTE_FILE_EXTENSIONS[i])) {
return true;
}
}
Modified: creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/report/IReportable.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/report/IReportable.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/report/IReportable.java (original)
+++ creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/report/IReportable.java Sun Jul 27 19:04:51 2014
@@ -22,5 +22,5 @@ import org.apache.rat.api.RatException;
public interface IReportable {
- public void run(RatReport report) throws RatException;
+ void run(RatReport report) throws RatException;
}
Modified: creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/report/RatReport.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/report/RatReport.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/report/RatReport.java (original)
+++ creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/report/RatReport.java Sun Jul 27 19:04:51 2014
@@ -23,9 +23,9 @@ import org.apache.rat.api.RatException;
public interface RatReport {
- public void startReport() throws RatException;
+ void startReport() throws RatException;
- public void report(Document document) throws RatException;
+ void report(Document document) throws RatException;
- public void endReport() throws RatException;
+ void endReport() throws RatException;
}
Modified: creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/report/claim/ClaimStatistic.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/report/claim/ClaimStatistic.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/report/claim/ClaimStatistic.java (original)
+++ creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/report/claim/ClaimStatistic.java Sun Jul 27 19:04:51 2014
@@ -31,7 +31,7 @@ public class ClaimStatistic {
private int numApproved, numUnApproved, numGenerated, numUnknown;
/**
- * Returns the number of files with approved licenses.
+ * @return Returns the number of files with approved licenses.
*/
public int getNumApproved() {
return numApproved;
@@ -39,13 +39,14 @@ public class ClaimStatistic {
/**
* Sets the number of files with approved licenses.
+ * @param pNumApproved number of files with approved licenses.
*/
public void setNumApproved(int pNumApproved) {
numApproved = pNumApproved;
}
/**
- * Returns the number of files with unapproved licenses.
+ * @return Returns the number of files with unapproved licenses.
* <em>Note:</em> This might include files with unknown
* licenses.
* @see #getNumUnknown()
@@ -55,31 +56,30 @@ public class ClaimStatistic {
}
/**
- * Returns the number of files with unapproved licenses.
- * <em>Note:</em> This might include files with unknown
- * licenses.
- * @see #setNumUnknown(int)
+ * Sets the number of files with unapproved licenses.
+ * @param pNumUnApproved number of files with unapproved licenses.
*/
public void setNumUnApproved(int pNumUnApproved) {
numUnApproved = pNumUnApproved;
}
/**
- * Returns the number of generated files.
+ * @return Returns the number of generated files.
*/
public int getNumGenerated() {
return numGenerated;
}
/**
- * Returns the number of generated files.
+ * Sets the number of generated files.
+ * @param pNumGenerated the number of generated files.
*/
public void setNumGenerated(int pNumGenerated) {
numGenerated = pNumGenerated;
}
/**
- * Returns the number of files, which are neither
+ * @return Returns the number of files, which are neither
* generated nor have a known license header.
*/
public int getNumUnknown() {
@@ -89,6 +89,7 @@ public class ClaimStatistic {
/**
* Sets the number of files, which are neither
* generated nor have a known license header.
+ * @param pNumUnknown set number of files.
*/
public void setNumUnknown(int pNumUnknown) {
numUnknown = pNumUnknown;
@@ -99,13 +100,14 @@ public class ClaimStatistic {
* are file type names and the map values
* are integers with the number of resources matching
* the file type.
+ * @param pDocumentCategoryMap doc-category map.
*/
public void setDocumentCategoryMap(Map<String, Integer> pDocumentCategoryMap) {
documentCategoryMap = pDocumentCategoryMap;
}
/**
- * Returns a map with the file types. The map keys
+ * @return Returns a map with the file types. The map keys
* are file type names and the map values
* are integers with the number of resources matching
* the file type.
@@ -115,7 +117,7 @@ public class ClaimStatistic {
}
/**
- * Returns a map with the license family codes. The map
+ * @return Returns a map with the license family codes. The map
* keys are license family category names,
* the map values are integers with the number of resources
* matching the license family code.
@@ -129,13 +131,14 @@ public class ClaimStatistic {
* keys are instances of license family category names and
* the map values are integers with the number of resources
* matching the license family code.
+ * @param pLicenseFamilyCodeMap license family map.
*/
public void setLicenseFileCodeMap(Map<String, Integer> pLicenseFamilyCodeMap) {
licenseFamilyCodeMap = pLicenseFamilyCodeMap;
}
/**
- * Returns a map with the license family codes. The map
+ * @return Returns a map with the license family codes. The map
* keys are the names of the license families and
* the map values are integers with the number of resources
* matching the license family name.
@@ -145,10 +148,11 @@ public class ClaimStatistic {
}
/**
- * Returns a map with the license family codes. The map
+ * Sets map with the license family codes. The map
* keys are the name of the license families and
* the map values are integers with the number of resources
* matching the license family name.
+ * @param pLicenseFamilyNameMap license family-name map.
*/
public void setLicenseFileNameMap(Map<String, Integer> pLicenseFamilyNameMap) {
licenseFamilyNameMap = pLicenseFamilyNameMap;
Modified: creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/walker/ArchiveWalker.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/walker/ArchiveWalker.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/walker/ArchiveWalker.java (original)
+++ creadur/rat/trunk/apache-rat-core/src/main/java/org/apache/rat/walker/ArchiveWalker.java Sun Jul 27 19:04:51 2014
@@ -47,7 +47,7 @@ public class ArchiveWalker extends Walke
* @param file not null
* @param filter filters input files (optional),
* or null when no filtering should be performed
- * @throws FileNotFoundException
+ * @throws FileNotFoundException in case of I/O errors.
*/
public ArchiveWalker(File file, final FilenameFilter filter) throws FileNotFoundException {
super(file, filter);
Modified: creadur/rat/trunk/apache-rat-core/src/test/java/org/apache/rat/analysis/license/MITLicenseTest.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-core/src/test/java/org/apache/rat/analysis/license/MITLicenseTest.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-core/src/test/java/org/apache/rat/analysis/license/MITLicenseTest.java (original)
+++ creadur/rat/trunk/apache-rat-core/src/test/java/org/apache/rat/analysis/license/MITLicenseTest.java Sun Jul 27 19:04:51 2014
@@ -21,7 +21,6 @@ package org.apache.rat.analysis.license;
import org.apache.rat.analysis.IHeaderMatcher;
import org.apache.rat.api.Document;
import org.apache.rat.document.MockLocation;
-import org.apache.rat.report.claim.impl.xml.MockClaimReporter;
import org.junit.Before;
import org.junit.Test;
@@ -32,12 +31,7 @@ import static org.junit.Assert.assertEqu
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
-/**
- * @author hirsch
- * @version 2011-12-06, 23:48
- */
public class MITLicenseTest {
- private MockClaimReporter reporter;
private Document subject;
/**
@@ -61,7 +55,6 @@ public class MITLicenseTest {
@Before
public final void initReporter() {
- this.reporter = new MockClaimReporter();
this.subject = new MockLocation("subject");
}
Modified: creadur/rat/trunk/apache-rat-plugin/pom.xml
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-plugin/pom.xml?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-plugin/pom.xml (original)
+++ creadur/rat/trunk/apache-rat-plugin/pom.xml Sun Jul 27 19:04:51 2014
@@ -36,7 +36,7 @@
<currentVersion>${project.version}</currentVersion>
<doxiaVersion>1.2</doxiaVersion>
<doxiaSitetoolsVersion>1.2</doxiaSitetoolsVersion>
- <mavenPluginPluginVersion>3.2</mavenPluginPluginVersion>
+ <mavenPluginPluginVersion>3.3</mavenPluginPluginVersion>
</properties>
<build>
Modified: creadur/rat/trunk/apache-rat-plugin/src/main/java/org/apache/rat/mp/AbstractRatMojo.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-plugin/src/main/java/org/apache/rat/mp/AbstractRatMojo.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-plugin/src/main/java/org/apache/rat/mp/AbstractRatMojo.java (original)
+++ creadur/rat/trunk/apache-rat-plugin/src/main/java/org/apache/rat/mp/AbstractRatMojo.java Sun Jul 27 19:04:51 2014
@@ -178,13 +178,13 @@ public abstract class AbstractRatMojo ex
private boolean excludeSubProjects;
/**
- *
+ *
*/
- @Component
+ @Parameter(name = "project", readonly = true)
private MavenProject project;
/**
- * Returns the Maven project.
+ * @return Returns the Maven project.
*/
protected MavenProject getProject()
{
@@ -450,6 +450,9 @@ public abstract class AbstractRatMojo ex
*
* @param out The target writer, to which the report is being written.
* @param style The stylesheet to use, or <code>null</code> for raw XML
+ *
+ * @return the current statistic.
+ *
* @throws MojoFailureException
* An error in the plugin configuration was detected.
* @throws MojoExecutionException
Modified: creadur/rat/trunk/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckMojo.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckMojo.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckMojo.java (original)
+++ creadur/rat/trunk/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckMojo.java Sun Jul 27 19:04:51 2014
@@ -37,7 +37,6 @@ import org.apache.rat.report.claim.Claim
/**
* Run Rat to perform a violation check.
- *
*/
@Mojo (name = "check", defaultPhase = LifecyclePhase.VALIDATE)
public class RatCheckMojo extends AbstractRatMojo
@@ -90,6 +89,13 @@ public class RatCheckMojo extends Abstra
@Parameter(property = "rat.ignoreErrors", defaultValue = "false")
private boolean ignoreErrors;
+ /**
+ * Will skip the plugin execution, e.g. for technical builds that do not take licence compliance into account.
+ * @since 0.11
+ */
+ @Parameter(property = "rat.skip", defaultValue = "false")
+ private boolean skip;
+
private ClaimStatistic getRawReport()
throws MojoExecutionException, MojoFailureException
{
@@ -162,7 +168,12 @@ public class RatCheckMojo extends Abstra
*/
public void execute() throws MojoExecutionException, MojoFailureException
{
- File parent = reportFile.getParentFile();
+ if(skip) {
+ getLog().info("RAT will not execute since it is configured to be skipped via system property 'rat.skip'.");
+ return;
+ }
+
+ final File parent = reportFile.getParentFile();
if(!parent.mkdirs() && !parent.isDirectory()) {
throw new MojoExecutionException("Could not create report parent directory " + parent);
}
Modified: creadur/rat/trunk/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatReportMojo.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatReportMojo.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatReportMojo.java (original)
+++ creadur/rat/trunk/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatReportMojo.java Sun Jul 27 19:04:51 2014
@@ -61,18 +61,12 @@ import java.util.ResourceBundle;
/**
* Generates a report with Rat's output.
- *
*/
+// MavenReport.java induces the deprecated Sink implementation
+@SuppressWarnings("deprecation")
@Mojo(name = "rat", requiresDependencyResolution = ResolutionScope.TEST)
public class RatReportMojo extends AbstractRatMojo implements MavenReport
{
- /**
- * Specifies the directory where the report will be generated
- *
- */
- @Parameter(defaultValue = "${project.reporting.outputDirectory}", required = true)
- private File outputDirectory;
-
@Component
private Renderer siteRenderer;
@@ -81,6 +75,12 @@ public class RatReportMojo extends Abstr
@Component
private ArtifactResolver resolver;
+
+ /**
+ * Specifies the directory where the report will be generated
+ */
+ @Parameter(defaultValue = "${project.reporting.outputDirectory}", required = true)
+ private File outputDirectory;
@Parameter(defaultValue = "${localRepository}", required = true, readonly = true)
private ArtifactRepository localRepository;
@@ -267,6 +267,7 @@ public class RatReportMojo extends Abstr
/**
* Writes the report to the Doxia sink.
*
+ *
* @param sink
* The doxia sink, kind of a SAX handler.
* @param locale
@@ -274,7 +275,7 @@ public class RatReportMojo extends Abstr
* @throws MavenReportException
* Writing the report failed.
*/
- public void generate( Sink sink, Locale locale ) throws MavenReportException
+ public void generate(Sink sink, Locale locale ) throws MavenReportException
{
ResourceBundle bundle = getBundle( locale );
final String title = bundle.getString( "report.rat.title" );
Modified: creadur/rat/trunk/apache-rat-tasks/src/main/java/org/apache/rat/anttasks/Report.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-tasks/src/main/java/org/apache/rat/anttasks/Report.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-tasks/src/main/java/org/apache/rat/anttasks/Report.java (original)
+++ creadur/rat/trunk/apache-rat-tasks/src/main/java/org/apache/rat/anttasks/Report.java Sun Jul 27 19:04:51 2014
@@ -102,6 +102,7 @@ public class Report extends Task {
/**
* Adds resources that will be checked.
+ * @param rc resource to check.
*/
public void add(ResourceCollection rc) {
if (nestedResources == null) {
@@ -111,7 +112,7 @@ public class Report extends Task {
}
/**
- * Adds a license matcher.
+ * @param matcher Adds a license matcher.
*/
public void add(IHeaderMatcher matcher) {
licenseMatchers.add(matcher);
@@ -122,14 +123,15 @@ public class Report extends Task {
}
/**
- * Whether to add the default list of license matchers.
+ * @param addDefaultLicenseMatchers Whether to add the default list of license matchers.
*/
- public void setAddDefaultLicenseMatchers(boolean b) {
- addDefaultLicenseMatchers = b;
+ public void setAddDefaultLicenseMatchers(boolean addDefaultLicenseMatchers) {
+ this.addDefaultLicenseMatchers = addDefaultLicenseMatchers;
}
/**
* Where to send the report to.
+ * @param f report output file.
*/
public void setReportFile(File f) {
reportFile = f;
@@ -137,6 +139,7 @@ public class Report extends Task {
/**
* Which format to use.
+ * @param f format.
*/
public void setFormat(Format f) {
if (f == null) {
@@ -146,7 +149,7 @@ public class Report extends Task {
}
/**
- * Whether to add license headers.
+ * @param pAdd Whether to add license headers.
*/
public void setAddLicenseHeaders(AddLicenseHeaders pAdd) {
if (pAdd == null) {
@@ -156,7 +159,7 @@ public class Report extends Task {
}
/**
- * Sets the copyright message.
+ * @param pMessage copyright message to set.
*/
public void setCopyrightMessage(String pMessage) {
copyrightMessage = pMessage;
@@ -164,6 +167,7 @@ public class Report extends Task {
/**
* Which stylesheet to use (only meaningful with format='styled').
+ * @param u stylesheet.
*/
public void addConfiguredStylesheet(Union u) {
if (stylesheet != null || u.size() != 1) {
@@ -237,9 +241,13 @@ public class Report extends Task {
/**
* Writes the report to the given stream.
- * @throws InterruptedException
- * @throws TransformerException
- * @throws RatException
+ *
+ * @param out stream to write report to.
+ *
+ * @throws IOException in case of I/O errors.
+ * @throws InterruptedException in case of threading errors.
+ * @throws TransformerException in case of XML errors.
+ * @throws RatException in case of general errors.
*/
private void createReport(PrintWriter out) throws IOException, TransformerException, InterruptedException, RatException {
final ReportConfiguration configuration = new ReportConfiguration();
@@ -348,7 +356,6 @@ public class Report extends Task {
setValue(s);
}
-
@Override
public String[] getValues() {
return new String[] {
Modified: creadur/rat/trunk/apache-rat-tasks/src/test/java/org/apache/rat/anttasks/AbstractRatAntTaskTest.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-tasks/src/test/java/org/apache/rat/anttasks/AbstractRatAntTaskTest.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-tasks/src/test/java/org/apache/rat/anttasks/AbstractRatAntTaskTest.java (original)
+++ creadur/rat/trunk/apache-rat-tasks/src/test/java/org/apache/rat/anttasks/AbstractRatAntTaskTest.java Sun Jul 27 19:04:51 2014
@@ -16,7 +16,7 @@
*/
package org.apache.rat.anttasks;
-import junit.framework.Assert;
+import org.junit.Assert;
import org.apache.tools.ant.BuildFileTest;
import org.apache.tools.ant.util.FileUtils;
Modified: creadur/rat/trunk/apache-rat-tasks/src/test/java/org/apache/rat/anttasks/ReportTest.java
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-tasks/src/test/java/org/apache/rat/anttasks/ReportTest.java?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-tasks/src/test/java/org/apache/rat/anttasks/ReportTest.java (original)
+++ creadur/rat/trunk/apache-rat-tasks/src/test/java/org/apache/rat/anttasks/ReportTest.java Sun Jul 27 19:04:51 2014
@@ -24,7 +24,7 @@ import java.io.InputStreamReader;
import org.apache.tools.ant.BuildException;
-import junit.framework.Assert;
+import org.junit.Assert;
public class ReportTest extends AbstractRatAntTaskTest {
private static final File antFile = new File("src/test/resources/antunit/report-junit.xml").getAbsoluteFile();
Modified: creadur/rat/trunk/pom.xml
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/pom.xml?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/pom.xml (original)
+++ creadur/rat/trunk/pom.xml Sun Jul 27 19:04:51 2014
@@ -162,7 +162,7 @@ agnostic home for software distribution
<tagletArtifact>
<groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-tools-javadoc</artifactId>
- <version>3.2</version>
+ <version>3.3</version>
</tagletArtifact>
</tagletArtifacts>
<tags>
Modified: creadur/rat/trunk/src/site/apt/index.apt.vm
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/src/site/apt/index.apt.vm?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/src/site/apt/index.apt.vm (original)
+++ creadur/rat/trunk/src/site/apt/index.apt.vm Sun Jul 27 19:04:51 2014
@@ -129,7 +129,9 @@ svn co http://svn.apache.org/repos/asf/c
Quick start
+ If you want to build RAT just launch 'mvn' inside the root folder. It will automatically perform a
+
+------------------------------------------+
-mvn install
+mvn clean install
+------------------------------------------+
Modified: creadur/rat/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/src/site/site.xml?rev=1613829&r1=1613828&r2=1613829&view=diff
==============================================================================
--- creadur/rat/trunk/src/site/site.xml (original)
+++ creadur/rat/trunk/src/site/site.xml Sun Jul 27 19:04:51 2014
@@ -101,7 +101,7 @@
<menu ref="modules"/>
<menu ref="reports"/>
- <footer>Copyright © 2013 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
+ <footer>Copyright © 2014 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
Apache Creadur, Creadur, Apache Rat, Apache Tentacles, Apache Whisker, Apache and the Apache feather logo are trademarks
of The Apache Software Foundation.
Oracle and Java are registered trademarks of Oracle and/or its affiliates.