com.sun.tools.rngom.ast.builder.IncludedGrammar Maven / Gradle / Ivy
/*
* Copyright (C) 2004-2015
*
* 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 com.sun.tools.rngom.ast.builder;
import com.sun.tools.rngom.ast.om.ParsedElementAnnotation;
import com.sun.tools.rngom.ast.om.Location;
import com.sun.tools.rngom.ast.om.ParsedPattern;
import com.sun.tools.rngom.parse.Parseable;
/**
* {@link Scope} for {@code } element of the {@code }d grammar.
*
* This object builds {@code }s in the included grammar that
* override the definitions in the original grammar.
*/
public interface IncludedGrammar<
P extends ParsedPattern,
E extends ParsedElementAnnotation,
L extends Location,
A extends Annotations,
CL extends CommentList> extends GrammarSection, Scope {
/**
*
* @return
* technically, an included gramamr does not produce a pattern,
* but this allows {@link Parseable#parseInclude(String, SchemaBuilder, IncludedGrammar, String)}
* to return the result from {@link IncludedGrammar} nicely.
*
*
* The value returned from this method will be returned from the abovementioned method.
*/
P endIncludedGrammar(L loc, A anno) throws BuildException;
}