GET and POST commands.
- * - * The File Browser send a specific command for each and every request. This - * class is intended to reflect those in a Enum-like manner. - *
+ * Reflects File BrowserGET and POST commands.
* The commands are for GET:
@@ -81,5 +79,5 @@
*
* @param name
- * a reasonable command name
+ * the name of the new command
*/
private Command(final String name) {
@@ -88,7 +86,7 @@
/**
- * Returns the command name.
- *
- * @return the command name
+ * Returns the name of this command.
+ *
+ * @return the name of this command
*/
public String getName() {
@@ -97,17 +95,17 @@
/**
- * Returns a command object for a command name string.
- *
- * @param name
- * command to retrieve
- * @return {@link Command} object corresponding to the name
+ * Returns the command constant with the specified name.
+ *
+ * @param name
+ * the name of the constant to return
+ * @return the command constant with the specified name
* @throws IllegalArgumentException
- * if specified name has no equivalent command
+ * if this class has no constant with the specified name
* @throws NullPointerException
- * if name if null or empty
+ * if name is null or empty
*/
public static Command valueOf(final String name) {
if (Utils.isEmpty(name))
- throw new NullPointerException("Parameter name is null or empty");
+ throw new NullPointerException("Name is null or empty");
Command command = getCommands.get(name);
@@ -115,5 +113,5 @@
command = postCommands.get(name);
if (command == null)
- throw new IllegalArgumentException("No equivalent command found");
+ throw new IllegalArgumentException("No command const " + name);
return command;
@@ -121,10 +119,11 @@
/**
- * Checks if a specified command name represents a valid GET
- * command.
- *
- * @param name
- * command string to check
- * @return true if the command exists else false.
+ * Returns true if name represents a valid GET
+ * command constant.
+ *
+ * @param name
+ * the command to check
+ * @return true if name represents a valid command, else
+ * false
*/
public static boolean isValidForGet(final String name) {
@@ -133,10 +132,11 @@
/**
- * Checks if a specified command name represents a valid POST
- * command.
- *
- * @param name
- * command string to check
- * @return true if the command exists else false.
+ * Returns true if name represents a valid POST
+ * command constant.
+ *
+ * @param name
+ * the command to check
+ * @return true if name represents a valid command, else
+ * false
*/
public static boolean isValidForPost(final String name) {
@@ -145,11 +145,12 @@
/**
- * Returns a command object for a command name string. In contrast to
- * {@link Command#valueOf(String)} it returns a null instead of
- * throwing an exception if a command was not found.
- *
- * @param name
- * command to retrieve
- * @return {@link Command} object corresponding to the name (may be null)
+ * Returns the command constant with the specified name. In contrast to
+ * {@link #valueOf(String)} it returns a null instead of throwing an
+ * exception if a command constant was not found.
+ *
+ * @param name
+ * the name of the constant to return
+ * @return the command constant with the specified name, else
+ * null
*/
public static Command getCommand(final String name) {
@@ -160,9 +161,13 @@
}
}
-
- /*
- * (non-Javadoc)
- *
- * @see java.lang.Object#equals(java.lang.Object)
+
+ /**
+ * Compares the specified object with this command for equality. The
+ * comparison is based on class and name only.
+ *
+ * @param obj
+ * Object to be compared with this command.
+ * @return true if the specified object is equal to this
+ * command
*/
@Override
@@ -178,8 +183,9 @@
}
- /*
- * (non-Javadoc)
- *
- * @see java.lang.Object#toString()
+ /**
+ * Returns the hash code value for this command. The hash code equals the
+ * hash code of the name field.
+ *
+ * @return the hash code value for this command
*/
@Override
@@ -188,8 +194,9 @@
}
- /*
- * (non-Javadoc)
- *
- * @see java.lang.Object#toString()
+ /**
+ * Returns a string representation of this command.
+ *
+ * @return a string representation of this command
+ * @see #getName()
*/
@Override
Index: /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/handlers/RequestCycleHandler.java
===================================================================
--- /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/handlers/RequestCycleHandler.java (revision 3420)
+++ /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/handlers/RequestCycleHandler.java (revision 3421)
@@ -102,5 +102,5 @@
*
* @param request
- * current request instance
+ * current user request instance
* @return true if user is allowed to list resources, false otherwise
* @see UserAction#isEnabledForFileBrowsing(HttpServletRequest)
@@ -131,5 +131,5 @@
*
* @param request
- * current request instance
+ * current user request instance
* @return true if user is allowed to upload files, false otherwise
* @see UserAction#isEnabledForFileUpload(HttpServletRequest)
@@ -144,5 +144,5 @@
*
* @param request
- * current request instance
+ * current user request instance
* @return true if user is allowed to create folders, false otherwise
* @see UserAction#isEnabledForFileBrowsing(HttpServletRequest)
@@ -157,5 +157,5 @@
*
* @param request
- * current request instance
+ * current user request instance
* @return current userfiles path
* @see UserPathBuilder#getUserFilesPath(HttpServletRequest)
@@ -172,5 +172,5 @@
*
* @param request
- * current request instance
+ * current user request instance
* @return current absolute userfiles path
* @see UserPathBuilder#getUserFilesAbsolutePath(HttpServletRequest)
Index: /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/handlers/ResourceType.java
===================================================================
--- /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/handlers/ResourceType.java (revision 3420)
+++ /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/handlers/ResourceType.java (revision 3421)
@@ -29,7 +29,15 @@
/**
- * This class maps to all file browser resource types and their allowed/denied
- * extensions. The design is restricted to the static types only, you cannot
- * create your own types. External access to all fields is read-only.
+ * Reflects File Browser resource types. The File Browser provides a specific
+ * resource type for each and every request. This class is intended to reflect
+ * these in an Enum-like manner.
+ *
+ * The resource types are: + *
File */
@@ -90,7 +99,11 @@
*
* @param name
+ * the name of the new resource type
* @param path
+ * the absolute path of the new resource type
* @param allowedEextensions
+ * the allowed extensions set of the new resource type
* @param deniedExtensions
+ * the denied extensions set of the new resource type
* @throws IllegalArgumentException
* if both sets are empty
@@ -117,7 +130,7 @@
/**
- * Returns the name of the resource type.
- *
- * @return the name
+ * Returns the name of this resource type.
+ *
+ * @return the name of this resource type
*/
public String getName() {
@@ -126,10 +139,9 @@
/**
- * Returns the absolute path of the resource type. This path will later be
- * resolved against the
- * {@link RequestCycleHandler#getUserFilesPath(javax.servlet.http.HttpServletRequest)
- * UserFilesPath}.
- *
- * @return the path
+ * Returns the absolute path of the resource type. This path is absolute to
+ * the userfiles path. To set this path, see the configuration.
+ *
+ * @return the absolute path of this resource type
*/
public String getPath() {
@@ -140,5 +152,5 @@
* Returns a read-only reference to the allowed extensions set.
*
- * @return the allowedEextensions
+ * @return the read-only allowed extensions set of this resource type
*/
public Setnull, empty, or does not exist.
+ * if this class has no constant with the specified name
+ * @throws NullPointerException
+ * if name is null or empty
*/
public static ResourceType valueOf(final String name) {
if (Utils.isEmpty(name))
- throw new NullPointerException("Parameter name is null or empty");
+ throw new NullPointerException("Name is null or empty");
ResourceType rt = types.get(name);
if (rt == null)
- throw new IllegalArgumentException(
- "No suitable resource type found");
+ throw new IllegalArgumentException("No resource type const " + name);
return rt;
}
/**
- * Determines if a specified string represents a valid resource type.true if the string represents a valid resource type
- * else false.
+ * Returns true if name represents a valid resource type
+ * constant.
+ *
+ * @param name
+ * the resource type to check
+ * @return true if name represents a valid resource type, else
+ * false
*/
public static boolean isValidType(final String name) {
- return (Utils.isEmpty(name)) ? false : types.containsKey(name);
- }
-
- /**
- * This method wraps {@link #valueOf(String)}. It returns null
- * instead of throwing an IllegalArgumentException.null.
+ // HashMap permits null keys, so it will return false in that case
+ return types.containsKey(name);
+ }
+
+ /**
+ * Returns the resource type constant with the specified name. In contrast
+ * to {@link #valueOf(String)} it returns a null instead of throwing an
+ * exception if a resource type constant was not found.
+ *
+ * @param name
+ * the name of the constant to return
+ * @return the resource type constant with the specified name, else
+ * null
*/
public static ResourceType getResourceType(final String name) {
@@ -206,11 +221,12 @@
/**
- * This method wraps {@link #getResourceType(String)}. It returns
- * {@link #FILE} instead of returning null.null.
+ *
+ * @param name
+ * the name of the constant to return
+ * @return the resource type constant with the specified name, else
+ * FILE
*/
public static ResourceType getDefaultResourceType(final String name) {
@@ -220,12 +236,13 @@
/**
- * Determines if an extension passes/suits the allowed or denied set.true if extension is allowed. Denied extensions set
+ * takes precedence over allowed extensions set, in other words a negative
+ * check is made against denied set and if this fails, allowed set is
+ * checked.
*
* @param extension
- * Extension string.
- * @return true if the extension passes, else
- * false.
+ * the extension to check, empty will fail
+ * @return true if extension is allowed, else
+ * false
*/
public boolean isAllowedExtension(final String extension) {
@@ -244,4 +261,7 @@
* the return value.
*
+ * @deprecated Method will be removed in FCKeditor.Java 2.6, use
+ * {@link #isDeniedExtension(String)}.
+ * @see #isDeniedExtension(String)
* @param extension
* Extension string.
@@ -249,4 +269,5 @@
* false.
*/
+ @Deprecated
public boolean isNotAllowedExtension(final String extension) {
return !isAllowedExtension(extension);
@@ -254,5 +275,23 @@
/**
- * Compares this with the passed object against the name field.
+ * Returns true if extension is denied. This method simply
+ * negates {@link #isAllowedExtension(String)}.
+ *
+ * @param extension
+ * the extension to check, empty will fail
+ * @return true if extension is denied, else false
+ */
+ public boolean isDeniedExtension(final String extension) {
+ return !isAllowedExtension(extension);
+ }
+
+ /**
+ * Compares the specified object with this resource type for equality. The
+ * comparison is based on class and name only.
+ *
+ * @param obj
+ * Object to be compared with this resource type.
+ * @return true if the specified object is equal to this
+ * resource type
*/
@Override
@@ -269,5 +308,8 @@
/**
- * Computer hash code based on the name field.
+ * Returns the hash code value for this resource type. The hash code equals
+ * the hash code of the name field.
+ *
+ * @return the hash code value for this resource type
*/
@Override