Package org.jboss.metadata.parser.util

Class MetaDataElementParser

java.lang.Object

org.jboss.metadata.parser.util.MetaDataElementParser

All Implemented Interfaces:

javax.xml.stream.XMLStreamConstants

Direct Known Subclasses:

AddressingParser, AdministeredObjectMetaDataParser, ConnectionFactoryMetaDataParser, DataSourceMetaDataParser, DescriptionGroupMetaDataParser, DescriptionMetaDataParser, DisplayNameMetaDataParser, EJBLocalReferenceMetaDataParser, EJBReferenceMetaDataParser, EnvironmentEntryMetaDataParser, IconMetaDataParser, JMSConnectionFactoryMetaDataParser, JMSDestinationMetaDataParser, LifecycleCallbackMetaDataParser, MailSessionMetaDataParser, MessageDestinationMetaDataParser, MessageDestinationReferenceMetaDataParser, ParamValueMetaDataParser, PersistenceContextReferenceMetaDataParser, PersistenceUnitReferenceMetaDataParser, PortComponentRefParser, PropertyMetaDataParser, ResourceEnvironmentReferenceMetaDataParser, ResourceInjectionMetaDataParser, ResourceInjectionTargetMetaDataParser, ResourceReferenceMetaDataParser, RespectBindingParser, RunAsMetaDataParser, SecurityRoleMetaDataParser, SecurityRoleRefMetaDataParser, ServiceReferenceHandlerChainMetaDataParser, ServiceReferenceHandlerChainsMetaDataParser, ServiceReferenceHandlerMetaDataParser, ServiceReferenceMetaDataParser, StubPropertyParser

public class MetaDataElementParser
extends java.lang.Object
implements javax.xml.stream.XMLStreamConstants

Author:

Emanuel Muckenhuber

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetaDataElementParser.DTDInfo

Field Summary

Fields inherited from interface javax.xml.stream.XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT

Constructor Summary

Constructors

Constructor	Description
MetaDataElementParser()

Method Summary

Modifier and Type	Method	Description
protected static boolean	attributeHasNamespace(javax.xml.stream.XMLStreamReader reader, int i)
protected static void	consumeElementContent(javax.xml.stream.XMLStreamReader reader)	Consume the element content of an XML stream reader (e.g.
protected static javax.xml.stream.XMLStreamException	duplicateNamedElement(javax.xml.stream.XMLStreamReader reader, java.lang.String name)	Get an exception reporting that an element of a given type and name has already been declared in this scope.
boolean	equals(java.lang.Object obj)	Determine if this object is the same as the given object.
protected static java.lang.String	getElementText(javax.xml.stream.XMLStreamReader reader)	Read the element text, with trimming.
protected static java.lang.String	getElementText(javax.xml.stream.XMLStreamReader reader, boolean trim)	Read and return the element text.
protected static java.lang.String	getElementText(javax.xml.stream.XMLStreamReader reader, boolean trim, PropertyReplacer propertyReplacer)	Read the element text, with trimming and replace in properties.
protected static java.lang.String	getElementText(javax.xml.stream.XMLStreamReader reader, PropertyReplacer propertyReplacer)	Read the element text, with trimming and replace in properties.
int	hashCode()	Get the identity hash code of this object.
protected static javax.xml.stream.XMLStreamException	missingRequiredAttributes(javax.xml.stream.XMLStreamReader reader, java.util.Set<?> required)	Get an exception reporting a missing, required XML attribute.
protected static javax.xml.stream.XMLStreamException	missingRequiredElement(javax.xml.stream.XMLStreamReader reader, java.util.Set<?> required)	Get an exception reporting a missing, required XML child element.
protected static javax.xml.namespace.QName	parseQName(javax.xml.stream.XMLStreamReader reader, java.lang.String qname)
protected static boolean	readBooleanAttributeElement(javax.xml.stream.XMLStreamReader reader, java.lang.String attributeName)	Read an element which contains only a single boolean attribute.
protected static java.lang.String	readDTDLocation(javax.xml.stream.XMLStreamReader reader)
protected static java.lang.String	readSchemaLocation(javax.xml.stream.XMLStreamReader reader)
protected static java.lang.String	readStringAttributeElement(javax.xml.stream.XMLStreamReader reader, java.lang.String attributeName)	Read an element which contains only a single string attribute.
protected static void	requireNoAttributes(javax.xml.stream.XMLStreamReader reader)	Checks that the current element has no attributes, throwing an XMLStreamException if one is found.
protected static void	requireNoContent(javax.xml.stream.XMLStreamReader reader)	Consumes the remainder of the current element, throwing an XMLStreamException if it contains any child elements.
protected static <K,V> java.util.NavigableMap<K,V>	safeCopyMap(java.util.NavigableMap<K,V> toCopy)	Returns a new TreeMap by passing the provided map to its constructor.
static javax.xml.stream.XMLStreamException	unexpectedAttribute(javax.xml.stream.XMLStreamReader reader, int index)	Get an exception reporting an unexpected XML attribute.
protected static javax.xml.stream.XMLStreamException	unexpectedElement(javax.xml.stream.XMLStreamReader reader)	Get an exception reporting an unexpected XML element.
protected static javax.xml.stream.XMLStreamException	unexpectedValue(javax.xml.stream.XMLStreamReader reader, java.lang.Throwable t)	Get an exception reporting an unexpected XML element or attribute value.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaDataElementParser

public MetaDataElementParser()

Method Detail

unexpectedValue

protected static javax.xml.stream.XMLStreamException unexpectedValue(javax.xml.stream.XMLStreamReader reader,
                                                                     java.lang.Throwable t)

Get an exception reporting an unexpected XML element or attribute value.

Parameters:

reader - the stream reader

Returns:

the exception

unexpectedElement

protected static javax.xml.stream.XMLStreamException unexpectedElement(javax.xml.stream.XMLStreamReader reader)

Get an exception reporting an unexpected XML element.

Parameters:

reader - the stream reader

Returns:

the exception

unexpectedAttribute

public static javax.xml.stream.XMLStreamException unexpectedAttribute(javax.xml.stream.XMLStreamReader reader,
                                                                      int index)

Get an exception reporting an unexpected XML attribute.

Parameters:

reader - the stream reader

index - the element index

Returns:

the exception

missingRequiredAttributes

protected static javax.xml.stream.XMLStreamException missingRequiredAttributes(javax.xml.stream.XMLStreamReader reader,
                                                                               java.util.Set<?> required)

Get an exception reporting a missing, required XML attribute.

Parameters:

reader - the stream reader

required - a set of enums whose toString method returns the attribute name

Returns:

the exception

missingRequiredElement

protected static javax.xml.stream.XMLStreamException missingRequiredElement(javax.xml.stream.XMLStreamReader reader,
                                                                            java.util.Set<?> required)

Get an exception reporting a missing, required XML child element.

Parameters:

reader - the stream reader

required - a set of enums whose toString method returns the attribute name

Returns:

the exception

requireNoAttributes

protected static void requireNoAttributes(javax.xml.stream.XMLStreamReader reader)
                                   throws javax.xml.stream.XMLStreamException

Checks that the current element has no attributes, throwing an XMLStreamException if one is found.

Parameters:

reader - the reader

Throws:

javax.xml.stream.XMLStreamException - if an error occurs

getElementText

protected static java.lang.String getElementText(javax.xml.stream.XMLStreamReader reader)
                                          throws javax.xml.stream.XMLStreamException

Read the element text, with trimming.

Parameters:

reader - the reader

Throws:

javax.xml.stream.XMLStreamException - if an error occurs

getElementText

protected static java.lang.String getElementText(javax.xml.stream.XMLStreamReader reader,
                                                 PropertyReplacer propertyReplacer)
                                          throws javax.xml.stream.XMLStreamException

Read the element text, with trimming and replace in properties.

Parameters:

reader - the reader

propertyReplacer - propertyReplacer

Throws:

javax.xml.stream.XMLStreamException - if an error occurs

getElementText

protected static java.lang.String getElementText(javax.xml.stream.XMLStreamReader reader,
                                                 boolean trim,
                                                 PropertyReplacer propertyReplacer)
                                          throws javax.xml.stream.XMLStreamException

Read the element text, with trimming and replace in properties.

Parameters:

reader - the reader

propertyReplacer - propertyReplacer

trim - True if the text has to be trimmed before returning. False otherwise

Throws:

javax.xml.stream.XMLStreamException - if an error occurs

getElementText

protected static java.lang.String getElementText(javax.xml.stream.XMLStreamReader reader,
                                                 boolean trim)
                                          throws javax.xml.stream.XMLStreamException

Read and return the element text. If the passed trim value is true, then the text is trimmed before returning.

Parameters:

reader -

trim - True if the text has to be trimmed before returning. False otherwise

Returns:

Throws:

javax.xml.stream.XMLStreamException

requireNoContent

protected static void requireNoContent(javax.xml.stream.XMLStreamReader reader)
                                throws javax.xml.stream.XMLStreamException

Consumes the remainder of the current element, throwing an XMLStreamException if it contains any child elements.

Parameters:

reader - the reader

Throws:

javax.xml.stream.XMLStreamException - if an error occurs

duplicateNamedElement

protected static javax.xml.stream.XMLStreamException duplicateNamedElement(javax.xml.stream.XMLStreamReader reader,
                                                                           java.lang.String name)

Get an exception reporting that an element of a given type and name has already been declared in this scope.

Parameters:

reader - the stream reader

name - the name that was redeclared

Returns:

the exception

readBooleanAttributeElement

protected static boolean readBooleanAttributeElement(javax.xml.stream.XMLStreamReader reader,
                                                     java.lang.String attributeName)
                                              throws javax.xml.stream.XMLStreamException

Read an element which contains only a single boolean attribute.

Parameters:

reader - the reader

attributeName - the attribute name, usually "value"

Returns:

the boolean value

Throws:

javax.xml.stream.XMLStreamException - if an error occurs or if the element does not contain the specified attribute, contains other attributes, or contains child elements.

readStringAttributeElement

protected static java.lang.String readStringAttributeElement(javax.xml.stream.XMLStreamReader reader,
                                                             java.lang.String attributeName)
                                                      throws javax.xml.stream.XMLStreamException

Read an element which contains only a single string attribute.

Parameters:

reader - the reader

attributeName - the attribute name, usually "value" or "name"

Returns:

the string value

Throws:

javax.xml.stream.XMLStreamException - if an error occurs or if the element does not contain the specified attribute, contains other attributes, or contains child elements.

readSchemaLocation

protected static java.lang.String readSchemaLocation(javax.xml.stream.XMLStreamReader reader)
                                              throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

readDTDLocation

protected static java.lang.String readDTDLocation(javax.xml.stream.XMLStreamReader reader)
                                           throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

parseQName

protected static javax.xml.namespace.QName parseQName(javax.xml.stream.XMLStreamReader reader,
                                                      java.lang.String qname)

attributeHasNamespace

protected static boolean attributeHasNamespace(javax.xml.stream.XMLStreamReader reader,
                                               int i)

safeCopyMap

protected static <K,V> java.util.NavigableMap<K,V> safeCopyMap(java.util.NavigableMap<K,V> toCopy)

Returns a new TreeMap by passing the provided map to its constructor. Thread safety note: toCopy's monitor is held while the TreeMap is being constructed.

Type Parameters:

K - the type of toCopy's keys

V - the type of toCopy's values

Parameters:

toCopy - the map to copy. Cannot be null

Returns:

the copy

consumeElementContent

protected static void consumeElementContent(javax.xml.stream.XMLStreamReader reader)
                                     throws javax.xml.stream.XMLStreamException

Consume the element content of an XML stream reader (e.g. in the event of a non-fatal parse error).

Parameters:

reader - the XML stream reader

Throws:

javax.xml.stream.XMLStreamException

equals

public final boolean equals(java.lang.Object obj)

Determine if this object is the same as the given object. This is an identity comparison.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the other object

Returns:

true if the objects are the same

hashCode

public final int hashCode()

Get the identity hash code of this object.

Overrides:

hashCode in class java.lang.Object

Returns:

the identity hash code