Author: remm Date: Mon Jan 18 23:07:45 2016 New Revision: 1725382 URL: http://svn.apache.org/viewvc?rev=1725382&view=rev Log: Javadoc fixes.
Modified: tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ContextHandler.java tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ContextService.java tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ContextTransaction.java tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ErrorPage.java tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/FilterMap.java tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ResourceBase.java tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/SecurityCollection.java tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/SecurityConstraint.java tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ServletDef.java tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/WebRuleSet.java tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/WebXml.java Modified: tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ContextHandler.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ContextHandler.java?rev=1725382&r1=1725381&r2=1725382&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ContextHandler.java (original) +++ tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ContextHandler.java Mon Jan 18 23:07:45 2016 @@ -73,6 +73,8 @@ public class ContextHandler extends Reso /** * Set a configured property. + * @param name The property name + * @param value The property value */ public void setProperty(String name, String value) { this.setProperty(name, (Object) value); Modified: tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ContextService.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ContextService.java?rev=1725382&r1=1725381&r2=1725382&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ContextService.java (original) +++ tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ContextService.java Mon Jan 18 23:07:45 2016 @@ -165,7 +165,7 @@ public class ContextService extends Reso * Declares a client dependency on the container to resolving a Service Endpoint Interface * to a WSDL port. It optionally associates the Service Endpoint Interface with a * particular port-component. - * + * @return the endpoint names */ public Iterator<String> getServiceendpoints() { return this.listProperties(); Modified: tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ContextTransaction.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ContextTransaction.java?rev=1725382&r1=1725381&r2=1725382&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ContextTransaction.java (original) +++ tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ContextTransaction.java Mon Jan 18 23:07:45 2016 @@ -42,7 +42,8 @@ public class ContextTransaction implemen private final HashMap<String, Object> properties = new HashMap<>(); /** - * Return a configured property. + * @param name The property name + * @return a configured property. */ public Object getProperty(String name) { return properties.get(name); @@ -50,13 +51,16 @@ public class ContextTransaction implemen /** * Set a configured property. + * @param name The property name + * @param value The property value */ public void setProperty(String name, Object value) { properties.put(name, value); } /** - * remove a configured property. + * Remove a configured property. + * @param name The property name */ public void removeProperty(String name) { properties.remove(name); @@ -64,6 +68,7 @@ public class ContextTransaction implemen /** * List properties. + * @return the property names iterator */ public Iterator<String> listProperties() { return properties.keySet().iterator(); Modified: tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ErrorPage.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ErrorPage.java?rev=1725382&r1=1725381&r2=1725382&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ErrorPage.java (original) +++ tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ErrorPage.java Mon Jan 18 23:07:45 2016 @@ -57,7 +57,7 @@ public class ErrorPage implements Serial /** - * Return the error code. + * @return the error code. */ public int getErrorCode() { @@ -95,7 +95,7 @@ public class ErrorPage implements Serial /** - * Return the exception type. + * @return the exception type. */ public String getExceptionType() { @@ -117,7 +117,7 @@ public class ErrorPage implements Serial /** - * Return the location. + * @return the location. */ public String getLocation() { Modified: tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/FilterMap.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/FilterMap.java?rev=1725382&r1=1725381&r2=1725382&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/FilterMap.java (original) +++ tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/FilterMap.java Mon Jan 18 23:07:45 2016 @@ -138,9 +138,10 @@ public class FilterMap implements Serial } /** - * * This method will be used to set the current state of the FilterMap * representing the state of when filters should be applied. + * @param dispatcherString the dispatcher type which should + * match this filter */ public void setDispatcher(String dispatcherString) { String dispatcher = dispatcherString.toUpperCase(Locale.ENGLISH); Modified: tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ResourceBase.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ResourceBase.java?rev=1725382&r1=1725381&r2=1725382&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ResourceBase.java (original) +++ tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ResourceBase.java Mon Jan 18 23:07:45 2016 @@ -86,7 +86,8 @@ public class ResourceBase implements Ser private final HashMap<String, Object> properties = new HashMap<>(); /** - * Return a configured property. + * @param name The property name + * @return a configured property. */ public Object getProperty(String name) { return properties.get(name); @@ -94,6 +95,8 @@ public class ResourceBase implements Ser /** * Set a configured property. + * @param name The property name + * @param value The property value */ public void setProperty(String name, Object value) { properties.put(name, value); @@ -101,6 +104,7 @@ public class ResourceBase implements Ser /** * Remove a configured property. + * @param name The property name */ public void removeProperty(String name) { properties.remove(name); @@ -108,6 +112,7 @@ public class ResourceBase implements Ser /** * List properties. + * @return the property names iterator */ public Iterator<String> listProperties() { return properties.keySet().iterator(); Modified: tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/SecurityCollection.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/SecurityCollection.java?rev=1725382&r1=1725381&r2=1725382&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/SecurityCollection.java (original) +++ tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/SecurityCollection.java Mon Jan 18 23:07:45 2016 @@ -108,7 +108,7 @@ public class SecurityCollection implemen /** - * Return the description of this web resource collection. + * @return the description of this web resource collection. */ public String getDescription() { @@ -130,7 +130,7 @@ public class SecurityCollection implemen /** - * Return the name of this web resource collection. + * @return the name of this web resource collection. */ public String getName() { @@ -152,7 +152,7 @@ public class SecurityCollection implemen /** - * Return if this constraint was defined in a deployment descriptor. + * @return if this constraint was defined in a deployment descriptor. */ public boolean isFromDescriptor() { return isFromDescriptor; @@ -161,6 +161,7 @@ public class SecurityCollection implemen /** * Set if this constraint was defined in a deployment descriptor. + * @param isFromDescriptor <code>true</code> was declared in a descriptor */ public void setFromDescriptor(boolean isFromDescriptor) { this.isFromDescriptor = isFromDescriptor; @@ -173,6 +174,7 @@ public class SecurityCollection implemen /** * Add an HTTP request method to be explicitly part of this web resource * collection. + * @param method The method */ public void addMethod(String method) { @@ -190,6 +192,7 @@ public class SecurityCollection implemen /** * Add an HTTP request method to the methods explicitly excluded from this * web resource collection. + * @param method The method */ public void addOmittedMethod(String method) { if (method == null) @@ -203,6 +206,7 @@ public class SecurityCollection implemen /** * Add a URL pattern to be part of this web resource collection. + * @param pattern The pattern */ public void addPattern(String pattern) { @@ -221,10 +225,10 @@ public class SecurityCollection implemen /** - * Return <code>true</code> if the specified HTTP request method is - * part of this web resource collection. - * + * Check if the collection applies to the specified method. * @param method Request method to check + * @return <code>true</code> if the specified HTTP request method is + * part of this web resource collection. */ public boolean findMethod(String method) { @@ -248,7 +252,7 @@ public class SecurityCollection implemen /** - * Return the set of HTTP request methods that are part of this web + * @return the set of HTTP request methods that are part of this web * resource collection, or a zero-length array if no methods have been * explicitly included. */ @@ -260,7 +264,7 @@ public class SecurityCollection implemen /** - * Return the set of HTTP request methods that are explicitly excluded from + * @return the set of HTTP request methods that are explicitly excluded from * this web resource collection, or a zero-length array if no request * methods are excluded. */ @@ -275,6 +279,7 @@ public class SecurityCollection implemen * Is the specified pattern part of this web resource collection? * * @param pattern Pattern to be compared + * @return <code>true</code> if the pattern is part of the collection */ public boolean findPattern(String pattern) { @@ -288,7 +293,7 @@ public class SecurityCollection implemen /** - * Return the set of URL patterns that are part of this web resource + * @return the set of URL patterns that are part of this web resource * collection. If none have been specified, a zero-length array is * returned. */ Modified: tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/SecurityConstraint.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/SecurityConstraint.java?rev=1725382&r1=1725381&r2=1725382&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/SecurityConstraint.java (original) +++ tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/SecurityConstraint.java Mon Jan 18 23:07:45 2016 @@ -131,6 +131,7 @@ public class SecurityConstraint implemen /** * Was the "all roles" wildcard included in this authentication * constraint? + * @return <code>true</code> if all roles */ public boolean getAllRoles() { @@ -142,6 +143,7 @@ public class SecurityConstraint implemen /** * Was the "all authenticated users" wildcard included in this * authentication constraint? + * @return <code>true</code> if all authenticated users */ public boolean getAuthenticatedUsers() { return this.authenticatedUsers; @@ -151,6 +153,7 @@ public class SecurityConstraint implemen /** * Return the authorization constraint present flag for this security * constraint. + * @return <code>true</code> if this needs authorization */ public boolean getAuthConstraint() { @@ -162,6 +165,7 @@ public class SecurityConstraint implemen /** * Set the authorization constraint present flag for this security * constraint. + * @param authConstraint The new value */ public void setAuthConstraint(boolean authConstraint) { @@ -171,7 +175,7 @@ public class SecurityConstraint implemen /** - * Return the display name of this security constraint. + * @return the display name of this security constraint. */ public String getDisplayName() { @@ -182,6 +186,7 @@ public class SecurityConstraint implemen /** * Set the display name of this security constraint. + * @param displayName The new value */ public void setDisplayName(String displayName) { @@ -192,6 +197,7 @@ public class SecurityConstraint implemen /** * Return the user data constraint for this security constraint. + * @return the user constraint */ public String getUserConstraint() { @@ -285,10 +291,11 @@ public class SecurityConstraint implemen /** - * Return <code>true</code> if the specified role is permitted access to - * the resources protected by this security constraint. + * Check a role. * * @param role Role name to be checked + * @return <code>true</code> if the specified role is permitted access to + * the resources protected by this security constraint. */ public boolean findAuthRole(String role) { @@ -308,6 +315,7 @@ public class SecurityConstraint implemen * protected by this security constraint. If none have been defined, * a zero-length array is returned (which implies that all authenticated * users are permitted access). + * @return the roles array */ public String[] findAuthRoles() { @@ -321,6 +329,7 @@ public class SecurityConstraint implemen * otherwise, return <code>null</code>. * * @param name Web resource collection name to return + * @return the collection */ public SecurityCollection findCollection(String name) { @@ -339,6 +348,7 @@ public class SecurityConstraint implemen * Return all of the web resource collections protected by this * security constraint. If there are none, a zero-length array is * returned. + * @return the collections array */ public SecurityCollection[] findCollections() { @@ -348,11 +358,11 @@ public class SecurityConstraint implemen /** - * Return <code>true</code> if the specified context-relative URI (and - * associated HTTP method) are protected by this security constraint. - * + * Check if the contraint applies to a URI and method. * @param uri Context-relative URI to check * @param method Request method being used + * @return <code>true</code> if the specified context-relative URI (and + * associated HTTP method) are protected by this security constraint. */ public boolean included(String uri, String method) { Modified: tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ServletDef.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ServletDef.java?rev=1725382&r1=1725381&r2=1725382&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ServletDef.java (original) +++ tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/ServletDef.java Mon Jan 18 23:07:45 2016 @@ -212,6 +212,7 @@ public class ServletDef implements Seria /** * Add a security-role-ref to the set of security-role-refs associated * with this servlet. + * @param securityRoleRef The security role */ public void addSecurityRoleRef(SecurityRoleRef securityRoleRef) { securityRoleRefs.add(securityRoleRef); Modified: tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/WebRuleSet.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/WebRuleSet.java?rev=1725382&r1=1725381&r2=1725382&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/WebRuleSet.java (original) +++ tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/WebRuleSet.java Mon Jan 18 23:07:45 2016 @@ -118,6 +118,7 @@ public class WebRuleSet extends RuleSetB /** * Construct an instance of this <code>RuleSet</code> with the default * matching pattern prefix. + * @param fragment <code>true</code> if this is a web fragment */ public WebRuleSet(boolean fragment) { @@ -132,6 +133,7 @@ public class WebRuleSet extends RuleSetB * * @param prefix Prefix for matching pattern rules (including the * trailing slash character) + * @param fragment <code>true</code> if this is a web fragment */ public WebRuleSet(String prefix, boolean fragment) { Modified: tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/WebXml.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/WebXml.java?rev=1725382&r1=1725381&r2=1725382&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/WebXml.java (original) +++ tomcat/trunk/java/org/apache/tomcat/util/descriptor/web/WebXml.java Mon Jan 18 23:07:45 2016 @@ -60,9 +60,11 @@ public class WebXml { private static final Log log = LogFactory.getLog(WebXml.class); - // Global defaults are overridable but Servlets and Servlet mappings need to - // be unique. Duplicates normally trigger an error. This flag indicates if - // newly added Servlet elements are marked as overridable. + /** + * Global defaults are overridable but Servlets and Servlet mappings need to + * be unique. Duplicates normally trigger an error. This flag indicates if + * newly added Servlet elements are marked as overridable. + */ private boolean overridable = false; public boolean isOverridable() { return overridable; @@ -71,8 +73,10 @@ public class WebXml { this.overridable = overridable; } - // web.xml only elements - // Absolute Ordering + /** + * web.xml only elements + * Absolute Ordering + */ private Set<String> absoluteOrdering = null; public void createAbsoluteOrdering() { if (absoluteOrdering == null) { @@ -91,8 +95,10 @@ public class WebXml { return absoluteOrdering; } - // web-fragment.xml only elements - // Relative ordering + /** + * web-fragment.xml only elements + * Relative ordering + */ private final Set<String> after = new LinkedHashSet<>(); public void addAfterOrdering(String fragmentName) { after.add(fragmentName); @@ -339,6 +345,8 @@ public class WebXml { /** * When merging/parsing web.xml files into this web.xml should the current * set be completely replaced? + * @param replaceWelcomeFiles <code>true</code> to replace welcome files + * rather than add to the list */ public void setReplaceWelcomeFiles(boolean replaceWelcomeFiles) { this.replaceWelcomeFiles = replaceWelcomeFiles; @@ -346,6 +354,7 @@ public class WebXml { /** * When merging from this web.xml, should the welcome files be added to the * target web.xml even if it already contains welcome file definitions. + * @param alwaysAddWelcomeFiles <code>true</code> to add welcome files */ public void setAlwaysAddWelcomeFiles(boolean alwaysAddWelcomeFiles) { this.alwaysAddWelcomeFiles = alwaysAddWelcomeFiles; --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org