| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_121) on Fri Jan 06 19:36:21 UTC 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>MetaDataSerializer (OpenJPA Parent POM 2.4.2 API)</title> |
| <meta name="date" content="2017-01-06"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MetaDataSerializer (OpenJPA Parent POM 2.4.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MetaDataSerializer.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/openjpa/lib/meta/MetaDataParser.html" title="interface in org.apache.openjpa.lib.meta"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/lib/meta/ResourceMetaDataIterator.html" title="class in org.apache.openjpa.lib.meta"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/lib/meta/MetaDataSerializer.html" target="_top">Frames</a></li> |
| <li><a href="MetaDataSerializer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.openjpa.lib.meta</div> |
| <h2 title="Interface MetaDataSerializer" class="title">Interface MetaDataSerializer</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/openjpa/meta/AbstractCFMetaDataFactory.Serializer.html" title="interface in org.apache.openjpa.meta">AbstractCFMetaDataFactory.Serializer</a>, <a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaSerializer.html" title="interface in org.apache.openjpa.jdbc.schema">SchemaSerializer</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/openjpa/persistence/jdbc/AnnotationPersistenceMappingSerializer.html" title="class in org.apache.openjpa.persistence.jdbc">AnnotationPersistenceMappingSerializer</a>, <a href="../../../../../org/apache/openjpa/persistence/AnnotationPersistenceMetaDataSerializer.html" title="class in org.apache.openjpa.persistence">AnnotationPersistenceMetaDataSerializer</a>, <a href="../../../../../org/apache/openjpa/lib/meta/CFMetaDataSerializer.html" title="class in org.apache.openjpa.lib.meta">CFMetaDataSerializer</a>, <a href="../../../../../org/apache/openjpa/lib/meta/XMLMetaDataSerializer.html" title="class in org.apache.openjpa.lib.meta">XMLMetaDataSerializer</a>, <a href="../../../../../org/apache/openjpa/persistence/jdbc/XMLPersistenceMappingSerializer.html" title="class in org.apache.openjpa.persistence.jdbc">XMLPersistenceMappingSerializer</a>, <a href="../../../../../org/apache/openjpa/persistence/XMLPersistenceMetaDataSerializer.html" title="class in org.apache.openjpa.persistence">XMLPersistenceMetaDataSerializer</a>, <a href="../../../../../org/apache/openjpa/jdbc/schema/XMLSchemaSerializer.html" title="class in org.apache.openjpa.jdbc.schema">XMLSchemaSerializer</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">MetaDataSerializer</span></pre> |
| <div class="block">Interface for meta data serializers.</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd>Abe White</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html#APPEND">APPEND</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html#COMPACT">COMPACT</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html#PRETTY">PRETTY</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html#VERBOSE">VERBOSE</a></strong></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html#serialize(java.io.File,%20int)">serialize</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file, |
| int flags)</code> |
| <div class="block">Serialize the current set of objects to the given file.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html#serialize(int)">serialize</a></strong>(int flags)</code> |
| <div class="block">Serialize the current set of objects to the files from which they were |
| parsed.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html#serialize(java.util.Map,%20int)">serialize</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> output, |
| int flags)</code> |
| <div class="block">Serialize the current set of objects to the files from which they were |
| parsed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html#serialize(java.io.Writer,%20int)">serialize</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> out, |
| int flags)</code> |
| <div class="block">Serialize the current set of objects to the given stream.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="COMPACT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>COMPACT</h4> |
| <pre>static final int COMPACT</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.lib.meta.MetaDataSerializer.COMPACT">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="PRETTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PRETTY</h4> |
| <pre>static final int PRETTY</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.lib.meta.MetaDataSerializer.PRETTY">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="APPEND"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>APPEND</h4> |
| <pre>static final int APPEND</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.lib.meta.MetaDataSerializer.APPEND">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="VERBOSE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>VERBOSE</h4> |
| <pre>static final int VERBOSE</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.lib.meta.MetaDataSerializer.VERBOSE">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="serialize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serialize</h4> |
| <pre>void serialize(int flags) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Serialize the current set of objects to the files from which they were |
| parsed. Any objects for which a source file cannot be determined will |
| not be included in the output.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>flags</code> - bit flags specifying the output flags; e.g. <a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html#PRETTY"><code>PRETTY</code></a></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="serialize(java.util.Map, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serialize</h4> |
| <pre>void serialize(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> output, |
| int flags) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Serialize the current set of objects to the files from which they were |
| parsed. The objects must implement the <a href="../../../../../org/apache/openjpa/lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta"><code>SourceTracker</code></a> interface.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>output</code> - if null, then serialize directly to the file system; |
| otherwise, populate the specified <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> with |
| keys that are the <a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> instances, and |
| values that are the <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> contents of the MetaData</dd><dd><code>flags</code> - bit flags specifying the output flags; e.g. <a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html#PRETTY"><code>PRETTY</code></a></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="serialize(java.io.File, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serialize</h4> |
| <pre>void serialize(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file, |
| int flags) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Serialize the current set of objects to the given file.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>flags</code> - bit flags specifying the output flags; e.g. |
| <a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html#PRETTY"><code>PRETTY</code></a> | <a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html#APPEND"><code>APPEND</code></a></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="serialize(java.io.Writer, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>serialize</h4> |
| <pre>void serialize(<a href="http://download.oracle.com/javase/6/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> out, |
| int flags) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Serialize the current set of objects to the given stream.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>flags</code> - bit flags specifying the output flags; e.g. <a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html#PRETTY"><code>PRETTY</code></a></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MetaDataSerializer.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/openjpa/lib/meta/MetaDataParser.html" title="interface in org.apache.openjpa.lib.meta"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/lib/meta/ResourceMetaDataIterator.html" title="class in org.apache.openjpa.lib.meta"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/lib/meta/MetaDataSerializer.html" target="_top">Frames</a></li> |
| <li><a href="MetaDataSerializer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |