Author: musachy
Date: Fri Feb 13 15:04:51 2009
New Revision: 744139
URL: http://svn.apache.org/viewvc?rev=744139&view=rev
Log:
Add missing javadoc tags, remove unused code and add some logging
Modified:
struts/struts2/trunk/plugins/convention/src/main/java/org/apache/struts2/convention/DefaultResultMapBuilder.java
struts/struts2/trunk/plugins/convention/src/main/java/org/apache/struts2/convention/PackageBasedActionConfigBuilder.java
struts/struts2/trunk/plugins/convention/src/main/java/org/apache/struts2/convention/classloader/FileResourceStore.java
struts/struts2/trunk/plugins/convention/src/main/java/org/apache/struts2/convention/classloader/ResourceStore.java
Modified:
struts/struts2/trunk/plugins/convention/src/main/java/org/apache/struts2/convention/DefaultResultMapBuilder.java
URL:
http://svn.apache.org/viewvc/struts/struts2/trunk/plugins/convention/src/main/java/org/apache/struts2/convention/DefaultResultMapBuilder.java?rev=744139&r1=744138&r2=744139&view=diff
==============================================================================
---
struts/struts2/trunk/plugins/convention/src/main/java/org/apache/struts2/convention/DefaultResultMapBuilder.java
(original)
+++
struts/struts2/trunk/plugins/convention/src/main/java/org/apache/struts2/convention/DefaultResultMapBuilder.java
Fri Feb 13 15:04:51 2009
@@ -198,6 +198,11 @@
/**
* Creates results from @Results and @Result annotations
+ * @param actionClass class to check for annotations
+ * @param packageConfig packageConfig where the action will be located
+ * @param defaultResultPath default result path
+ * @param results map of results
+ * @param resultsByExtension map of result types keyed by extension
*/
protected void createResultsFromAnnotations(Class<?> actionClass,
PackageConfig packageConfig, String defaultResultPath,
Map<String, ResultConfig>
results, Map<String, ResultTypeConfig> resultsByExtension) {
Modified:
struts/struts2/trunk/plugins/convention/src/main/java/org/apache/struts2/convention/PackageBasedActionConfigBuilder.java
URL:
http://svn.apache.org/viewvc/struts/struts2/trunk/plugins/convention/src/main/java/org/apache/struts2/convention/PackageBasedActionConfigBuilder.java?rev=744139&r1=744138&r2=744139&view=diff
==============================================================================
---
struts/struts2/trunk/plugins/convention/src/main/java/org/apache/struts2/convention/PackageBasedActionConfigBuilder.java
(original)
+++
struts/struts2/trunk/plugins/convention/src/main/java/org/apache/struts2/convention/PackageBasedActionConfigBuilder.java
Fri Feb 13 15:04:51 2009
@@ -140,8 +140,8 @@
}
/**
- * Comma separated list of file protocols that will be considered as jar
files and scanned
- * @param fileProtocols
+ * File URLs whose protocol are in these list will be processed as jars
containing classes
+ * @param fileProtocols Comma separated list of file protocols that will
be considered as jar files and scanned
*/
@Inject("struts.convention.action.fileProtocols")
public void setFileProtocols(String fileProtocols) {
@@ -168,7 +168,7 @@
}
/**
- * @param disableActionScanning If set to true, only the named packages
will be scanned
+ * @param disablePackageLocatorsScanning If set to true, only the named
packages will be scanned
*/
@Inject(value = "struts.convention.package.locators.disable", required =
false)
public void setDisablePackageLocatorsScanning(String
disablePackageLocatorsScanning) {
@@ -187,7 +187,7 @@
}
/**
- * @param actionPackages (Optional) Map classes that implement
com.opensymphony.xwork2.Action
+ * @param checkImplementsAction (Optional) Map classes that implement
com.opensymphony.xwork2.Action
* as actions
*/
@Inject(value = "struts.convention.action.checkImplementsAction", required
= false)
@@ -524,6 +524,8 @@
/**
* Interfaces, enums, annotations, and abstract classes cannot be
instantiated.
+ * @param actionClass class to check
+ * @return returns true if the class cannot be instantiated or should be
ignored
*/
protected boolean cannotInstantiate(Class<?> actionClass) {
return actionClass.isAnnotation() || actionClass.isInterface() ||
actionClass.isEnum() ||
Modified:
struts/struts2/trunk/plugins/convention/src/main/java/org/apache/struts2/convention/classloader/FileResourceStore.java
URL:
http://svn.apache.org/viewvc/struts/struts2/trunk/plugins/convention/src/main/java/org/apache/struts2/convention/classloader/FileResourceStore.java?rev=744139&r1=744138&r2=744139&view=diff
==============================================================================
---
struts/struts2/trunk/plugins/convention/src/main/java/org/apache/struts2/convention/classloader/FileResourceStore.java
(original)
+++
struts/struts2/trunk/plugins/convention/src/main/java/org/apache/struts2/convention/classloader/FileResourceStore.java
Fri Feb 13 15:04:51 2009
@@ -20,6 +20,9 @@
*/
package org.apache.struts2.convention.classloader;
+import com.opensymphony.xwork2.util.logging.Logger;
+import com.opensymphony.xwork2.util.logging.LoggerFactory;
+
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
@@ -31,7 +34,7 @@
* class taken from Apache JCI
*/
public final class FileResourceStore implements ResourceStore {
-
+ private static final Logger LOG =
LoggerFactory.getLogger(FileResourceStore.class);
private final File root;
public FileResourceStore(final File pFile) {
@@ -48,6 +51,8 @@
return data;
} catch (Exception e) {
+ if (LOG.isErrorEnabled())
+ LOG.error("Unable to read file [#0]", e, pResourceName);
return null;
} finally {
closeQuietly(fis);
@@ -63,13 +68,11 @@
if (is != null)
is.close();
} catch (IOException e) {
+ if (LOG.isErrorEnabled())
+ LOG.error("Unable to close file input stream", e);
}
}
- public void remove(final String pResourceName) {
- getFile(pResourceName).delete();
- }
-
private File getFile(final String pResourceName) {
final String fileName = pResourceName.replace('/', File.separatorChar);
return new File(root, fileName);
@@ -78,6 +81,4 @@
public String toString() {
return this.getClass().getName() + root.toString();
}
-
-
}
Modified:
struts/struts2/trunk/plugins/convention/src/main/java/org/apache/struts2/convention/classloader/ResourceStore.java
URL:
http://svn.apache.org/viewvc/struts/struts2/trunk/plugins/convention/src/main/java/org/apache/struts2/convention/classloader/ResourceStore.java?rev=744139&r1=744138&r2=744139&view=diff
==============================================================================
---
struts/struts2/trunk/plugins/convention/src/main/java/org/apache/struts2/convention/classloader/ResourceStore.java
(original)
+++
struts/struts2/trunk/plugins/convention/src/main/java/org/apache/struts2/convention/classloader/ResourceStore.java
Fri Feb 13 15:04:51 2009
@@ -28,7 +28,5 @@
void write(final String pResourceName, final byte[] pResourceData);
byte[] read(final String pResourceName);
-
- void remove(final String pResourceName);
}
