001/* 002 * Portions of this software was developed by employees of the National Institute 003 * of Standards and Technology (NIST), an agency of the Federal Government and is 004 * being made available as a public service. Pursuant to title 17 United States 005 * Code Section 105, works of NIST employees are not subject to copyright 006 * protection in the United States. This software may be subject to foreign 007 * copyright. Permission in the United States and in foreign countries, to the 008 * extent that NIST may hold copyright, to use, copy, modify, create derivative 009 * works, and distribute this software and its documentation without fee is hereby 010 * granted on a non-exclusive basis, provided that this notice and disclaimer 011 * of warranty appears in all copies. 012 * 013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER 014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY 015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF 016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM 017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE 018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT 019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, 020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, 021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, 022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR 023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT 024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. 025 */ 026 027package gov.nist.secauto.metaschema.databind.io.xml; 028 029import gov.nist.secauto.metaschema.databind.io.IParsingContext; 030import gov.nist.secauto.metaschema.databind.model.IBoundNamedModelInstance; 031import gov.nist.secauto.metaschema.databind.model.IClassBinding; 032 033import org.codehaus.stax2.XMLEventReader2; 034import org.codehaus.stax2.XMLStreamReader2; 035 036import java.io.IOException; 037 038import javax.xml.stream.XMLStreamConstants; 039import javax.xml.stream.XMLStreamException; 040import javax.xml.stream.events.StartElement; 041import javax.xml.stream.events.XMLEvent; 042 043import edu.umd.cs.findbugs.annotations.NonNull; 044import edu.umd.cs.findbugs.annotations.Nullable; 045 046public interface IXmlParsingContext extends IParsingContext<XMLEventReader2, IXmlProblemHandler> { 047 048 /** 049 * Read the XML data associated with the {@code targetInstance} and apply it to 050 * the provided {@code parentObject}. 051 * 052 * @param <T> 053 * the resulting object type 054 * @param targetInstance 055 * the instance to parse data for 056 * @param parentObject 057 * the Java object that data parsed by this method will be stored in 058 * @param start 059 * the XML element start and attribute data previously parsed 060 * @return the Java object read, or {@code null} if no data was read 061 * @throws IOException 062 * if an error occurred while parsing the input 063 * @throws XMLStreamException 064 * if an error occurred while parsing XML events 065 */ 066 @Nullable 067 <T> T readModelInstanceValue( 068 @NonNull IBoundNamedModelInstance targetInstance, 069 @NonNull Object parentObject, 070 @NonNull StartElement start) throws XMLStreamException, IOException; 071 072 /** 073 * Reads a XML element storing the associated data in a Java class instance, 074 * returning the resulting instance. 075 * <p> 076 * When called the next {@link XMLEvent} of the {@link XMLStreamReader2} is 077 * expected to be a {@link XMLStreamConstants#START_ELEMENT} that is the XML 078 * element associated with the Java class. 079 * <p> 080 * After returning the next {@link XMLEvent} of the {@link XMLStreamReader2} is 081 * expected to be a the next event after the 082 * {@link XMLStreamConstants#END_ELEMENT} for the XML 083 * {@link XMLStreamConstants#START_ELEMENT} element associated with the Java 084 * class. 085 * 086 * @param <T> 087 * the resulting object type 088 * @param targetDefinition 089 * the Module definition that describes the syntax of the data to read 090 * @param parentObject 091 * the Java object parent of the target object, which can be 092 * {@code null} if there is no parent 093 * @param start 094 * the XML element start and attribute data previously parsed 095 * @return the Java object containing the data parsed by this method 096 * @throws IOException 097 * if an error occurred while parsing the input 098 * @throws XMLStreamException 099 * if an error occurred while parsing XML events 100 * 101 */ 102 @NonNull 103 <T> T readDefinitionValue( 104 @NonNull IClassBinding targetDefinition, 105 @Nullable Object parentObject, 106 @NonNull StartElement start) throws IOException, XMLStreamException; 107}