Package org.eclipse.jetty.webapp

Class WebDescriptor

java.lang.Object

org.eclipse.jetty.webapp.Descriptor

org.eclipse.jetty.webapp.WebDescriptor

Direct Known Subclasses:

DefaultsDescriptor, FragmentDescriptor, OverrideDescriptor

public class WebDescriptor
extends Descriptor

Descriptor A web descriptor (web.xml/web-defaults.xml/web-overrides.xml).

Field Summary

Fields

Modifier and Type	Field	Description
static XmlParser	__nonValidatingStaticParser
protected ArrayList<String>	_classNames
protected boolean	_distributable
protected boolean	_isOrdered
protected int	_majorVersion
protected MetaData.Complete	_metaDataComplete
protected int	_minorVersion
protected List<String>	_ordering

Fields inherited from class org.eclipse.jetty.webapp.Descriptor

_dtd, _root, _xml

Constructor Summary

Constructors

Constructor	Description
WebDescriptor(Resource xml)

Method Summary

Modifier and Type	Method	Description
void	addClassName(String className)
ArrayList<String>	getClassNames()
int	getMajorVersion()
MetaData.Complete	getMetaDataComplete()
int	getMinorVersion()
List<String>	getOrdering()
static XmlParser	getParser(boolean validating)	Get a parser for parsing web descriptor content.
boolean	isDistributable()
static boolean	isMetaDataComplete(WebDescriptor d)	Check if the descriptor is metadata-complete.
boolean	isOrdered()
static XmlParser	newParser(boolean validating)	Create a new parser for parsing web descriptors.
void	parse(XmlParser parser)
void	processDistributable()
void	processOrdering()
void	processVersion()

Methods inherited from class org.eclipse.jetty.webapp.Descriptor

getResource, getRoot, isParsed, toString

Methods inherited from class java.lang.Object

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

Field Details

__nonValidatingStaticParser

public static XmlParser __nonValidatingStaticParser

_metaDataComplete

protected MetaData.Complete _metaDataComplete

_majorVersion

protected int _majorVersion

_minorVersion

protected int _minorVersion

_classNames

protected ArrayList<String> _classNames

_distributable

protected boolean _distributable

_isOrdered

protected boolean _isOrdered

_ordering

protected List<String> _ordering

Constructor Details

WebDescriptor

public WebDescriptor(Resource xml)

Method Details

isMetaDataComplete

public static boolean isMetaDataComplete(WebDescriptor d)

Check if the descriptor is metadata-complete.

Parameters:

d - the descriptor (web.xml, web-fragment.xml, web-default.xml, web-override.xml) to check

Returns:

true iff metadata-complete=true is declared in the descriptor

getParser

public static XmlParser getParser(boolean validating)

Get a parser for parsing web descriptor content.

Parameters:

validating - true if the parser should validate syntax, false otherwise

Returns:

an XmlParser for web descriptors

newParser

public static XmlParser newParser(boolean validating)

Create a new parser for parsing web descriptors.

Parameters:

validating - if true, the parser will validate syntax

Returns:

an XmlParser

parse

public void parse(XmlParser parser)
           throws Exception

Overrides:

parse in class Descriptor

Throws:

Exception

getMetaDataComplete

public MetaData.Complete getMetaDataComplete()

getMajorVersion

public int getMajorVersion()

getMinorVersion

public int getMinorVersion()

processVersion

public void processVersion()

processOrdering

public void processOrdering()

processDistributable

public void processDistributable()

addClassName

public void addClassName(String className)

getClassNames

public ArrayList<String> getClassNames()

isDistributable

public boolean isDistributable()

isOrdered

public boolean isOrdered()

getOrdering

public List<String> getOrdering()