org.apache.axiom.util.stax.dialect

Class StAXDialectDetector

java.lang.Object

org.apache.axiom.util.stax.dialect.StAXDialectDetector

public class StAXDialectDetector
extends java.lang.Object

Detects StAX dialects and normalizes factories for a given StAX implementation.

Note that this class internally maintains a cache of detected dialects. The overhead caused by invocations of methods in this class is thus small.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.jar.Attributes.Name	BUNDLE_SYMBOLIC_NAME
private static java.util.jar.Attributes.Name	BUNDLE_VENDOR
private static java.util.jar.Attributes.Name	BUNDLE_VERSION
private static java.util.Map	dialectByUrl Map that stores detected dialects by location.
private static java.util.jar.Attributes.Name	IMPLEMENTATION_TITLE
private static java.util.jar.Attributes.Name	IMPLEMENTATION_VENDOR
private static java.util.jar.Attributes.Name	IMPLEMENTATION_VERSION
private static org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Modifier	Constructor and Description
private	StAXDialectDetector()

Method Summary

Modifier and Type	Method and Description
private static StAXDialect	detectDialect(java.lang.ClassLoader classLoader, java.net.URL rootUrl)
private static StAXDialect	detectDialectFromClasses(java.lang.ClassLoader classLoader, java.net.URL rootUrl)
private static StAXDialect	detectDialectFromJarManifest(java.net.URL rootUrl)
static StAXDialect	getDialect(java.lang.Class implementationClass) Detect the dialect of a given StAX implementation.
private static StAXDialect	getDialect(java.lang.ClassLoader classLoader, java.net.URL rootUrl)
private static java.net.URL	getRootUrlForClass(java.lang.Class cls)
private static java.net.URL	getRootUrlForResource(java.lang.ClassLoader classLoader, java.lang.String resource) Get the URL corresponding to the root folder of the classpath entry from which a given resource is loaded.
private static java.lang.Class	loadClass(java.lang.ClassLoader classLoader, java.net.URL rootUrl, java.lang.String name)
static javax.xml.stream.XMLInputFactory	normalize(javax.xml.stream.XMLInputFactory factory) Detect the dialect of a given XMLInputFactory and normalize it.
static javax.xml.stream.XMLOutputFactory	normalize(javax.xml.stream.XMLOutputFactory factory) Detect the dialect of a given XMLOutputFactory and normalize it.

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final org.apache.commons.logging.Log log

IMPLEMENTATION_TITLE

private static final java.util.jar.Attributes.Name IMPLEMENTATION_TITLE

IMPLEMENTATION_VENDOR

private static final java.util.jar.Attributes.Name IMPLEMENTATION_VENDOR

IMPLEMENTATION_VERSION

private static final java.util.jar.Attributes.Name IMPLEMENTATION_VERSION

BUNDLE_SYMBOLIC_NAME

private static final java.util.jar.Attributes.Name BUNDLE_SYMBOLIC_NAME

BUNDLE_VENDOR

private static final java.util.jar.Attributes.Name BUNDLE_VENDOR

BUNDLE_VERSION

private static final java.util.jar.Attributes.Name BUNDLE_VERSION

dialectByUrl

private static final java.util.Map dialectByUrl

Map that stores detected dialects by location. The location is the URL corresponding to the root folder of the classpath entry from which the StAX implementation is loaded. Note that in the case of a JAR file, this is not the URL pointing to the JAR, but a jar: URL that points to the root folder of the archive.

Constructor Detail

StAXDialectDetector

private StAXDialectDetector()

Method Detail

getRootUrlForResource

private static java.net.URL getRootUrlForResource(java.lang.ClassLoader classLoader,
                                                  java.lang.String resource)

Get the URL corresponding to the root folder of the classpath entry from which a given resource is loaded. This URL can be used to load other resources from the same classpath entry (JAR file or directory).

Returns:

the root URL or null if the resource can't be found or if it is not possible to determine the root URL

getRootUrlForClass

private static java.net.URL getRootUrlForClass(java.lang.Class cls)

normalize

public static javax.xml.stream.XMLInputFactory normalize(javax.xml.stream.XMLInputFactory factory)

Detect the dialect of a given XMLInputFactory and normalize it.

Parameters:

factory - the factory to normalize

Returns:

the normalized factory

See Also:

StAXDialect.normalize(XMLInputFactory)

normalize

public static javax.xml.stream.XMLOutputFactory normalize(javax.xml.stream.XMLOutputFactory factory)

Detect the dialect of a given XMLOutputFactory and normalize it.

Parameters:

factory - the factory to normalize

Returns:

the normalized factory

See Also:

StAXDialect.normalize(XMLOutputFactory)

getDialect

public static StAXDialect getDialect(java.lang.Class implementationClass)

Detect the dialect of a given StAX implementation.

Parameters:

implementationClass - any class that is part of the StAX implementation; typically this should be a XMLInputFactory, XMLOutputFactory, XMLStreamReader or XMLStreamWriter implementation

Returns:

the detected dialect

getDialect

private static StAXDialect getDialect(java.lang.ClassLoader classLoader,
                                      java.net.URL rootUrl)

detectDialect

private static StAXDialect detectDialect(java.lang.ClassLoader classLoader,
                                         java.net.URL rootUrl)

detectDialectFromJarManifest

private static StAXDialect detectDialectFromJarManifest(java.net.URL rootUrl)

loadClass

private static java.lang.Class loadClass(java.lang.ClassLoader classLoader,
                                         java.net.URL rootUrl,
                                         java.lang.String name)

detectDialectFromClasses

private static StAXDialect detectDialectFromClasses(java.lang.ClassLoader classLoader,
                                                    java.net.URL rootUrl)