Author: markt Date: Mon Sep 21 10:48:18 2015 New Revision: 1704261 URL: http://svn.apache.org/viewvc?rev=1704261&view=rev Log: Code clean-up Remove deprecated code. Fix Javadoc warnings. No functional change.
Modified: tomcat/trunk/java/org/apache/tomcat/util/digester/Rule.java Modified: tomcat/trunk/java/org/apache/tomcat/util/digester/Rule.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/digester/Rule.java?rev=1704261&r1=1704260&r2=1704261&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/util/digester/Rule.java (original) +++ tomcat/trunk/java/org/apache/tomcat/util/digester/Rule.java Mon Sep 21 10:48:18 2015 @@ -14,25 +14,18 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - - package org.apache.tomcat.util.digester; - import org.xml.sax.Attributes; - /** * Concrete implementations of this class implement actions to be taken when * a corresponding nested pattern of XML elements has been matched. */ - public abstract class Rule { - // ----------------------------------------------------------- Constructors - /** * <p>Base constructor. * Now the digester will be set when the rule is added.</p> @@ -57,32 +50,35 @@ public abstract class Rule { // ------------------------------------------------------------- Properties - /** - * Return the Digester with which this Rule is associated. + * Identify the Digester with which this Rule is associated. + * + * @return the Digester with which this Rule is associated. */ public Digester getDigester() { - - return (this.digester); - + return digester; } + /** - * Set the <code>Digester</code> with which this <code>Rule</code> is associated. + * Set the <code>Digester</code> with which this <code>Rule</code> is + * associated. + * + * @param digester The digester with which to associate this rule */ public void setDigester(Digester digester) { - this.digester = digester; - } + /** * Return the namespace URI for which this Rule is relevant, if any. + * + * @return The namespace URI for which this rule is relevant or + * <code>null</code> if none. */ public String getNamespaceURI() { - - return (this.namespaceURI); - + return namespaceURI; } @@ -93,134 +89,73 @@ public abstract class Rule { * or <code>null</code> to match independent of namespace. */ public void setNamespaceURI(String namespaceURI) { - this.namespaceURI = namespaceURI; - } // --------------------------------------------------------- Public Methods - - /** - * This method is called when the beginning of a matching XML element - * is encountered. - * - * @param attributes The attribute list of this element - * @deprecated Use the {@link #begin(String,String,Attributes) begin} - * method with <code>namespace</code> and <code>name</code> - * parameters instead. - */ - @Deprecated - public void begin(Attributes attributes) throws Exception { - // The default implementation does nothing - } - - /** * This method is called when the beginning of a matching XML element - * is encountered. The default implementation delegates to the deprecated - * method {@link #begin(Attributes) begin} without the - * <code>namespace</code> and <code>name</code> parameters, to retain - * backwards compatibility. + * is encountered. The default implementation is a NO-OP. * * @param namespace the namespace URI of the matching element, or an - * empty string if the parser is not namespace aware or the element has - * no namespace + * empty string if the parser is not namespace aware or the + * element has no namespace * @param name the local name if the parser is namespace aware, or just - * the element name otherwise + * the element name otherwise * @param attributes The attribute list of this element - * @since Digester 1.4 - */ - public void begin(String namespace, String name, Attributes attributes) - throws Exception { - - begin(attributes); - - } - - - /** - * This method is called when the body of a matching XML element - * is encountered. If the element has no body, this method is - * not called at all. * - * @param text The text of the body of this element - * @deprecated Use the {@link #body(String,String,String) body} method - * with <code>namespace</code> and <code>name</code> parameters - * instead. - */ - @Deprecated - public void body(String text) throws Exception { - // The default implementation does nothing + * @throws Exception if an error occurs while processing the event + */ + public void begin(String namespace, String name, Attributes attributes) throws Exception { + // NO-OP by default. } /** * This method is called when the body of a matching XML element is * encountered. If the element has no body, this method is not called at - * all. The default implementation delegates to the deprecated method - * {@link #body(String) body} without the <code>namespace</code> and - * <code>name</code> parameters, to retain backwards compatibility. + * all. The default implementation is a NO-OP. * - * @param namespace the namespace URI of the matching element, or an - * empty string if the parser is not namespace aware or the element has - * no namespace - * @param name the local name if the parser is namespace aware, or just - * the element name otherwise + * @param namespace the namespace URI of the matching element, or an empty + * string if the parser is not namespace aware or the + * element has no namespace + * @param name the local name if the parser is namespace aware, or just the + * element name otherwise * @param text The text of the body of this element - * @since Digester 1.4 - */ - public void body(String namespace, String name, String text) - throws Exception { - - body(text); - - } - - - /** - * This method is called when the end of a matching XML element - * is encountered. * - * @deprecated Use the {@link #end(String,String) end} method with - * <code>namespace</code> and <code>name</code> parameters instead. + * @throws Exception if an error occurs while processing the event */ - @Deprecated - public void end() throws Exception { - // The default implementation does nothing + public void body(String namespace, String name, String text) throws Exception { + // NO-OP by default. } /** * This method is called when the end of a matching XML element - * is encountered. The default implementation delegates to the deprecated - * method {@link #end end} without the - * <code>namespace</code> and <code>name</code> parameters, to retain - * backwards compatibility. + * is encountered. The default implementation is a NO-OP. * - * @param namespace the namespace URI of the matching element, or an - * empty string if the parser is not namespace aware or the element has - * no namespace - * @param name the local name if the parser is namespace aware, or just - * the element name otherwise - * @since Digester 1.4 + * @param namespace the namespace URI of the matching element, or an empty + * string if the parser is not namespace aware or the + * element has no namespace + * @param name the local name if the parser is namespace aware, or just the + * element name otherwise + * + * @throws Exception if an error occurs while processing the event */ - public void end(String namespace, String name) - throws Exception { - - end(); - + public void end(String namespace, String name) throws Exception { + // NO-OP by default. } /** * This method is called after all parsing methods have been * called, to allow Rules to remove temporary data. + * + * @throws Exception if an error occurs while processing the event */ public void finish() throws Exception { - // The default implementation does nothing + // NO-OP by default. } - - } --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org