org.kohsuke.rngom.nc.NameClass Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jaxb-xjc

Old JAXB Binding Compiler. Contains source code needed for binding customization files into java sources. In other words: the *tool* to generate java classes for the given xml representation.

There is a newer version: 4.0.5

Show newest version

package org.kohsuke.rngom.nc;

import org.kohsuke.rngom.ast.om.ParsedNameClass;

import javax.xml.namespace.QName;
import java.io.Serializable;
import java.util.HashSet;
import java.util.Set;

/**
 * Name class is a set of {@link QName}s.
 */
public abstract class NameClass implements ParsedNameClass, Serializable {
    static final int SPECIFICITY_NONE = -1;
    static final int SPECIFICITY_ANY_NAME = 0;
    static final int SPECIFICITY_NS_NAME = 1;
    static final int SPECIFICITY_NAME = 2;
    
    /**
     * Returns true if the given {@link QName} is a valid name
     * for this QName.
     */
    public abstract boolean contains(QName name);
    
    public abstract int containsSpecificity(QName name);
    
    /**
     * Visitor pattern support.
     */
    public abstract  V accept(NameClassVisitor visitor);
    
    /**
     * Returns true if the name class accepts infinite number of
     * {@link QName}s.
     * 
     * 
     * Intuitively, this method returns true if the name class is
     * some sort of wildcard.
     */
    public abstract boolean isOpen();

    /**
     * If the name class is closed (IOW !{@link #isOpen()}),
     * return the set of names in this name class. Otherwise the behavior
     * is undefined.
     */
    public Set listNames() {
        final Set names = new HashSet();
        accept(new NameClassWalker() {
            public Void visitName(QName name) {
                names.add(name);
                return null;
            }
        });
        return names;
    }

    /**
     * Returns true if the intersection between this name class
     * and the specified name class is non-empty.
     */
    public final boolean hasOverlapWith( NameClass nc2 ) {
        return OverlapDetector.overlap(this,nc2);
    }

    
    /** Sigleton instance that represents "anyName". */
    public static final NameClass ANY = new AnyNameClass();
    
    /**
     * 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:
     * 

     *  Used to recover from errors during parsing.
     *  
Mark element patterns with <notAllowed/> content model.
     * 
     */
    public static final NameClass NULL = new NullNameClass();
}