Java Doc for CallParamRule.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

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL 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 Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.apache.commons.digester .Rule

org.apache.commons.digester .CallParamRule

CallParamRule
public class CallParamRule extends Rule (Code)
	Rule implementation that saves a parameter for use by a surrounding `CallMethodRule.` `This parameter may be: from an attribute of the current element See CallParamRule.CallParamRule(int paramIndex,String attributeName) from current the element body See CallParamRule.CallParamRule(int paramIndex) from the top object on the stack. See CallParamRule.CallParamRule(int paramIndex,boolean fromStack) the current path being processed (separate Rule). See PathCallParamRule`

Field Summary
protected String	attributeName
protected ArrayStack	bodyTextStack Stack is used to allow nested body text to be processed.
protected boolean	fromStack
protected int	paramIndex The zero-relative index of the parameter we are saving.
protected int	stackIndex

Constructor Summary
public	CallParamRule(Digester digester, int paramIndex) Construct a "call parameter" rule that will save the body text of this element as the parameter value. Note that if the element is empty the an empty string is passed to the target method, not null.
public	CallParamRule(Digester digester, int paramIndex, String attributeName) Construct a "call parameter" rule that will save the value of the specified attribute as the parameter value.
public	CallParamRule(int paramIndex) Construct a "call parameter" rule that will save the body text of this element as the parameter value. Note that if the element is empty the an empty string is passed to the target method, not null.
public	CallParamRule(int paramIndex, String attributeName) Construct a "call parameter" rule that will save the value of the specified attribute as the parameter value.
public	CallParamRule(int paramIndex, boolean fromStack) Construct a "call parameter" rule.
public	CallParamRule(int paramIndex, int stackIndex) Constructs a "call parameter" rule which sets a parameter from the stack. If the stack contains too few objects, then the parameter will be set to null. Parameters: paramIndex - The zero-relative parameter number Parameters: stackIndex - the index of the object which will be passed as a parameter.

Method Summary
public void	begin(Attributes attributes) Process the start of this element.
public void	body(String bodyText) Process the body text of this element.
public void	end(String namespace, String name) Process any body texts now.
public String	toString() Render a printable version of this Rule.

Field Detail

attributeName
protected String attributeName(Code)
	The attribute from which to save the parameter value

bodyTextStack
protected ArrayStack bodyTextStack(Code)
	Stack is used to allow nested body text to be processed. Lazy creation.

fromStack
protected boolean fromStack(Code)
	Is the parameter to be set from the stack?

paramIndex
protected int paramIndex(Code)
	The zero-relative index of the parameter we are saving.

stackIndex
protected int stackIndex(Code)
	The position of the object from the top of the stack

Constructor Detail

CallParamRule
public CallParamRule(Digester digester, int paramIndex)(Code)
	Construct a "call parameter" rule that will save the body text of this element as the parameter value. Note that if the element is empty the an empty string is passed to the target method, not null. And if automatic type conversion is being applied (ie if the target function takes something other than a string as a parameter) then the conversion will fail if the converter class does not accept an empty string as valid input. Parameters: digester - The associated Digester Parameters: paramIndex - The zero-relative parameter numberDigester.addRule CallParamRule.CallParamRule(int paramIndex)

CallParamRule
public CallParamRule(Digester digester, int paramIndex, String attributeName)(Code)
	Construct a "call parameter" rule that will save the value of the specified attribute as the parameter value. Parameters: digester - The associated Digester Parameters: paramIndex - The zero-relative parameter number Parameters: attributeName - The name of the attribute to saveDigester.addRule CallParamRule.CallParamRule(int paramIndex,String attributeName)

CallParamRule
public CallParamRule(int paramIndex)(Code)
	Construct a "call parameter" rule that will save the body text of this element as the parameter value. Note that if the element is empty the an empty string is passed to the target method, not null. And if automatic type conversion is being applied (ie if the target function takes something other than a string as a parameter) then the conversion will fail if the converter class does not accept an empty string as valid input. Parameters: paramIndex - The zero-relative parameter number

CallParamRule
public CallParamRule(int paramIndex, String attributeName)(Code)
	Construct a "call parameter" rule that will save the value of the specified attribute as the parameter value. Parameters: paramIndex - The zero-relative parameter number Parameters: attributeName - The name of the attribute to save

CallParamRule
public CallParamRule(int paramIndex, boolean fromStack)(Code)
	Construct a "call parameter" rule. Parameters: paramIndex - The zero-relative parameter number Parameters: fromStack - should this parameter be taken from the top of the stack?

CallParamRule
public CallParamRule(int paramIndex, int stackIndex)(Code)
	Constructs a "call parameter" rule which sets a parameter from the stack. If the stack contains too few objects, then the parameter will be set to null. Parameters: paramIndex - The zero-relative parameter number Parameters: stackIndex - the index of the object which will be passed as a parameter. The zeroth object is the top of the stack, 1 is the next object down and so on.

Method Detail

begin
public void begin(Attributes attributes) throws Exception(Code)
	Process the start of this element. Parameters: attributes - The attribute list for this element

body
public void body(String bodyText) throws Exception(Code)
	Process the body text of this element. Parameters: bodyText - The body text of this element

end
public void end(String namespace, String name)(Code)
	Process any body texts now.

toString
public String toString()(Code)
	Render a printable version of this Rule.

Fields inherited from org.apache.commons.digester.Rule

protected Digester digester(Code)(Java Doc)
protected String namespaceURI(Code)(Java Doc)

Methods inherited from org.apache.commons.digester.Rule

public void begin(Attributes attributes) throws Exception(Code)(Java Doc)
public void begin(String namespace, String name, Attributes attributes) throws Exception(Code)(Java Doc)
public void body(String text) throws Exception(Code)(Java Doc)
public void body(String namespace, String name, String text) throws Exception(Code)(Java Doc)
public void end() throws Exception(Code)(Java Doc)
public void end(String namespace, String name) throws Exception(Code)(Java Doc)
public void finish() throws Exception(Code)(Java Doc)
public Digester getDigester()(Code)(Java Doc)
public String getNamespaceURI()(Code)(Java Doc)
public void setDigester(Digester digester)(Code)(Java Doc)
public void setNamespaceURI(String namespaceURI)(Code)(Java Doc)

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.