com.izforge.izpack.util.helper

Class SpecHelper

java.lang.Object

com.izforge.izpack.util.helper.SpecHelper

public class SpecHelper
extends Object

This class contains some helper methods to simplify handling of xml specification files.

Author:

Klaus Bartz

Field Summary

Fields

Modifier and Type	Field and Description
static String	NO
static String	PACK_KEY
static String	PACK_NAME
static String	YES

Constructor Summary

Constructors

Constructor and Description
SpecHelper(Resources resources) Constructs a SpecHelper.

Method Summary

Modifier and Type	Method and Description
List<IXMLElement>	getAllSubChildren(IXMLElement root, String[] childdef) Returns a Vector with all leafs of the tree which is described with childdef.
String	getOptionalAttribute(IXMLElement element, String attrName)
IXMLElement	getPackForName(String packDestName) Returns a XML element which represents the pack for the given name.
String	getRequiredAttribute(IXMLElement element, String attrName) Returns the attribute for the given attribute name.
InputStream	getResource(String res) Gets the stream to a resource.
IXMLElement	getSpec() Returns the specification.
boolean	haveSpec() Returns true if a specification exist, else false.
boolean	isAttributeYes(IXMLElement element, String attribute, boolean defaultValue) Returns whether the value to the given attribute is "yes" or not.
void	parseError(IXMLElement parent, String message) Create parse error with consistent messages.
void	readSpec(InputStream input) Reads the XML specification given by the input stream.
void	readSpec(String specFileName) Reads the XML specification given by the file name.
void	setSpec(IXMLElement element) Sets the specifaction to the given XML element.

Methods inherited from class java.lang.Object

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

Field Detail

YES

public static final String YES

See Also:

Constant Field Values

NO

public static final String NO

See Also:

Constant Field Values

PACK_KEY

public static final String PACK_KEY

See Also:

Constant Field Values

PACK_NAME

public static final String PACK_NAME

See Also:

Constant Field Values

Constructor Detail

SpecHelper

public SpecHelper(Resources resources)

Constructs a SpecHelper.

Parameters:

resources - the resources

Method Detail

readSpec

public void readSpec(String specFileName)
              throws Exception

Reads the XML specification given by the file name. The result is stored in spec.

Throws:

Exception - for any problems in reading the specification

readSpec

public void readSpec(InputStream input)
              throws Exception

Reads the XML specification given by the input stream. The result is stored in spec.

Throws:

Exception - for any problems in reading the specification

getResource

public InputStream getResource(String res)

Gets the stream to a resource.

Parameters:

res - The resource id.

Returns:

The resource value, null if not found

getPackForName

public IXMLElement getPackForName(String packDestName)

Returns a XML element which represents the pack for the given name.

Parameters:

packDestName - name of the pack which should be returned

Returns:

a XML element which represents the pack for the given name

parseError

public void parseError(IXMLElement parent,
                       String message)
                throws InstallerException

Create parse error with consistent messages. Includes file name and line # of parent. It is an error for 'parent' to be null.

Parameters:

parent - The element in which the error occured

message - Brief message explaining error

Throws:

InstallerException

haveSpec

public boolean haveSpec()

Returns true if a specification exist, else false.

Returns:

true if a specification exist, else false

getSpec

public IXMLElement getSpec()

Returns the specification.

Returns:

the specification

setSpec

public void setSpec(IXMLElement element)

Sets the specifaction to the given XML element.

Parameters:

element -

getAllSubChildren

public List<IXMLElement> getAllSubChildren(IXMLElement root,
                                           String[] childdef)

Returns a Vector with all leafs of the tree which is described with childdef.

Parameters:

root - the IXMLElement which is the current root for the search

childdef - a String array which describes the tree; the last element contains the leaf name

Returns:

a Vector of XMLElements of all leafs founded under root

isAttributeYes

public boolean isAttributeYes(IXMLElement element,
                              String attribute,
                              boolean defaultValue)

Returns whether the value to the given attribute is "yes" or not. If the attribute does not exist, or the value is not "yes" and not "no", the default value is returned.

Parameters:

element - the XML element which contains the attribute

attribute - the name of the attribute

defaultValue - the default value

Returns:

whether the value to the given attribute is "yes" or not

getRequiredAttribute

public String getRequiredAttribute(IXMLElement element,
                                   String attrName)
                            throws InstallerException

Returns the attribute for the given attribute name. If no attribute exist, an InstallerException with a detail message is thrown.

Parameters:

element - XML element which should contain the attribute

attrName - key of the attribute

Returns:

the attribute as string

Throws:

InstallerException

getOptionalAttribute

public String getOptionalAttribute(IXMLElement element,
                                   String attrName)