You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@creadur.apache.org by rd...@apache.org on 2009/05/18 23:32:18 UTC
svn commit: r776102 - in /incubator/rat/main/trunk:
apache-rat-core/src/main/java/org/apache/rat/document/
apache-rat-core/src/main/java/org/apache/rat/document/impl/
apache-rat-core/src/main/java/org/apache/rat/document/impl/zip/
apache-rat-core/src/m...
Author: rdonkin
Date: Mon May 18 21:32:17 2009
New Revision: 776102
URL: http://svn.apache.org/viewvc?rev=776102&view=rev
Log:
Simplify API
Modified:
incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/IDocument.java
incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/AbstractMonolithicDocument.java
incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/FileDocument.java
incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/zip/ZipDocument.java
incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/zip/ZipFileDocument.java
incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/analyser/DefaultAnalyserFactory.java
incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/document/MockArchiveDocument.java
incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/document/MockDocument.java
incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/document/impl/SingularFileDocumentTest.java
incubator/rat/main/trunk/apache-rat-plugin/src/main/java/org/apache/rat/mp/FilesReportable.java
incubator/rat/main/trunk/apache-rat-tasks/src/main/java/org/apache/rat/anttasks/ResourceCollectionContainer.java
Modified: incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/IDocument.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/IDocument.java?rev=776102&r1=776101&r2=776102&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/IDocument.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/IDocument.java Mon May 18 21:32:17 2009
@@ -33,11 +33,8 @@
public Reader reader() throws IOException;
/**
- * Reads contents of composite document.
- * @return <code>IDocumentCollection</code>, not null
- * @throws IOException if the document cannot be read
- * @throws UnreadableArchiveException if this document is not an archive
- * or if this document is unreadable
+ * Is this a composite document?
+ * @return true if composite, false otherwise
*/
- public IDocumentCollection readArchive() throws IOException;
+ public boolean isComposite();
}
Modified: incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/AbstractMonolithicDocument.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/AbstractMonolithicDocument.java?rev=776102&r1=776101&r2=776102&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/AbstractMonolithicDocument.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/AbstractMonolithicDocument.java Mon May 18 21:32:17 2009
@@ -18,11 +18,7 @@
*/
package org.apache.rat.document.impl;
-import java.io.IOException;
-
import org.apache.rat.document.IDocument;
-import org.apache.rat.document.IDocumentCollection;
-import org.apache.rat.document.UnreadableArchiveException;
/**
@@ -35,11 +31,11 @@
name = pName;
}
- public IDocumentCollection readArchive() throws IOException {
- throw new UnreadableArchiveException("This file is not an archive");
+ public boolean isComposite() {
+ return false;
}
- public String getName() {
+ public String getName() {
return name;
}
}
Modified: incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/FileDocument.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/FileDocument.java?rev=776102&r1=776101&r2=776102&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/FileDocument.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/FileDocument.java Mon May 18 21:32:17 2009
@@ -44,9 +44,13 @@
name = DocumentImplUtils.toName(file);
}
- public IDocumentCollection readArchive() throws IOException {
- final IDocumentCollection result = unarchiver.unarchive(file);
- return result;
+ public boolean isComposite() {
+ try {
+ unarchiver.unarchive(file);
+ return true;
+ } catch (IOException e) {
+ return false;
+ }
}
public Reader reader() throws IOException {
Modified: incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/zip/ZipDocument.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/zip/ZipDocument.java?rev=776102&r1=776101&r2=776102&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/zip/ZipDocument.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/zip/ZipDocument.java Mon May 18 21:32:17 2009
@@ -61,7 +61,7 @@
return buffer.toString();
}
- public IDocumentCollection readArchive() throws IOException {
- throw new UnreadableArchiveException();
+ public boolean isComposite() {
+ return false;
}
}
Modified: incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/zip/ZipFileDocument.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/zip/ZipFileDocument.java?rev=776102&r1=776101&r2=776102&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/zip/ZipFileDocument.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/zip/ZipFileDocument.java Mon May 18 21:32:17 2009
@@ -33,7 +33,6 @@
public class ZipFileDocument implements IDocument {
private final File file;
- private IDocumentCollection contents;
private final String name;
public ZipFileDocument(final File file) {
@@ -45,14 +44,20 @@
throw new CompositeDocumentException();
}
- public synchronized IDocumentCollection readArchive() throws IOException {
- if (contents == null) {
- contents = ZipDocumentFactory.load(file);
+
+
+ public boolean isComposite() {
+ try {
+ ZipDocumentFactory.load(file);
+ return true;
+ } catch (IOException e) {
+ return false;
}
- return contents;
}
public String getName() {
return name;
}
+
+
}
Modified: incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/analyser/DefaultAnalyserFactory.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/analyser/DefaultAnalyserFactory.java?rev=776102&r1=776101&r2=776102&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/analyser/DefaultAnalyserFactory.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/analyser/DefaultAnalyserFactory.java Mon May 18 21:32:17 2009
@@ -18,12 +18,9 @@
*/
package org.apache.rat.report.analyser;
-import java.io.IOException;
-
import org.apache.rat.analysis.IHeaderMatcher;
import org.apache.rat.document.IDocument;
import org.apache.rat.document.IDocumentAnalyser;
-import org.apache.rat.document.IDocumentCollection;
import org.apache.rat.document.IDocumentMatcher;
import org.apache.rat.document.RatDocumentAnalysisException;
import org.apache.rat.document.impl.guesser.ArchiveGuesser;
@@ -49,16 +46,7 @@
return new AbstractSingleClaimAnalyser(reporter){
protected IClaim toClaim(IDocument pDocument)
throws RatDocumentAnalysisException {
- boolean readable = false;
- try {
- final IDocumentCollection contents = pDocument.readArchive();
- if (contents != null) {
- readable = true;
- }
- } catch (IOException e) {
- readable = false;
- }
- return new ArchiveFileTypeClaim(pDocument, readable);
+ return new ArchiveFileTypeClaim(pDocument, pDocument.isComposite());
}
};
}
Modified: incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/document/MockArchiveDocument.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/document/MockArchiveDocument.java?rev=776102&r1=776101&r2=776102&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/document/MockArchiveDocument.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/document/MockArchiveDocument.java Mon May 18 21:32:17 2009
@@ -48,5 +48,9 @@
public String getName() {
return name;
}
+
+ public boolean isComposite() {
+ return contents != null;
+ }
}
Modified: incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/document/MockDocument.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/document/MockDocument.java?rev=776102&r1=776101&r2=776102&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/document/MockDocument.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/document/MockDocument.java Mon May 18 21:32:17 2009
@@ -52,4 +52,8 @@
public IDocumentCollection readArchive() throws IOException {
return documentCollection;
}
+
+ public boolean isComposite() {
+ return documentCollection != null;
+ }
}
Modified: incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/document/impl/SingularFileDocumentTest.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/document/impl/SingularFileDocumentTest.java?rev=776102&r1=776101&r2=776102&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/document/impl/SingularFileDocumentTest.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/document/impl/SingularFileDocumentTest.java Mon May 18 21:32:17 2009
@@ -42,15 +42,6 @@
super.tearDown();
}
- public void testReadArchive() throws Exception {
- try {
- document.readArchive();
- fail("Source is not archive: Exception should have been thrown");
- } catch (UnreadableArchiveException e) {
- // expected
- }
- }
-
public void testReader() throws Exception {
Reader reader = document.reader();
assertNotNull("Reader should be returned", reader);
Modified: incubator/rat/main/trunk/apache-rat-plugin/src/main/java/org/apache/rat/mp/FilesReportable.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-plugin/src/main/java/org/apache/rat/mp/FilesReportable.java?rev=776102&r1=776101&r2=776102&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-plugin/src/main/java/org/apache/rat/mp/FilesReportable.java (original)
+++ incubator/rat/main/trunk/apache-rat-plugin/src/main/java/org/apache/rat/mp/FilesReportable.java Mon May 18 21:32:17 2009
@@ -79,9 +79,13 @@
this.file = file;
}
- public IDocumentCollection readArchive() throws IOException
- {
- return ZipDocumentFactory.load( file );
+ public boolean isComposite() {
+ try {
+ ZipDocumentFactory.load( file );
+ return true;
+ } catch (IOException e) {
+ return false;
+ }
}
public Reader reader() throws IOException
Modified: incubator/rat/main/trunk/apache-rat-tasks/src/main/java/org/apache/rat/anttasks/ResourceCollectionContainer.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-tasks/src/main/java/org/apache/rat/anttasks/ResourceCollectionContainer.java?rev=776102&r1=776101&r2=776102&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-tasks/src/main/java/org/apache/rat/anttasks/ResourceCollectionContainer.java (original)
+++ incubator/rat/main/trunk/apache-rat-tasks/src/main/java/org/apache/rat/anttasks/ResourceCollectionContainer.java Mon May 18 21:32:17 2009
@@ -72,21 +72,7 @@
public void setResource(Resource resource) {
this.resource = resource;
}
-
- public IDocumentCollection readArchive() throws IOException {
- IDocumentCollection results = null;
- if (resource instanceof FileResource) {
- final FileResource fileResource = (FileResource) resource;
- final File file = fileResource.getFile();
- results = ZipDocumentFactory.load(file);
- }
- else
- {
- throw new UnreadableArchiveException();
- }
- return results;
- }
-
+
public Reader reader() throws IOException {
final InputStream in = resource.getInputStream();
final Reader result = new InputStreamReader(in);
@@ -105,5 +91,18 @@
}
return result;
}
+
+ public boolean isComposite() {
+ if (resource instanceof FileResource) {
+ final FileResource fileResource = (FileResource) resource;
+ final File file = fileResource.getFile();
+ try {
+ return ZipDocumentFactory.load(file) != null;
+ } catch (IOException e) {
+ return false;
+ }
+ }
+ return false;
+ }
}
}