blob: bdd06c6060c1a5e69148be9a92fab0a1140bb202 [file] [log] [blame]
<!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 -->
<title>ProtoDomain (Apache Beam 2.38.0-SNAPSHOT)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ProtoDomain (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="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/beam/sdk/extensions/protobuf/ProtoCoder.html" title="class in org.apache.beam.sdk.extensions.protobuf"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoDynamicMessageSchema.html" title="class in org.apache.beam.sdk.extensions.protobuf"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/protobuf/ProtoDomain.html" target="_top">Frames</a></li>
<li><a href="ProtoDomain.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.beam.sdk.extensions.protobuf</div>
<h2 title="Class ProtoDomain" class="title">Class ProtoDomain</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.extensions.protobuf.ProtoDomain</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">ProtoDomain</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">ProtoDomain is a container class for Protobuf descriptors. By using a domain for all descriptors
that are related to each other the FileDescriptorSet needs to be serialized only once in the
graph.
<p>Using a domain also grantees that all Descriptors have object equality, just like statically
compiled Proto classes Descriptors. A lot of Java code isn't used to the new DynamicMessages an
assume always Object equality. Because of this the domain class is immutable.
<p>ProtoDomains aren't assumed to be used on with normal Message descriptors, only with
DynamicMessage descriptors.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../serialized-form.html#org.apache.beam.sdk.extensions.protobuf.ProtoDomain">Serialized Form</a></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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</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 long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoDomain.html#serialVersionUID">serialVersionUID</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoDomain.html" title="class in org.apache.beam.sdk.extensions.protobuf">ProtoDomain</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoDomain.html#buildFrom-com.google.protobuf.DescriptorProtos.FileDescriptorSet-">buildFrom</a></span>(<a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.19.3/com/google/protobuf/DescriptorProtos.FileDescriptorSet.html?is-external=true" title="class or interface in com.google.protobuf">DescriptorProtos.FileDescriptorSet</a>&nbsp;fileDescriptorSet)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoDomain.html" title="class in org.apache.beam.sdk.extensions.protobuf">ProtoDomain</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoDomain.html#buildFrom-com.google.protobuf.Descriptors.Descriptor-">buildFrom</a></span>(<a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.19.3/com/google/protobuf/Descriptors.Descriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.Descriptor</a>&nbsp;descriptor)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoDomain.html" title="class in org.apache.beam.sdk.extensions.protobuf">ProtoDomain</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoDomain.html#buildFrom-com.google.protobuf.Descriptors.FileDescriptor-">buildFrom</a></span>(<a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.19.3/com/google/protobuf/Descriptors.FileDescriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.FileDescriptor</a>&nbsp;fileDescriptor)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoDomain.html" title="class in org.apache.beam.sdk.extensions.protobuf">ProtoDomain</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoDomain.html#buildFrom-java.io.InputStream-">buildFrom</a></span>(java.io.InputStream&nbsp;inputStream)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoDomain.html#contains-com.google.protobuf.Descriptors.Descriptor-">contains</a></span>(<a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.19.3/com/google/protobuf/Descriptors.Descriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.Descriptor</a>&nbsp;descriptor)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoDomain.html#equals-java.lang.Object-">equals</a></span>(<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> java.lang.Object&nbsp;o)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.19.3/com/google/protobuf/Descriptors.Descriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.Descriptor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoDomain.html#getDescriptor-java.lang.String-">getDescriptor</a></span>(java.lang.String&nbsp;fullName)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.19.3/com/google/protobuf/Descriptors.FieldDescriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.FieldDescriptor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoDomain.html#getFieldOptionById-int-">getFieldOptionById</a></span>(int&nbsp;id)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.19.3/com/google/protobuf/Descriptors.FileDescriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.FileDescriptor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoDomain.html#getFileDescriptor-java.lang.String-">getFileDescriptor</a></span>(java.lang.String&nbsp;name)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoDomain.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</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="serialVersionUID">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>serialVersionUID</h4>
<pre>public static final&nbsp;long serialVersionUID</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.beam.sdk.extensions.protobuf.ProtoDomain.serialVersionUID">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="buildFrom-com.google.protobuf.Descriptors.Descriptor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildFrom</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoDomain.html" title="class in org.apache.beam.sdk.extensions.protobuf">ProtoDomain</a>&nbsp;buildFrom(<a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.19.3/com/google/protobuf/Descriptors.Descriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.Descriptor</a>&nbsp;descriptor)</pre>
</li>
</ul>
<a name="buildFrom-com.google.protobuf.DescriptorProtos.FileDescriptorSet-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildFrom</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoDomain.html" title="class in org.apache.beam.sdk.extensions.protobuf">ProtoDomain</a>&nbsp;buildFrom(<a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.19.3/com/google/protobuf/DescriptorProtos.FileDescriptorSet.html?is-external=true" title="class or interface in com.google.protobuf">DescriptorProtos.FileDescriptorSet</a>&nbsp;fileDescriptorSet)</pre>
</li>
</ul>
<a name="buildFrom-com.google.protobuf.Descriptors.FileDescriptor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildFrom</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoDomain.html" title="class in org.apache.beam.sdk.extensions.protobuf">ProtoDomain</a>&nbsp;buildFrom(<a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.19.3/com/google/protobuf/Descriptors.FileDescriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.FileDescriptor</a>&nbsp;fileDescriptor)</pre>
</li>
</ul>
<a name="buildFrom-java.io.InputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildFrom</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoDomain.html" title="class in org.apache.beam.sdk.extensions.protobuf">ProtoDomain</a>&nbsp;buildFrom(java.io.InputStream&nbsp;inputStream)
throws java.io.IOException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="getFileDescriptor-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFileDescriptor</h4>
<pre>public&nbsp;<a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.19.3/com/google/protobuf/Descriptors.FileDescriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.FileDescriptor</a>&nbsp;getFileDescriptor(java.lang.String&nbsp;name)</pre>
</li>
</ul>
<a name="getDescriptor-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescriptor</h4>
<pre>public&nbsp;<a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.19.3/com/google/protobuf/Descriptors.Descriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.Descriptor</a>&nbsp;getDescriptor(java.lang.String&nbsp;fullName)</pre>
</li>
</ul>
<a name="getFieldOptionById-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFieldOptionById</h4>
<pre>public&nbsp;<a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.19.3/com/google/protobuf/Descriptors.FieldDescriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.FieldDescriptor</a>&nbsp;getFieldOptionById(int&nbsp;id)</pre>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> java.lang.Object&nbsp;o)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="contains-com.google.protobuf.Descriptors.Descriptor-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>contains</h4>
<pre>public&nbsp;boolean&nbsp;contains(<a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.19.3/com/google/protobuf/Descriptors.Descriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.Descriptor</a>&nbsp;descriptor)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="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/beam/sdk/extensions/protobuf/ProtoCoder.html" title="class in org.apache.beam.sdk.extensions.protobuf"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoDynamicMessageSchema.html" title="class in org.apache.beam.sdk.extensions.protobuf"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/protobuf/ProtoDomain.html" target="_top">Frames</a></li>
<li><a href="ProtoDomain.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>