svn commit: r1428367 - /commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileContentInfoFactory.java

[gg...@apache.org]

Author: ggregory
Date: Thu Jan  3 14:45:12 2013
New Revision: 1428367

URL: http://svn.apache.org/viewvc?rev=1428367&view=rev
Log:
Javadoc.

Modified:
    commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileContentInfoFactory.java

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileContentInfoFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileContentInfoFactory.java?rev=1428367&r1=1428366&r2=1428367&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileContentInfoFactory.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileContentInfoFactory.java Thu Jan  3 14:45:12 2013
@@ -17,9 +17,18 @@
 package org.apache.commons.vfs2;
 
 /**
- * Create a class which is able to determine the content-info for the given content.
+ * Creates {@link FileContentInfo} instances to determine the content-info for given file contents.
  */
 public interface FileContentInfoFactory
 {
+    /**
+     * Creates a FileContentInfo for a the given FileContent.
+     * 
+     * @param fileContent
+     *            Use this FileContent to create a matching FileContentInfo
+     * @return a FileContentInfo for the given FileContent.
+     * @throws FileSystemException
+     *             when a problem occurs creating the FileContentInfo.
+     */
     FileContentInfo create(FileContent fileContent) throws FileSystemException;
 }