Source Code Cross Referenced for Substitutor.java in  » Library » Apache-commons-digester-1.8-src » org » apache » commons » digester » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Library » Apache commons digester 1.8 src » org.apache.commons.digester 
Source Cross Referenced  Class Diagram Java Document (Java Doc) 


01:        /* $Id: Substitutor.java 471661 2006-11-06 08:09:25Z skitching $
02:         *
03:         * Licensed to the Apache Software Foundation (ASF) under one or more
04:         * contributor license agreements.  See the NOTICE file distributed with
05:         * this work for additional information regarding copyright ownership.
06:         * The ASF licenses this file to You under the Apache License, Version 2.0
07:         * (the "License"); you may not use this file except in compliance with
08:         * the License.  You may obtain a copy of the License at
09:         * 
10:         *      http://www.apache.org/licenses/LICENSE-2.0
11:         * 
12:         * Unless required by applicable law or agreed to in writing, software
13:         * distributed under the License is distributed on an "AS IS" BASIS,
14:         * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15:         * See the License for the specific language governing permissions and
16:         * limitations under the License.
17:         */
18:
19:        package org.apache.commons.digester;
20:
21:        import org.xml.sax.Attributes;
22:
23:        /**
24:         * <p>(Logical) Interface for substitution strategies.
25:         * (It happens to be implemented as a Java abstract class to allow
26:         * future additions to be made without breaking backwards compatibility.)
27:         * </p>
28:         * <p>
29:         * Usage: When {@link Digester#setSubstitutor} is set, <code>Digester</code>
30:         * calls the methods in this interface to create substitute values which will
31:         * be passed into the Rule implementations.
32:         * Of course, it is perfectly acceptable for implementations not to make 
33:         * substitutions and simply return the inputs.
34:         * </p>
35:         * <p>Different strategies are supported for attributes and body text.</p>
36:         *
37:         * @since 1.6 
38:         */
39:        public abstract class Substitutor {
40:
41:            /**
42:             * <p>Substitutes the attributes (before they are passed to the 
43:             * <code>Rule</code> implementations's).</p>
44:             *
45:             * <p><code>Digester</code> will only call this method a second time 
46:             * once the original <code>Attributes</code> instance can be safely reused. 
47:             * The implementation is therefore free to reuse the same <code>Attributes</code> instance
48:             * for all calls.</p>
49:             *
50:             * @param attributes the <code>Attributes</code> passed into <code>Digester</code> by the SAX parser, 
51:             * not null (but may be empty)
52:             * @return <code>Attributes</code> to be passed to the <code>Rule</code> implementations. 
53:             * This method may pass back the Attributes passed in.
54:             * Not null but possibly empty.
55:             */
56:            public abstract Attributes substitute(Attributes attributes);
57:
58:            /**
59:             * Substitutes for the body text.
60:             * This method may substitute values into the body text of the
61:             * elements that Digester parses.
62:             *
63:             * @param bodyText the body text (as passed to <code>Digester</code>)
64:             * @return the body text to be passed to the <code>Rule</code> implementations
65:             */
66:            public abstract String substitute(String bodyText);
67:        }
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.