Package org.jboss.as.controller.persistence.xml

Interface ResourceXMLParticleFactory

All Superinterfaces:

FeatureFilter, FeatureRegistry, QNameResolver

All Known Implementing Classes:

ResourceXMLParticleFactory.DefaultSubsystemXMLParticleFactory

public interface ResourceXMLParticleFactory
extends FeatureRegistry, QNameResolver

A factory for building XML particles for a subsystem resource. All particles created by this factory will have a default cardinality of XMLCardinality.Single.REQUIRED.

Author:

Paul Ferraro

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ResourceXMLParticleFactory.DefaultSubsystemXMLParticleFactory

Field Summary

Fields inherited from interface org.jboss.as.controller.xml.QNameResolver

COMPARATOR

Method Summary

Modifier and Type	Method	Description
ResourceXMLAll.Builder	all()	Returns a builder of an xs:all group.
ResourceXMLChoice.Builder	choice()	Returns a builder of an xs:choice group.
default ResourceXMLElement.Builder	element(QName name)	Returns a builder of an XML element using the specified name.
ResourceXMLElement.Builder	element(QName name, Stability stability)	Returns a builder of an XML element using the specified name.
NamedResourceRegistrationXMLElement.Builder	namedElement(ResourceRegistration registration)	Returns a builder of an XML element for the named resource with the specified registration.
NamedResourceRegistrationXMLChoice.Builder	namedElementChoice(NamedResourceRegistrationXMLElement wildcardElement)	Returns a builder of an XML choice of one or more NamedResourceRegistrationXMLElement, including the specified wildcard NamedResourceRegistrationXMLElement.
static ResourceXMLParticleFactory	newInstance(FeatureRegistry registry, QNameResolver resolver)	Creates a new particle factory for the specified feature registry and qualified name resolver.
static <S extends SubsystemSchema<S>> ResourceXMLParticleFactory	newInstance(S schema)	Creates a new particle factory for the specified subsystem schema.
ResourceXMLSequence.Builder	sequence()	Returns a builder of an xs:sequence group.
SingletonResourceRegistrationXMLElement.Builder	singletonElement(ResourceRegistration registration)	Returns a builder of an XML element for the singleton resource with the specified registration.
SingletonResourceRegistrationXMLChoice.Builder	singletonElementChoice()	Returns a builder of an XML choice of one or more SingletonResourceRegistrationXMLElement.
SubsystemResourceRegistrationXMLElement.Builder	subsystemElement(ResourceRegistration registration)	Returns a builder of an XML element for the subsystem resource with the specified registration.

Methods inherited from interface org.jboss.as.controller.FeatureRegistry

enables, getStability

Methods inherited from interface org.jboss.as.controller.xml.QNameResolver

resolve

Method Detail

newInstance

static <S extends SubsystemSchema<S>> ResourceXMLParticleFactory newInstance(S schema)

Creates a new particle factory for the specified subsystem schema.

Type Parameters:

S - the subsystem schema type

Parameters:

schema - a subsystem schema

Returns:

a particle factory

newInstance

static ResourceXMLParticleFactory newInstance(FeatureRegistry registry,
                                              QNameResolver resolver)

Creates a new particle factory for the specified feature registry and qualified name resolver.

Parameters:

registry - a feature registry

resolver - a qualified name resolver

Returns:

a particle factory

subsystemElement

SubsystemResourceRegistrationXMLElement.Builder subsystemElement(ResourceRegistration registration)

Returns a builder of an XML element for the subsystem resource with the specified registration. Default element local name is ResourceXMLElementLocalName.KEY.

Parameters:

registration - a subsystem resource registration

Returns:

a builder of an XML element for the subsystem resource with the specified registration.

namedElement

NamedResourceRegistrationXMLElement.Builder namedElement(ResourceRegistration registration)

Returns a builder of an XML element for the named resource with the specified registration. Default element local name is ResourceXMLElementLocalName.KEY.

Parameters:

registration - a subsystem resource registration

Returns:

a builder of an XML element for the resource with the specified registration.

namedElementChoice

NamedResourceRegistrationXMLChoice.Builder namedElementChoice(NamedResourceRegistrationXMLElement wildcardElement)

Returns a builder of an XML choice of one or more NamedResourceRegistrationXMLElement, including the specified wildcard NamedResourceRegistrationXMLElement. Elements added to this choice must be override registrations of the specified wildcard NamedResourceRegistrationXMLElement.

Parameters:

element - the XML element for a wildcard resource registration.

Returns:

a builder of an XML choice of one or more NamedResourceRegistrationXMLElement.

Throws:

IllegalArgumentException - if the specified NamedResourceRegistrationXMLElement is not associated with a wildcard resource.

singletonElement

SingletonResourceRegistrationXMLElement.Builder singletonElement(ResourceRegistration registration)

Returns a builder of an XML element for the singleton resource with the specified registration. Default element local name is ResourceXMLElementLocalName.VALUE.

Parameters:

registration - a subsystem resource registration

Returns:

a builder of an XML element for the resource with the specified registration.

singletonElementChoice

SingletonResourceRegistrationXMLChoice.Builder singletonElementChoice()

Returns a builder of an XML choice of one or more SingletonResourceRegistrationXMLElement. A SingletonResourceRegistrationXMLChoice may designate a ResourceRegistration to be assumed when no choice is present.

Returns:

a builder of an XML choice of one or more SingletonResourceRegistrationXMLElement

element

default ResourceXMLElement.Builder element(QName name)

Returns a builder of an XML element using the specified name.

Parameters:

name - a qualified element name

Returns:

a builder of an XML element

element

ResourceXMLElement.Builder element(QName name,
                                   Stability stability)

Returns a builder of an XML element using the specified name. Default cardinality is XMLCardinality.Single.REQUIRED.

Parameters:

name - a qualified element name

stability - the stability of this element

Returns:

a builder of an XML element

all

ResourceXMLAll.Builder all()

Returns a builder of an xs:all group. Default cardinality is XMLCardinality.Single.REQUIRED.

Returns:

a builder of an xs:all group

sequence

ResourceXMLSequence.Builder sequence()

Returns a builder of an xs:sequence group. Default cardinality is XMLCardinality.Single.REQUIRED.

Returns:

a builder of an xs:sequence group

choice

ResourceXMLChoice.Builder choice()

Returns a builder of an xs:choice group. Default cardinality is XMLCardinality.Single.REQUIRED.

Returns:

a builder of an xs:choice group