org.fabric3.spi.contribution.xml.XmlResourceElementLoaderRegistry Maven / Gradle / Ivy
/*
* Fabric3
* Copyright (c) 2009-2015 Metaform Systems
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* Portions originally based on Apache Tuscany 2007
* licensed under the Apache 2.0 license.
*/
package org.fabric3.spi.contribution.xml;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import org.fabric3.api.host.contribution.InstallException;
import org.fabric3.spi.contribution.Resource;
import org.fabric3.spi.introspection.IntrospectionContext;
/**
* A registry of XmlResourceElementLoaders
*/
public interface XmlResourceElementLoaderRegistry {
/**
* Register a XmlResourceElementLoader using the processor's QName type as the key
*
* @param indexer the indexer to register
*/
void register(XmlResourceElementLoader indexer);
/**
* Unregister an XmlResourceElementLoader for a QName
*
* @param name the QName
*/
void unregister(QName name);
/**
* Dispatches to an XmlResourceElementLoader to loads an element in an XML resource
*
* @param reader the StAX reader, positioned at the start of the element to laod
* @param resource the resource
* @param context the context to which validation errors and warnings are reported
* @throws InstallException if a fatal error loading the resource occurs
* @throws XMLStreamException if an error parsing the XML stream occurs
*/
void load(XMLStreamReader reader, Resource resource, IntrospectionContext context) throws InstallException, XMLStreamException;
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy