1 /* 2 * Portions of this software was developed by employees of the National Institute 3 * of Standards and Technology (NIST), an agency of the Federal Government and is 4 * being made available as a public service. Pursuant to title 17 United States 5 * Code Section 105, works of NIST employees are not subject to copyright 6 * protection in the United States. This software may be subject to foreign 7 * copyright. Permission in the United States and in foreign countries, to the 8 * extent that NIST may hold copyright, to use, copy, modify, create derivative 9 * works, and distribute this software and its documentation without fee is hereby 10 * granted on a non-exclusive basis, provided that this notice and disclaimer 11 * of warranty appears in all copies. 12 * 13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER 14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY 15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM 17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE 18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT 19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, 20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, 21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, 22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR 23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT 24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. 25 */ 26 27 package gov.nist.secauto.metaschema.databind.io.xml; 28 29 import gov.nist.secauto.metaschema.databind.io.IWritingContext; 30 import gov.nist.secauto.metaschema.databind.model.IBoundNamedModelInstance; 31 import gov.nist.secauto.metaschema.databind.model.IClassBinding; 32 33 import org.codehaus.stax2.XMLStreamWriter2; 34 35 import java.io.IOException; 36 37 import javax.xml.namespace.QName; 38 39 import edu.umd.cs.findbugs.annotations.NonNull; 40 41 public interface IXmlWritingContext extends IWritingContext<XMLStreamWriter2> { 42 /** 43 * Write the data described by the provided {@code targetDefinition} as an XML 44 * element. 45 * 46 * @param targetDefinition 47 * the bound Module definition describing the structure of the XML data 48 * to write 49 * @param targetObject 50 * the Java object data to write 51 * @param parentName 52 * the qualified name of the XML element to write 53 * @throws IOException 54 * if an error occurred while writing the XML 55 */ 56 void writeDefinitionValue( 57 @NonNull IClassBinding targetDefinition, 58 @NonNull Object targetObject, 59 @NonNull QName parentName) throws IOException; 60 61 /** 62 * Write the data described by the provided {@code targetDefinition} as an XML 63 * element. 64 * 65 * @param targetInstance 66 * the model instance that describes the syntax of the data to write 67 * @param targetObject 68 * the Java object data to write 69 * @param parentName 70 * the qualified name of the XML element to write 71 * @throws IOException 72 * if an error occurred while writing the XML 73 */ 74 void writeInstanceValue( 75 @NonNull IBoundNamedModelInstance targetInstance, 76 @NonNull Object targetObject, 77 @NonNull QName parentName) throws IOException; 78 }