Class XmlParser

java.lang.Object

org.kohsuke.args4j.XmlParser

public class XmlParser
extends Object

Parses an XML-file specifying the 'annotations'. The XML must have the structure:

<args>
    <option field="" method="" name="" usage="" metavar="" handler=""/>
    <argument field="" method="" usage="" metavar="" handler=""/>
</args>

Exactly one of the attributes 'field' or 'method' must be set. The 'handler' value specifies a full qualified class name.

Example

<args>
    <option field="recursive" name="-r" usage="recursively run something"/>
    <option field="out" name="-o" usage="output to this file" metavar="OUTPUT"/>
    <option method="setStr(String)" name="-str"/>
    <option field="data" name="-custom" handler="org.kohsuke.args4j.spi.BooleanOptionHandler" usage="boolean value for checking the custom handler"/>
    <argument field="arguments"/>
<args>

Constructor Summary

Constructors

Constructor	Description
XmlParser()

Method Summary

Modifier and Type	Method	Description
private AccessibleObject	findMethodOrField(Object bean, String field, String method)	Finds a Method or Method in the bean instance with the requested name.
void	parse(URL xml, CmdLineParser parser, Object bean)
void	parse(InputSource xml, CmdLineParser parser, Object bean)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

XmlParser

public XmlParser()

Method Details

parse

public void parse(URL xml,
 CmdLineParser parser,
 Object bean)

parse

public void parse(InputSource xml,
 CmdLineParser parser,
 Object bean)

findMethodOrField

private AccessibleObject findMethodOrField(Object bean,
 String field,
 String method)
                                    throws SecurityException,
NoSuchFieldException,
NoSuchMethodException,
ClassNotFoundException

Finds a Method or Method in the bean instance with the requested name.

Parameters:

bean - bean instance

field - name of the field (field XOR method must be specified)

method - name of the method (field XOR method must be specified)

Returns:

the reflection reference

Throws:

SecurityException

NoSuchFieldException

NoSuchMethodException

ClassNotFoundException