org.kohsuke.rngom.parse.Parseable Maven / Gradle / Ivy
/*
* Copyright (C) 2004-2011
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.kohsuke.rngom.parse;
import org.kohsuke.rngom.ast.builder.*;
import org.kohsuke.rngom.ast.om.*;
/**
* An input that can be turned into a RELAX NG pattern.
*
*
* This is either a RELAX NG schema in the XML format, or a RELAX NG
* schema in the compact syntax.
*/
public interface Parseable {
/**
* Parses this {@link Parseable} object into a RELAX NG pattern.
*
* @param sb
* The builder of the schema object model. This object
* dictates how the actual pattern is constructed.
*
* @return
* a parsed object. Always returns a non-null valid object.
*/
P parse(SchemaBuilder sb) throws BuildException, IllegalSchemaException;
/**
* Called from {@link Include} in response to
* {@link Include#endInclude(Parseable, String, String, Location, Annotations)}
* to parse the included grammar.
*
* @param g
* receives the events from the included grammar.
*/
P parseInclude(String uri, SchemaBuilder f, IncludedGrammar g, String inheritedNs)
throws BuildException, IllegalSchemaException;
/**
* Called from {@link SchemaBuilder} in response to
* {@link SchemaBuilder#makeExternalRef(Parseable, String, String, Scope, Location, Annotations)}
* to parse the referenced grammar.
*
* @param f
* receives the events from the referenced grammar.
*/
P parseExternal(String uri, SchemaBuilder f, Scope s, String inheritedNs)
throws BuildException, IllegalSchemaException;
}