org.jboss.jca.common.metadata.MetadataParser Maven / Gradle / Ivy
/*
* IronJacamar, a Java EE Connector Architecture implementation
* Copyright 2008, Red Hat Inc, and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.jca.common.metadata;
import org.jboss.jca.common.api.metadata.JCAMetadata;
import java.io.InputStream;
import javax.xml.stream.XMLStreamReader;
/**
*
* A MetadataParser.
*
* @author Stefano Maestri
* @param
*
*/
public interface MetadataParser
{
/**
* Are system properties resolved ?
* @return True if resolved (default); otherwise false
*/
public boolean isSystemPropertiesResolved();
/**
* Set if system properties should be resolved
* @param v The value
*/
public void setSystemPropertiesResolved(boolean v);
/**
* Parse the xml file and return the JCAMetaData for which the concrete parser is designed.
* Note that is responsibility of the client to open and close the stream
* @param xmlInputStream an InputStrema opened on the xml file to parse
* @return The metadata
* @exception Exception Thrown if an error occurs
*/
public T parse(InputStream xmlInputStream) throws Exception;
/**
* Parse the xml file and return the JCAMetaData for which the concrete parser is designed.
* Note that is responsibility of the client to open and close the stream
* @param reader an XMLStreamReader opened on the xml file to parse
* @return The metadata
* @exception Exception Thrown if an error occurs
*/
public T parse(XMLStreamReader reader) throws Exception;
}