|
Commons Digester example source code file (Rule.java)
The Commons Digester Rule.java source code/* $Id: Rule.java 992060 2010-09-02 19:09:47Z simonetripodi $ * * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright ownership. * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.apache.commons.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. * <p> * Writing a custom Rule is considered perfectly normal when using Digester, * and is encouraged whenever the default set of Rule classes don't meet your * requirements; the digester framework can help process xml even when the * built-in rules aren't quite what is needed. Creating a custom Rule is * just as easy as subclassing javax.servlet.http.HttpServlet for webapps, * or javax.swing.Action for GUI applications. * <p> * If a rule wishes to manipulate a digester stack (the default object stack, * a named stack, or the parameter stack) then it should only ever push * objects in the rule's begin method and always pop exactly the same * number of objects off the stack during the rule's end method. Of course * peeking at the objects on the stacks can be done from anywhere. * <p> * Rule objects should be stateless, ie they should not update any instance * member during the parsing process. A rule instance that changes state * will encounter problems if invoked in a "nested" manner; this can happen * if the same instance is added to digester multiple times or if a * wildcard pattern is used which can match both an element and a child of the * same element. The digester object stack and named stacks should be used to * store any state that a rule requires, making the rule class safe under all * possible uses. */ public abstract class Rule { // ----------------------------------------------------------- Constructors /** * Constructor sets the associated Digester. * * @param digester The digester with which this rule is associated * @deprecated The digester instance is now set in the {@link Digester#addRule} method. Use {@link #Rule()} instead. */ @Deprecated public Rule(Digester digester) { super(); setDigester(digester); } /** * <p>Base constructor. * Now the digester will be set when the rule is added.</p> */ public Rule() {} // ----------------------------------------------------- Instance Variables /** * The Digester with which this Rule is associated. */ protected Digester digester = null; /** * The namespace URI for which this Rule is relevant, if any. */ protected String namespaceURI = null; // ------------------------------------------------------------- Properties /** * Return the Digester with which this Rule is associated. */ public Digester getDigester() { return (this.digester); } /** * Set the <code>Digester with which this Other Commons Digester examples (source code examples)Here is a short list of links related to this Commons Digester Rule.java source code file: |
... this post is sponsored by my books ... | |
#1 New Release! |
FP Best Seller |
Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.
A percentage of advertising revenue from
pages under the /java/jwarehouse
URI on this website is
paid back to open source projects.