Package org.apache.rat.configuration

Class XMLConfig

java.lang.Object

org.apache.rat.configuration.XMLConfig

public final class XMLConfig
extends Object

Configuration definitions for XMLConfiguration reader and writer.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPROVED	approved element name
static final String	ATT_CLASS_NAME	class name attribute name
static final String	ATT_ID	id attribute name
static final String	ATT_LICENSE_REF	license reference attribute name
static final String	ATT_NAME	name attribute name
static final String	ATT_RESOURCE	resource file name attribute name.
static final String	FAMILIES	families element name
static final String	FAMILY	family element name
static final String	LICENSE	license element name
static final String	LICENSES	licenses element name
static final String	MATCHER	matcher element name
static final String	MATCHERS	matchers element name
static final String	NOTE	note element name
static final String	ROOT	root of the configuration file

Method Summary

Modifier and Type	Method	Description
static boolean	isInlineNode(String parent, String child)	Returns true if the specified child node should be placed inline in the XML document.
static boolean	isLicenseChild(String child)	Returns true if the child should be a child node of a license node, as opposed to an attribute of the license.
static boolean	isLicenseInline(String child)	Return true if the child should be inlined in the parent node.

Methods inherited from class java.lang.Object

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

Field Details

ATT_ID

public static final String ATT_ID

id attribute name

See Also:

• Constant Field Values

ATT_NAME

public static final String ATT_NAME

name attribute name

See Also:

• Constant Field Values

ATT_LICENSE_REF

public static final String ATT_LICENSE_REF

license reference attribute name

See Also:

• Constant Field Values

ATT_CLASS_NAME

public static final String ATT_CLASS_NAME

class name attribute name

See Also:

• Constant Field Values

ATT_RESOURCE

public static final String ATT_RESOURCE

resource file name attribute name.

See Also:

• Constant Field Values

ROOT

public static final String ROOT

root of the configuration file

See Also:

• Constant Field Values

FAMILIES

public static final String FAMILIES

families element name

See Also:

• Constant Field Values

LICENSES

public static final String LICENSES

licenses element name

See Also:

• Constant Field Values

LICENSE

public static final String LICENSE

license element name

See Also:

• Constant Field Values

APPROVED

public static final String APPROVED

approved element name

See Also:

• Constant Field Values

FAMILY

public static final String FAMILY

family element name

See Also:

• Constant Field Values

NOTE

public static final String NOTE

note element name

See Also:

• Constant Field Values

MATCHERS

public static final String MATCHERS

matchers element name

See Also:

• Constant Field Values

MATCHER

public static final String MATCHER

matcher element name

See Also:

• Constant Field Values

Method Details

isInlineNode

public static boolean isInlineNode(String parent,
 String child)

Returns true if the specified child node should be placed inline in the XML document.

Parameters:

parent - the parent node name.

child - the child node name.

Returns:

true if the child should be inlined.

isLicenseChild

public static boolean isLicenseChild(String child)

Returns true if the child should be a child node of a license node, as opposed to an attribute of the license.

Parameters:

child - the name of the child node.

Returns:

true if the child should be a child node.

isLicenseInline

public static boolean isLicenseInline(String child)

Return true if the child should be inlined in the parent node.

Parameters:

child - the name of the child node.

Returns:

true if the child should be inlined.