com.sun.msv.verifier.DocumentDeclaration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jaxb1-impl

JAXB (JSR 222) reference implementation - JAXB1 build

There is a newer version: 2.2.5.1

/*
 * @(#)$Id: DocumentDeclaration.java,v 1.7 2003/06/09 20:37:42 kk122374 Exp $
 *
 * Copyright 2001 Sun Microsystems, Inc. All Rights Reserved.
 * 
 * This software is the proprietary information of Sun Microsystems, Inc.  
 * Use is subject to license terms.
 * 
 */
package com.sun.msv.verifier;

/**
 * Represents a kind of "constraint" over XML document.
 * 
 * Usually, this is what people call a schema.
 * 
 * 
 * Call the {@link #createAcceptor()} method to start validation.
 * 
 * @see Acceptor
 * 
 * @author Kohsuke KAWAGUCHI
 */
public interface DocumentDeclaration {
    
    /**
     * creates a new Acceptor that will validate the document element.
     * 
     * In RELAX, this concept is equivalent to <topLevel>
     * In TREX, this concept is equivalent to <start>
     * 
     * @return
     *        The implementation cannot return null.
     *        Apparently, it is impossible to fail in this early stage.
     */
    Acceptor createAcceptor();
}