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 2013/12/08 21:06:47 UTC

svn commit: r1549191 - /creadur/rat/branches/gsoc/apache-rat-core/src/test/java/org/apache/rat/document/MockDocument.java

Author: rdonkin
Date: Sun Dec  8 20:06:46 2013
New Revision: 1549191

URL: http://svn.apache.org/r1549191
Log:
Add java doc.

Modified:
    creadur/rat/branches/gsoc/apache-rat-core/src/test/java/org/apache/rat/document/MockDocument.java

Modified: creadur/rat/branches/gsoc/apache-rat-core/src/test/java/org/apache/rat/document/MockDocument.java
URL: http://svn.apache.org/viewvc/creadur/rat/branches/gsoc/apache-rat-core/src/test/java/org/apache/rat/document/MockDocument.java?rev=1549191&r1=1549190&r2=1549191&view=diff
==============================================================================
--- creadur/rat/branches/gsoc/apache-rat-core/src/test/java/org/apache/rat/document/MockDocument.java (original)
+++ creadur/rat/branches/gsoc/apache-rat-core/src/test/java/org/apache/rat/document/MockDocument.java Sun Dec  8 20:06:46 2013
@@ -25,42 +25,92 @@ import java.io.Reader;
 import org.apache.rat.api.Document;
 import org.apache.rat.api.MetaData;
 
+/**
+ * The Class MockDocument.
+ */
 public class MockDocument implements Document {
 
+	/** The reader. */
 	public Reader reader;
+
+	/** The name. */
 	public String name;
+
+	/** The meta data. */
 	private final MetaData metaData = new MetaData();
 
+	/**
+	 * Instantiates a new mock document.
+	 */
 	public MockDocument() {
 		this(null, "name");
 	}
 
+	/**
+	 * Instantiates a new mock document.
+	 * 
+	 * @param name
+	 *            the name
+	 */
 	public MockDocument(String name) {
 		this(null, name);
 	}
 
+	/**
+	 * Instantiates a new mock document.
+	 * 
+	 * @param reader
+	 *            the reader
+	 * @param name
+	 *            the name
+	 */
 	public MockDocument(Reader reader, String name) {
 		super();
 		this.reader = reader;
 		this.name = name;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see org.apache.rat.api.Document#reader()
+	 */
 	public Reader reader() throws IOException {
 		return reader;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see org.apache.rat.api.Document#getName()
+	 */
 	public String getName() {
 		return name;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see org.apache.rat.api.Document#isComposite()
+	 */
 	public boolean isComposite() {
 		return false;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see org.apache.rat.api.Document#getMetaData()
+	 */
 	public MetaData getMetaData() {
 		return metaData;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see org.apache.rat.api.Document#inputStream()
+	 */
 	public InputStream inputStream() throws IOException {
 		throw new UnsupportedOperationException();
 	}