creadur-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rdon...@apache.org
Subject svn commit: r1549240 - /creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/header/HeaderMatcher.java
Date Sun, 08 Dec 2013 21:01:05 GMT
Author: rdonkin
Date: Sun Dec  8 21:01:05 2013
New Revision: 1549240

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

Modified:
    creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/header/HeaderMatcher.java

Modified: creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/header/HeaderMatcher.java
URL: http://svn.apache.org/viewvc/creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/header/HeaderMatcher.java?rev=1549240&r1=1549239&r2=1549240&view=diff
==============================================================================
--- creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/header/HeaderMatcher.java
(original)
+++ creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/header/HeaderMatcher.java
Sun Dec  8 21:01:05 2013
@@ -42,15 +42,40 @@ import java.util.regex.Pattern;
  */
 public class HeaderMatcher {
 
+	/** The factory. */
 	private final FilteringSequenceFactory factory;
+
+	/** The headers. */
 	private final HeaderBean[] headers;
+
+	/** The read. */
 	private CharSequence read;
+
+	/** The lines. */
 	private int lines;
 
+	/**
+	 * Instantiates a new header matcher.
+	 * 
+	 * @param filter
+	 *            the filter
+	 * @param capacity
+	 *            the capacity
+	 */
 	public HeaderMatcher(final CharFilter filter, final int capacity) {
 		this(filter, capacity, null);
 	}
 
+	/**
+	 * Instantiates a new header matcher.
+	 * 
+	 * @param filter
+	 *            the filter
+	 * @param capacity
+	 *            the capacity
+	 * @param headers
+	 *            the headers
+	 */
 	public HeaderMatcher(final CharFilter filter, final int capacity,
 			final HeaderBean[] headers) {
 		factory = new FilteringSequenceFactory(capacity, filter);
@@ -58,6 +83,14 @@ public class HeaderMatcher {
 		this.headers = headers;
 	}
 
+	/**
+	 * Read.
+	 * 
+	 * @param reader
+	 *            the reader
+	 * @throws IOException
+	 *             Signals that an I/O exception has occurred.
+	 */
 	public void read(Reader reader) throws IOException {
 		final LineNumberReader lineNumberReader = new LineNumberReader(reader);
 		read = factory.filter(lineNumberReader);



Mime
View raw message