| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ProtoLiteUtils (grpc-all 1.74.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.7.1.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ProtoLiteUtils (grpc-all 1.74.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":9,"i2":9,"i3":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ProtoLiteUtils.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">io.grpc.protobuf.lite</a></div> |
| <h2 title="Class ProtoLiteUtils" class="title">Class ProtoLiteUtils</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>io.grpc.protobuf.lite.ProtoLiteUtils</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre><a href="../../ExperimentalApi.html" title="annotation in io.grpc">@ExperimentalApi</a>("Will remain experimental as protobuf lite API is not stable") |
| public final class <span class="typeNameLabel">ProtoLiteUtils</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre> |
| <div class="block">Utility methods for using protobuf with grpc. |
| |
| <p>Note that this class will remain experimental for the foreseeable future as the proto lite |
| API, which this class depends on, is not guaranteed to be stable. This is explained in protobuf |
| documentation at: https://github.com/protocolbuffers/protobuf/blob/main/java/lite.md</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <T extends <a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageLite.html?is-external=true" title="class or interface in com.google.protobuf" class="externalLink">MessageLite</a>><br><a href="../../MethodDescriptor.Marshaller.html" title="interface in io.grpc">MethodDescriptor.Marshaller</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#marshaller(T)">marshaller</a></span>​(T defaultInstance)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a <a href="../../MethodDescriptor.Marshaller.html" title="interface in io.grpc"><code>MethodDescriptor.Marshaller</code></a> for protos of the same type as <code>defaultInstance</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <T extends <a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageLite.html?is-external=true" title="class or interface in com.google.protobuf" class="externalLink">MessageLite</a>><br><a href="../../MethodDescriptor.Marshaller.html" title="interface in io.grpc">MethodDescriptor.Marshaller</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#marshallerWithRecursionLimit(T,int)">marshallerWithRecursionLimit</a></span>​(T defaultInstance, |
| int recursionLimit)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a <a href="../../MethodDescriptor.Marshaller.html" title="interface in io.grpc"><code>MethodDescriptor.Marshaller</code></a> for protos of the same type as <code>defaultInstance</code> and a |
| custom limit for the recursion depth.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <T extends <a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageLite.html?is-external=true" title="class or interface in com.google.protobuf" class="externalLink">MessageLite</a>><br><a href="../../Metadata.BinaryMarshaller.html" title="interface in io.grpc">Metadata.BinaryMarshaller</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#metadataMarshaller(T)">metadataMarshaller</a></span>​(T defaultInstance)</code></th> |
| <td class="colLast"> |
| <div class="block">Produce a metadata marshaller for a protobuf type.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExtensionRegistry(com.google.protobuf.ExtensionRegistryLite)">setExtensionRegistry</a></span>​(<a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/ExtensionRegistryLite.html?is-external=true" title="class or interface in com.google.protobuf" class="externalLink">ExtensionRegistryLite</a> newRegistry)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the global registry for proto marshalling shared across all servers and clients.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="setExtensionRegistry(com.google.protobuf.ExtensionRegistryLite)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExtensionRegistry</h4> |
| <pre class="methodSignature">public static void setExtensionRegistry​(<a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/ExtensionRegistryLite.html?is-external=true" title="class or interface in com.google.protobuf" class="externalLink">ExtensionRegistryLite</a> newRegistry)</pre> |
| <div class="block">Sets the global registry for proto marshalling shared across all servers and clients. |
| |
| <p>Warning: This API will likely change over time. It is not possible to have separate |
| registries per Process, Server, Channel, Service, or Method. This is intentional until there |
| is a more appropriate API to set them. |
| |
| <p>Warning: Do NOT modify the extension registry after setting it. It is thread safe to call |
| <a href="#setExtensionRegistry(com.google.protobuf.ExtensionRegistryLite)"><code>setExtensionRegistry(com.google.protobuf.ExtensionRegistryLite)</code></a>, but not to modify the underlying object. |
| |
| <p>If you need custom parsing behavior for protos, you will need to make your own |
| <code>MethodDescriptor.Marshaller</code> for the time being.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="marshaller(com.google.protobuf.MessageLite)"> |
| <!-- --> |
| </a><a id="marshaller(T)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>marshaller</h4> |
| <pre class="methodSignature">public static <T extends <a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageLite.html?is-external=true" title="class or interface in com.google.protobuf" class="externalLink">MessageLite</a>> <a href="../../MethodDescriptor.Marshaller.html" title="interface in io.grpc">MethodDescriptor.Marshaller</a><T> marshaller​(T defaultInstance)</pre> |
| <div class="block">Creates a <a href="../../MethodDescriptor.Marshaller.html" title="interface in io.grpc"><code>MethodDescriptor.Marshaller</code></a> for protos of the same type as <code>defaultInstance</code>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="marshallerWithRecursionLimit(com.google.protobuf.MessageLite,int)"> |
| <!-- --> |
| </a><a id="marshallerWithRecursionLimit(T,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>marshallerWithRecursionLimit</h4> |
| <pre class="methodSignature">public static <T extends <a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageLite.html?is-external=true" title="class or interface in com.google.protobuf" class="externalLink">MessageLite</a>> <a href="../../MethodDescriptor.Marshaller.html" title="interface in io.grpc">MethodDescriptor.Marshaller</a><T> marshallerWithRecursionLimit​(T defaultInstance, |
| int recursionLimit)</pre> |
| <div class="block">Creates a <a href="../../MethodDescriptor.Marshaller.html" title="interface in io.grpc"><code>MethodDescriptor.Marshaller</code></a> for protos of the same type as <code>defaultInstance</code> and a |
| custom limit for the recursion depth. Any negative number will leave the limit as its default |
| value as defined by the protobuf library.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.56.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="metadataMarshaller(com.google.protobuf.MessageLite)"> |
| <!-- --> |
| </a><a id="metadataMarshaller(T)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>metadataMarshaller</h4> |
| <pre class="methodSignature">public static <T extends <a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageLite.html?is-external=true" title="class or interface in com.google.protobuf" class="externalLink">MessageLite</a>> <a href="../../Metadata.BinaryMarshaller.html" title="interface in io.grpc">Metadata.BinaryMarshaller</a><T> metadataMarshaller​(T defaultInstance)</pre> |
| <div class="block">Produce a metadata marshaller for a protobuf type.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ProtoLiteUtils.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |
