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.IWritingContext;
030import gov.nist.secauto.metaschema.databind.model.IBoundNamedModelInstance;
031import gov.nist.secauto.metaschema.databind.model.IClassBinding;
032
033import org.codehaus.stax2.XMLStreamWriter2;
034
035import java.io.IOException;
036
037import javax.xml.namespace.QName;
038
039import edu.umd.cs.findbugs.annotations.NonNull;
040
041public interface IXmlWritingContext extends IWritingContext<XMLStreamWriter2> {
042  /**
043   * Write the data described by the provided {@code targetDefinition} as an XML
044   * element.
045   *
046   * @param targetDefinition
047   *          the bound Module definition describing the structure of the XML data
048   *          to write
049   * @param targetObject
050   *          the Java object data to write
051   * @param parentName
052   *          the qualified name of the XML element to write
053   * @throws IOException
054   *           if an error occurred while writing the XML
055   */
056  void writeDefinitionValue(
057      @NonNull IClassBinding targetDefinition,
058      @NonNull Object targetObject,
059      @NonNull QName parentName) throws IOException;
060
061  /**
062   * Write the data described by the provided {@code targetDefinition} as an XML
063   * element.
064   *
065   * @param targetInstance
066   *          the model instance that describes the syntax of the data to write
067   * @param targetObject
068   *          the Java object data to write
069   * @param parentName
070   *          the qualified name of the XML element to write
071   * @throws IOException
072   *           if an error occurred while writing the XML
073   */
074  void writeInstanceValue(
075      @NonNull IBoundNamedModelInstance targetInstance,
076      @NonNull Object targetObject,
077      @NonNull QName parentName) throws IOException;
078}