org.apache.ws.jaxme.xs

Interface XSParticle

Known Implementing Classes:
XSParticleImpl

public interface XSParticle

Interface of a model groups particle.
Author:
Jochen Wiedmann

Nested Class Summary

class
XSParticle.Type

Field Summary

static XSParticle.Type
ELEMENT
The particle type "element".
static XSParticle.Type
GROUP
The particle type "group".
static XSParticle.Type
WILDCARD
The particle type "wildcard".

Method Summary

XSElement
getElement()
If the particle type is element: Returns the element.
XSGroup
getGroup()
If the particle type is group: Returns the group.
Locator
getLocator()
Returns the particles Locator.
int
getMaxOccurs()
Returns the particles maxOccurs value or -1 for unbounded.
int
getMinOccurs()
Returns the particles minOccurs value.
XSParticle.Type
getType()
Returns the particle type.
XSAny
getWildcard()
If the particle type is wildcard: Returns the wildcard.
boolean
isElement()
Shortcut for getType().equals(ELEMENT).
boolean
isGroup()
Shortcut for getType().equals(GROUP).
boolean
isWildcard()
Shortcut for getType().equals(WILDCARD).

Field Details

ELEMENT

public static final XSParticle.Type ELEMENT
The particle type "element".

GROUP

public static final XSParticle.Type GROUP
The particle type "group".

WILDCARD

public static final XSParticle.Type WILDCARD
The particle type "wildcard".

Method Details

getElement

public XSElement getElement()
If the particle type is element: Returns the element.

getGroup

public XSGroup getGroup()
If the particle type is group: Returns the group.

getLocator

public Locator getLocator()
Returns the particles Locator.

getMaxOccurs

public int getMaxOccurs()
Returns the particles maxOccurs value or -1 for unbounded.

getMinOccurs

public int getMinOccurs()
Returns the particles minOccurs value.

getType

public XSParticle.Type getType()
Returns the particle type.

getWildcard

public XSAny getWildcard()
If the particle type is wildcard: Returns the wildcard.

isElement

public boolean isElement()
Shortcut for getType().equals(ELEMENT).

isGroup

public boolean isGroup()
Shortcut for getType().equals(GROUP).

isWildcard

public boolean isWildcard()
Shortcut for getType().equals(WILDCARD).