creadur-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rdon...@apache.org
Subject svn commit: r1549122 - /creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/ArchiveGuesser.java
Date Sun, 08 Dec 2013 19:09:04 GMT
Author: rdonkin
Date: Sun Dec  8 19:09:04 2013
New Revision: 1549122

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

Modified:
    creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/ArchiveGuesser.java

Modified: creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/ArchiveGuesser.java
URL: http://svn.apache.org/viewvc/creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/ArchiveGuesser.java?rev=1549122&r1=1549121&r2=1549122&view=diff
==============================================================================
--- creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/ArchiveGuesser.java
(original)
+++ creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/ArchiveGuesser.java
Sun Dec  8 19:09:04 2013
@@ -22,28 +22,53 @@ import java.util.Locale;
 
 import org.apache.rat.api.Document;
 
+/**
+ * The Class ArchiveGuesser.
+ */
 public class ArchiveGuesser {
 
+	/** The Constant ARCHIVE_EXTENSIONS. */
 	private static final String[] ARCHIVE_EXTENSIONS = { "jar", "gz", "zip",
 			"tar", "bz", "bz2", "rar", "war", };
 
+	/** The archive extensions. */
 	private final String[] archiveExtensions;
 
+	/**
+	 * Instantiates a new archive guesser.
+	 */
 	public ArchiveGuesser() {
 		this(ARCHIVE_EXTENSIONS);
 	}
 
+	/**
+	 * Instantiates a new archive guesser.
+	 * 
+	 * @param archiveExtensions
+	 *            the archive extensions
+	 */
 	public ArchiveGuesser(final String[] archiveExtensions) {
 		super();
 		this.archiveExtensions = archiveExtensions;
 	}
 
+	/**
+	 * Matches.
+	 * 
+	 * @param subject
+	 *            the subject
+	 * @return true, if successful
+	 */
 	public boolean matches(final Document subject) {
 		return isArchive(subject.getName());
 	}
 
 	/**
-	 * Is a file by that name an archive?
+	 * Is a file by that name an archive?.
+	 * 
+	 * @param name
+	 *            the name
+	 * @return true, if is archive
 	 */
 	public boolean isArchive(final String name) {
 		if (name == null) {



Mime
View raw message