| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>StatusUtils (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)</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="StatusUtils (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":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"; |
| </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="class-use/StatusUtils.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/arrow/flight/grpc/ServerInterceptorAdapter.KeyFactory.html" title="class in org.apache.arrow.flight.grpc"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/flight/grpc/StatusUtils.html" target="_top">Frames</a></li> |
| <li><a href="StatusUtils.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>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 name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.arrow.flight.grpc</div> |
| <h2 title="Class StatusUtils" class="title">Class StatusUtils</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">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.arrow.flight.grpc.StatusUtils</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">StatusUtils</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">Object</a></pre> |
| <div class="block">Utilities to adapt gRPC and Flight status objects. |
| |
| <p>NOT A PUBLIC CLASS, interface is not guaranteed to remain stable.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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"> </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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/arrow/flight/FlightRuntimeException.html" title="class in org.apache.arrow.flight">FlightRuntimeException</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/grpc/StatusUtils.html#fromGrpcRuntimeException-io.grpc.StatusRuntimeException-">fromGrpcRuntimeException</a></span>(io.grpc.StatusRuntimeException sre)</code> |
| <div class="block">Convert from a gRPC exception to a Flight exception.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/arrow/flight/CallStatus.html" title="class in org.apache.arrow.flight">CallStatus</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/grpc/StatusUtils.html#fromGrpcStatus-io.grpc.Status-">fromGrpcStatus</a></span>(io.grpc.Status status)</code> |
| <div class="block">Convert from a gRPC status to a Flight status.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/arrow/flight/CallStatus.html" title="class in org.apache.arrow.flight">CallStatus</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/grpc/StatusUtils.html#fromGrpcStatusAndTrailers-io.grpc.Status-io.grpc.Metadata-">fromGrpcStatusAndTrailers</a></span>(io.grpc.Status status, |
| io.grpc.Metadata trailers)</code> |
| <div class="block">Convert from a gRPC Status & trailers to a Flight status.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/arrow/flight/FlightStatusCode.html" title="enum in org.apache.arrow.flight">FlightStatusCode</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/grpc/StatusUtils.html#fromGrpcStatusCode-io.grpc.Status.Code-">fromGrpcStatusCode</a></span>(io.grpc.Status.Code code)</code> |
| <div class="block">Convert from a gRPC status code to a Flight status code.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/arrow/flight/FlightRuntimeException.html" title="class in org.apache.arrow.flight">FlightRuntimeException</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/grpc/StatusUtils.html#fromThrowable-java.lang.Throwable-">fromThrowable</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> t)</code> |
| <div class="block">Convert arbitrary exceptions to a <a href="../../../../../org/apache/arrow/flight/FlightRuntimeException.html" title="class in org.apache.arrow.flight"><code>FlightRuntimeException</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/grpc/StatusUtils.html#toGrpcException-java.lang.Throwable-">toGrpcException</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> ex)</code> |
| <div class="block">Convert arbitrary exceptions to a <code>StatusRuntimeException</code> or <code>StatusException</code>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static io.grpc.Status</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/grpc/StatusUtils.html#toGrpcStatus-org.apache.arrow.flight.CallStatus-">toGrpcStatus</a></span>(<a href="../../../../../org/apache/arrow/flight/CallStatus.html" title="class in org.apache.arrow.flight">CallStatus</a> status)</code> |
| <div class="block">Convert from a Flight status to a gRPC status.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static io.grpc.Status.Code</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/grpc/StatusUtils.html#toGrpcStatusCode-org.apache.arrow.flight.FlightStatusCode-">toGrpcStatusCode</a></span>(<a href="../../../../../org/apache/arrow/flight/FlightStatusCode.html" title="enum in org.apache.arrow.flight">FlightStatusCode</a> code)</code> |
| <div class="block">Convert from a Flight status code to a gRPC status code.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static <FROM,TO> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><TO></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/grpc/StatusUtils.html#wrapIterator-java.util.Iterator-java.util.function.Function-">wrapIterator</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><FROM> fromIterator, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function">Function</a><? super FROM,? extends TO> transformer)</code> |
| <div class="block">Maps a transformation function to the elements of an iterator, while wrapping exceptions in <a href="../../../../../org/apache/arrow/flight/FlightRuntimeException.html" title="class in org.apache.arrow.flight"><code>FlightRuntimeException</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="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">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">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">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">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">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">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">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">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">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">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">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">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="toGrpcStatusCode-org.apache.arrow.flight.FlightStatusCode-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toGrpcStatusCode</h4> |
| <pre>public static io.grpc.Status.Code toGrpcStatusCode(<a href="../../../../../org/apache/arrow/flight/FlightStatusCode.html" title="enum in org.apache.arrow.flight">FlightStatusCode</a> code)</pre> |
| <div class="block">Convert from a Flight status code to a gRPC status code.</div> |
| </li> |
| </ul> |
| <a name="fromGrpcStatusCode-io.grpc.Status.Code-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromGrpcStatusCode</h4> |
| <pre>public static <a href="../../../../../org/apache/arrow/flight/FlightStatusCode.html" title="enum in org.apache.arrow.flight">FlightStatusCode</a> fromGrpcStatusCode(io.grpc.Status.Code code)</pre> |
| <div class="block">Convert from a gRPC status code to a Flight status code.</div> |
| </li> |
| </ul> |
| <a name="fromGrpcStatusAndTrailers-io.grpc.Status-io.grpc.Metadata-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromGrpcStatusAndTrailers</h4> |
| <pre>public static <a href="../../../../../org/apache/arrow/flight/CallStatus.html" title="class in org.apache.arrow.flight">CallStatus</a> fromGrpcStatusAndTrailers(io.grpc.Status status, |
| io.grpc.Metadata trailers)</pre> |
| <div class="block">Convert from a gRPC Status & trailers to a Flight status.</div> |
| </li> |
| </ul> |
| <a name="fromGrpcStatus-io.grpc.Status-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromGrpcStatus</h4> |
| <pre>public static <a href="../../../../../org/apache/arrow/flight/CallStatus.html" title="class in org.apache.arrow.flight">CallStatus</a> fromGrpcStatus(io.grpc.Status status)</pre> |
| <div class="block">Convert from a gRPC status to a Flight status.</div> |
| </li> |
| </ul> |
| <a name="toGrpcStatus-org.apache.arrow.flight.CallStatus-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toGrpcStatus</h4> |
| <pre>public static io.grpc.Status toGrpcStatus(<a href="../../../../../org/apache/arrow/flight/CallStatus.html" title="class in org.apache.arrow.flight">CallStatus</a> status)</pre> |
| <div class="block">Convert from a Flight status to a gRPC status.</div> |
| </li> |
| </ul> |
| <a name="fromGrpcRuntimeException-io.grpc.StatusRuntimeException-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromGrpcRuntimeException</h4> |
| <pre>public static <a href="../../../../../org/apache/arrow/flight/FlightRuntimeException.html" title="class in org.apache.arrow.flight">FlightRuntimeException</a> fromGrpcRuntimeException(io.grpc.StatusRuntimeException sre)</pre> |
| <div class="block">Convert from a gRPC exception to a Flight exception.</div> |
| </li> |
| </ul> |
| <a name="fromThrowable-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromThrowable</h4> |
| <pre>public static <a href="../../../../../org/apache/arrow/flight/FlightRuntimeException.html" title="class in org.apache.arrow.flight">FlightRuntimeException</a> fromThrowable(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> t)</pre> |
| <div class="block">Convert arbitrary exceptions to a <a href="../../../../../org/apache/arrow/flight/FlightRuntimeException.html" title="class in org.apache.arrow.flight"><code>FlightRuntimeException</code></a>.</div> |
| </li> |
| </ul> |
| <a name="toGrpcException-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toGrpcException</h4> |
| <pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> toGrpcException(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> ex)</pre> |
| <div class="block">Convert arbitrary exceptions to a <code>StatusRuntimeException</code> or <code>StatusException</code>. |
| |
| <p>Such exceptions can be passed to <code>StreamObserver.onError(Throwable)</code> and will give the client |
| a reasonable error message.</div> |
| </li> |
| </ul> |
| <a name="wrapIterator-java.util.Iterator-java.util.function.Function-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>wrapIterator</h4> |
| <pre>public static <FROM,TO> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><TO> wrapIterator(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><FROM> fromIterator, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function">Function</a><? super FROM,? extends TO> transformer)</pre> |
| <div class="block">Maps a transformation function to the elements of an iterator, while wrapping exceptions in <a href="../../../../../org/apache/arrow/flight/FlightRuntimeException.html" title="class in org.apache.arrow.flight"><code>FlightRuntimeException</code></a>.</div> |
| </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="class-use/StatusUtils.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/arrow/flight/grpc/ServerInterceptorAdapter.KeyFactory.html" title="class in org.apache.arrow.flight.grpc"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/flight/grpc/StatusUtils.html" target="_top">Frames</a></li> |
| <li><a href="StatusUtils.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>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 name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |