org.kohsuke.rngom.nc

Class NameClass

java.lang.Object

org.kohsuke.rngom.nc.NameClass

All Implemented Interfaces:

java.io.Serializable, ParsedNameClass

Direct Known Subclasses:

AnyNameClass, AnyNameExceptNameClass, ChoiceNameClass, NsNameClass, NsNameExceptNameClass, NullNameClass, SimpleNameClass

public abstract class NameClass
extends java.lang.Object
implements ParsedNameClass, java.io.Serializable

Name class is a set of QNames.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static NameClass	ANY Sigleton instance that represents "anyName".
static NameClass	NULL Sigleton instance that accepts no name.
(package private) static int	SPECIFICITY_ANY_NAME
(package private) static int	SPECIFICITY_NAME
(package private) static int	SPECIFICITY_NONE
(package private) static int	SPECIFICITY_NS_NAME

Constructor Summary

Constructors

Constructor and Description
NameClass()

Method Summary

Modifier and Type	Method and Description
abstract <V> V	accept(NameClassVisitor<V> visitor) Visitor pattern support.
abstract boolean	contains(javax.xml.namespace.QName name) Returns true if the given QName is a valid name for this QName.
abstract int	containsSpecificity(javax.xml.namespace.QName name)
boolean	hasOverlapWith(NameClass nc2) Returns true if the intersection between this name class and the specified name class is non-empty.
abstract boolean	isOpen() Returns true if the name class accepts infinite number of QNames.
java.util.Set<javax.xml.namespace.QName>	listNames() If the name class is closed (IOW !isOpen()), return the set of names in this name class.

Methods inherited from class java.lang.Object

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

Field Detail

SPECIFICITY_NONE

static final int SPECIFICITY_NONE

See Also:

Constant Field Values

SPECIFICITY_ANY_NAME

static final int SPECIFICITY_ANY_NAME

See Also:

Constant Field Values

SPECIFICITY_NS_NAME

static final int SPECIFICITY_NS_NAME

See Also:

Constant Field Values

SPECIFICITY_NAME

static final int SPECIFICITY_NAME

See Also:

Constant Field Values

ANY

public static final NameClass ANY

Sigleton instance that represents "anyName".

NULL

public static final NameClass NULL

Sigleton instance that accepts no name.

This instance is useful when doing boolean arithmetic over name classes (such as computing an inverse of a given name class, etc), even though it can never appear in a RELAX NG surface syntax.

Internally, this instance is also used for:

1. Used to recover from errors during parsing.
2. Mark element patterns with <notAllowed/> content model.

Constructor Detail

NameClass

public NameClass()

Method Detail

contains

public abstract boolean contains(javax.xml.namespace.QName name)

Returns true if the given QName is a valid name for this QName.

containsSpecificity

public abstract int containsSpecificity(javax.xml.namespace.QName name)

accept

public abstract <V> V accept(NameClassVisitor<V> visitor)

Visitor pattern support.

isOpen

public abstract boolean isOpen()

Returns true if the name class accepts infinite number of QNames.

Intuitively, this method returns true if the name class is some sort of wildcard.

listNames

public java.util.Set<javax.xml.namespace.QName> listNames()

If the name class is closed (IOW !isOpen()), return the set of names in this name class. Otherwise the behavior is undefined.

hasOverlapWith

public final boolean hasOverlapWith(NameClass nc2)

Returns true if the intersection between this name class and the specified name class is non-empty.