Author: rdonkin
Date: Sun Dec 8 19:10:18 2013
New Revision: 1549124
URL: http://svn.apache.org/r1549124
Log:
Add java doc.
Modified:
creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/document/impl/DocumentImplUtils.java
Modified:
creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/document/impl/DocumentImplUtils.java
URL:
http://svn.apache.org/viewvc/creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/document/impl/DocumentImplUtils.java?rev=1549124&r1=1549123&r2=1549124&view=diff
==============================================================================
---
creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/document/impl/DocumentImplUtils.java
(original)
+++
creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/document/impl/DocumentImplUtils.java
Sun Dec 8 19:10:18 2013
@@ -28,21 +28,23 @@ import java.util.zip.ZipInputStream;
import org.apache.commons.io.IOUtils;
/**
- *
+ * The Class DocumentImplUtils.
*/
public final class DocumentImplUtils {
/**
- *
+ * Instantiates a new document impl utils.
*/
private DocumentImplUtils() {
super();
}
/**
+ * To name.
*
* @param file
- * @return
+ * the file
+ * @return the string
*/
public final static String toName(final File file) {
String path = file.getPath();
@@ -50,9 +52,11 @@ public final class DocumentImplUtils {
}
/**
+ * Checks if is zip stream.
*
* @param stream
- * @return
+ * the stream
+ * @return true, if is zip stream
*/
public static final boolean isZipStream(final InputStream stream) {
ZipInputStream zip = new ZipInputStream(stream);
@@ -70,9 +74,11 @@ public final class DocumentImplUtils {
}
/**
+ * Checks if is zip.
*
* @param file
- * @return
+ * the file
+ * @return true, if is zip
*/
public static final boolean isZip(final File file) {
boolean result;
