| <!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>BeanTraverseSession (Apache Juneau 9.0-B1)</title> |
| <link rel="stylesheet" type="text/css" href="../../../javadoc.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="BeanTraverseSession (Apache Juneau 9.0-B1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10}; |
| var tabs = {65535:["t0","All 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/juneau/BeanTraverseContext.Builder.html" title="class in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/juneau/BeanTraverseSession.Builder.html" title="class in org.apache.juneau"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/juneau/BeanTraverseSession.html" target="_top">Frames</a></li> |
| <li><a href="BeanTraverseSession.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </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><a href="#constructor.detail">Constr</a> | </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.juneau</div> |
| <h2 title="Class BeanTraverseSession" class="title">Class BeanTraverseSession</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><a href="../../../org/apache/juneau/ContextSession.html" title="class in org.apache.juneau">org.apache.juneau.ContextSession</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../org/apache/juneau/BeanSession.html" title="class in org.apache.juneau">org.apache.juneau.BeanSession</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.juneau.BeanTraverseSession</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../org/apache/juneau/jsonschema/JsonSchemaGeneratorSession.html" title="class in org.apache.juneau.jsonschema">JsonSchemaGeneratorSession</a>, <a href="../../../org/apache/juneau/serializer/SerializerSession.html" title="class in org.apache.juneau.serializer">SerializerSession</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../src-html/org/apache/juneau/BeanTraverseSession.html#line.48">BeanTraverseSession</a> |
| extends <a href="../../../org/apache/juneau/BeanSession.html" title="class in org.apache.juneau">BeanSession</a></pre> |
| <div class="block">ContextSession that lives for the duration of a single use of <a href="../../../org/apache/juneau/BeanTraverseContext.html" title="class in org.apache.juneau"><code>BeanTraverseContext</code></a>. |
| |
| <p> |
| Used by serializers and other classes that traverse POJOs for the following purposes: |
| <ul class='spaced-list'> |
| <li> |
| Keeping track of how deep it is in a model for indentation purposes. |
| <li> |
| Ensuring infinite loops don't occur by setting a limit on how deep to traverse a model. |
| <li> |
| Ensuring infinite loops don't occur from loops in the model (when detectRecursions is enabled. |
| </ul> |
| |
| <ul class='notes'> |
| <li class='warn'>This class is not thread safe and is typically discarded after one use. |
| </ul> |
| |
| <ul class='seealso'> |
| <li class='extlink'><a class='doclink' target='_blank' href='https://github.com/apache/juneau/blob/master/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanTraverseSession.java'>Source</a> |
| </ul></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanTraverseSession.Builder.html" title="class in org.apache.juneau">BeanTraverseSession.Builder</a></span></code> |
| <div class="block">Builder class.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== 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"> </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>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanTraverseSession.html#indent">indent</a></span></code> |
| <div class="block">The current indentation depth into the model.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanTraverseSession.html#BeanTraverseSession-org.apache.juneau.BeanTraverseSession.Builder-">BeanTraverseSession</a></span>(<a href="../../../org/apache/juneau/BeanTraverseSession.Builder.html" title="class in org.apache.juneau">BeanTraverseSession.Builder</a> builder)</code> |
| <div class="block">Constructor.</div> |
| </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanTraverseSession.html#getInitialDepth--">getInitialDepth</a></span>()</code> |
| <div class="block">Initial depth.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/juneau/collections/JsonMap.html" title="class in org.apache.juneau.collections">JsonMap</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanTraverseSession.html#getLastLocation--">getLastLocation</a></span>()</code> |
| <div class="block">Returns information used to determine at what location in the parse a failure occurred.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanTraverseSession.html#getMaxDepth--">getMaxDepth</a></span>()</code> |
| <div class="block">Max traversal depth.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanTraverseSession.html#getOptionalType-org.apache.juneau.ClassMeta-">getOptionalType</a></span>(<a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><?> cm)</code> |
| <div class="block">Returns the inner type of an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util"><code>Optional</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected <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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanTraverseSession.html#getOptionalValue-java.lang.Object-">getOptionalValue</a></span>(<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> o)</code> |
| <div class="block">If the specified object is an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util"><code>Optional</code></a>, returns the inner object.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanTraverseSession.html#getStack-boolean-">getStack</a></span>(boolean full)</code> |
| <div class="block">Returns the current stack trace.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanTraverseSession.html#isDetectRecursions--">isDetectRecursions</a></span>()</code> |
| <div class="block">Automatically detect POJO recursions.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanTraverseSession.html#isIgnoreRecursions--">isIgnoreRecursions</a></span>()</code> |
| <div class="block">Ignore recursion errors.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanTraverseSession.html#isOptional-org.apache.juneau.ClassMeta-">isOptional</a></span>(<a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><?> cm)</code> |
| <div class="block">Same as <a href="../../../org/apache/juneau/ClassMeta.html#isOptional--"><code>ClassMeta.isOptional()</code></a> but gracefully handles a null <a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau"><code>ClassMeta</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanTraverseSession.html#isRoot--">isRoot</a></span>()</code> |
| <div class="block">Returns <jk>true</jk> if we're processing the root node.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanTraverseSession.html#onError-java.lang.Throwable-java.lang.String-java.lang.Object...-">onError</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, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg, |
| <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>... args)</code> |
| <div class="block">Logs a warning message.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanTraverseSession.html#pop--">pop</a></span>()</code> |
| <div class="block">Pop an object off the stack.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../org/apache/juneau/collections/JsonMap.html" title="class in org.apache.juneau.collections">JsonMap</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanTraverseSession.html#properties--">properties</a></span>()</code> |
| <div class="block">Returns the properties on this bean as a map for debugging.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanTraverseSession.html#push-java.lang.String-java.lang.Object-org.apache.juneau.ClassMeta-">push</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> attrName, |
| <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> o, |
| <a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><?> eType)</code> |
| <div class="block">Push the specified object onto the stack.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanTraverseSession.html#setCurrentClass-org.apache.juneau.ClassMeta-">setCurrentClass</a></span>(<a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><?> currentClass)</code> |
| <div class="block">Sets the current class being traversed for proper error messages.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanTraverseSession.html#setCurrentProperty-org.apache.juneau.BeanPropertyMeta-">setCurrentProperty</a></span>(<a href="../../../org/apache/juneau/BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a> currentProperty)</code> |
| <div class="block">Sets the current bean property being traversed for proper error messages.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanTraverseSession.html#willExceedDepth--">willExceedDepth</a></span>()</code> |
| <div class="block">Returns <jk>true</jk> if we're about to exceed the max depth for the document.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanTraverseSession.html#willRecurse-java.lang.String-java.lang.Object-org.apache.juneau.ClassMeta-">willRecurse</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> attrName, |
| <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> o, |
| <a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><?> cm)</code> |
| <div class="block">Returns <jk>true</jk> if <a href="../../../org/apache/juneau/BeanTraverseContext.Builder.html#detectRecursions--"><code>BeanTraverseContext.Builder.detectRecursions()</code></a> is enabled, and the specified |
| object is already higher up in the traversal chain.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.BeanSession"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.juneau.<a href="../../../org/apache/juneau/BeanSession.html" title="class in org.apache.juneau">BeanSession</a></h3> |
| <code><a href="../../../org/apache/juneau/BeanSession.html#Z:Z_class--">_class</a>, <a href="../../../org/apache/juneau/BeanSession.html#addWarning-java.lang.String-java.lang.Object...-">addWarning</a>, <a href="../../../org/apache/juneau/BeanSession.html#convertToMemberType-java.lang.Object-java.lang.Object-java.lang.Class-">convertToMemberType</a>, <a href="../../../org/apache/juneau/BeanSession.html#convertToMemberType-java.lang.Object-java.lang.Object-org.apache.juneau.ClassMeta-">convertToMemberType</a>, <a href="../../../org/apache/juneau/BeanSession.html#convertToType-java.lang.Object-java.lang.Class-">convertToType</a>, <a href="../../../org/apache/juneau/BeanSession.html#convertToType-java.lang.Object-org.apache.juneau.ClassMeta-">convertToType</a>, <a href="../../../org/apache/juneau/BeanSession.html#convertToType-java.lang.Object-java.lang.reflect.Type-java.lang.reflect.Type...-">convertToType</a>, <a href="../../../org/apache/juneau/BeanSession.html#create-org.apache.juneau.BeanContext-">create</a>, <a href="../../../org/apache/juneau/BeanSession.html#getArgsClassMeta-java.lang.reflect.Type:A-">getArgsClassMeta</a>, <a href="../../../org/apache/juneau/BeanSession.html#getBeanClassVisibility--">getBeanClassVisibility</a>, <a href="../../../org/apache/juneau/BeanSession.html#getBeanConstructorVisibility--">getBeanConstructorVisibility</a>, <a href="../../../org/apache/juneau/BeanSession.html#getBeanDictionary--">getBeanDictionary</a>, <a href="../../../org/apache/juneau/BeanSession.html#getBeanFieldVisibility--">getBeanFieldVisibility</a>, <a href="../../../org/apache/juneau/BeanSession.html#getBeanMeta-java.lang.Class-">getBeanMeta</a>, <a href="../../../org/apache/juneau/BeanSession.html#getBeanMethodVisibility--">getBeanMethodVisibility</a>, <a href="../../../org/apache/juneau/BeanSession.html#getBeanRegistry--">getBeanRegistry</a>, <a href="../../../org/apache/juneau/BeanSession.html#getBeanTypePropertyName--">getBeanTypePropertyName</a>, <a href="../../../org/apache/juneau/BeanSession.html#getBeanTypePropertyName-org.apache.juneau.ClassMeta-">getBeanTypePropertyName</a>, <a href="../../../org/apache/juneau/BeanSession.html#getClassMeta-java.lang.Class-">getClassMeta</a>, <a href="../../../org/apache/juneau/BeanSession.html#getClassMeta-java.lang.reflect.Type-java.lang.reflect.Type...-">getClassMeta</a>, <a href="../../../org/apache/juneau/BeanSession.html#getClassMetaForObject-java.lang.Object-org.apache.juneau.ClassMeta-">getClassMetaForObject</a>, <a href="../../../org/apache/juneau/BeanSession.html#getClassMetaForObject-T-">getClassMetaForObject</a>, <a href="../../../org/apache/juneau/BeanSession.html#getLocale--">getLocale</a>, <a href="../../../org/apache/juneau/BeanSession.html#getMediaType--">getMediaType</a>, <a href="../../../org/apache/juneau/BeanSession.html#getNamePropertyName--">getNamePropertyName</a>, <a href="../../../org/apache/juneau/BeanSession.html#getNotBeanClasses--">getNotBeanClasses</a>, <a href="../../../org/apache/juneau/BeanSession.html#getNotBeanPackagesNames--">getNotBeanPackagesNames</a>, <a href="../../../org/apache/juneau/BeanSession.html#getNotBeanPackagesPrefixes--">getNotBeanPackagesPrefixes</a>, <a href="../../../org/apache/juneau/BeanSession.html#getPropertyNamer--">getPropertyNamer</a>, <a href="../../../org/apache/juneau/BeanSession.html#getSwaps--">getSwaps</a>, <a href="../../../org/apache/juneau/BeanSession.html#getTimeZone--">getTimeZone</a>, <a href="../../../org/apache/juneau/BeanSession.html#getTimeZoneId--">getTimeZoneId</a>, <a href="../../../org/apache/juneau/BeanSession.html#isBean-java.lang.Class-">isBean</a>, <a href="../../../org/apache/juneau/BeanSession.html#isBean-java.lang.Object-">isBean</a>, <a href="../../../org/apache/juneau/BeanSession.html#isBeanMapPutReturnsOldValue--">isBeanMapPutReturnsOldValue</a>, <a href="../../../org/apache/juneau/BeanSession.html#isBeansRequireDefaultConstructor--">isBeansRequireDefaultConstructor</a>, <a href="../../../org/apache/juneau/BeanSession.html#isBeansRequireSerializable--">isBeansRequireSerializable</a>, <a href="../../../org/apache/juneau/BeanSession.html#isBeansRequireSettersForGetters--">isBeansRequireSettersForGetters</a>, <a href="../../../org/apache/juneau/BeanSession.html#isBeansRequireSomeProperties--">isBeansRequireSomeProperties</a>, <a href="../../../org/apache/juneau/BeanSession.html#isFindFluentSetters--">isFindFluentSetters</a>, <a href="../../../org/apache/juneau/BeanSession.html#isIgnoreInvocationExceptionsOnGetters--">isIgnoreInvocationExceptionsOnGetters</a>, <a href="../../../org/apache/juneau/BeanSession.html#isIgnoreInvocationExceptionsOnSetters--">isIgnoreInvocationExceptionsOnSetters</a>, <a href="../../../org/apache/juneau/BeanSession.html#isIgnoreMissingSetters--">isIgnoreMissingSetters</a>, <a href="../../../org/apache/juneau/BeanSession.html#isIgnoreUnknownBeanProperties--">isIgnoreUnknownBeanProperties</a>, <a href="../../../org/apache/juneau/BeanSession.html#isIgnoreUnknownNullBeanProperties--">isIgnoreUnknownNullBeanProperties</a>, <a href="../../../org/apache/juneau/BeanSession.html#isSortProperties--">isSortProperties</a>, <a href="../../../org/apache/juneau/BeanSession.html#isUseEnumNames--">isUseEnumNames</a>, <a href="../../../org/apache/juneau/BeanSession.html#isUseInterfaceProxies--">isUseInterfaceProxies</a>, <a href="../../../org/apache/juneau/BeanSession.html#isUseJavaBeanIntrospector--">isUseJavaBeanIntrospector</a>, <a href="../../../org/apache/juneau/BeanSession.html#newBean-java.lang.Class-">newBean</a>, <a href="../../../org/apache/juneau/BeanSession.html#newBean-java.lang.Object-java.lang.Class-">newBean</a>, <a href="../../../org/apache/juneau/BeanSession.html#newBeanMap-java.lang.Class-">newBeanMap</a>, <a href="../../../org/apache/juneau/BeanSession.html#newBeanMap-java.lang.Object-java.lang.Class-">newBeanMap</a>, <a href="../../../org/apache/juneau/BeanSession.html#newGenericMap-org.apache.juneau.ClassMeta-">newGenericMap</a>, <a href="../../../org/apache/juneau/BeanSession.html#object--">object</a>, <a href="../../../org/apache/juneau/BeanSession.html#string--">string</a>, <a href="../../../org/apache/juneau/BeanSession.html#toArray-org.apache.juneau.ClassMeta-java.util.Collection-">toArray</a>, <a href="../../../org/apache/juneau/BeanSession.html#toBeanMap-T-">toBeanMap</a>, <a href="../../../org/apache/juneau/BeanSession.html#toBeanMap-T-java.lang.Class-">toBeanMap</a>, <a href="../../../org/apache/juneau/BeanSession.html#toBeanMap-T-org.apache.juneau.PropertyNamer-">toBeanMap</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.ContextSession"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.juneau.<a href="../../../org/apache/juneau/ContextSession.html" title="class in org.apache.juneau">ContextSession</a></h3> |
| <code><a href="../../../org/apache/juneau/ContextSession.html#checkForWarnings--">checkForWarnings</a>, <a href="../../../org/apache/juneau/ContextSession.html#getContext--">getContext</a>, <a href="../../../org/apache/juneau/ContextSession.html#getSessionProperties--">getSessionProperties</a>, <a href="../../../org/apache/juneau/ContextSession.html#getWarnings--">getWarnings</a>, <a href="../../../org/apache/juneau/ContextSession.html#isDebug--">isDebug</a>, <a href="../../../org/apache/juneau/ContextSession.html#toString--">toString</a></code></li> |
| </ul> |
| <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#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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="indent"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>indent</h4> |
| <pre>public int <a href="../../../src-html/org/apache/juneau/BeanTraverseSession.html#line.159">indent</a></pre> |
| <div class="block">The current indentation depth into the model.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="BeanTraverseSession-org.apache.juneau.BeanTraverseSession.Builder-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>BeanTraverseSession</h4> |
| <pre>protected <a href="../../../src-html/org/apache/juneau/BeanTraverseSession.html#line.168">BeanTraverseSession</a>(<a href="../../../org/apache/juneau/BeanTraverseSession.Builder.html" title="class in org.apache.juneau">BeanTraverseSession.Builder</a> builder)</pre> |
| <div class="block">Constructor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>builder</code> - The builder for this object.</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="setCurrentProperty-org.apache.juneau.BeanPropertyMeta-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCurrentProperty</h4> |
| <pre>protected final void <a href="../../../src-html/org/apache/juneau/BeanTraverseSession.html#line.184">setCurrentProperty</a>(<a href="../../../org/apache/juneau/BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a> currentProperty)</pre> |
| <div class="block">Sets the current bean property being traversed for proper error messages.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>currentProperty</code> - The current property being traversed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCurrentClass-org.apache.juneau.ClassMeta-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCurrentClass</h4> |
| <pre>protected final void <a href="../../../src-html/org/apache/juneau/BeanTraverseSession.html#line.193">setCurrentClass</a>(<a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><?> currentClass)</pre> |
| <div class="block">Sets the current class being traversed for proper error messages.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>currentClass</code> - The current class being traversed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="push-java.lang.String-java.lang.Object-org.apache.juneau.ClassMeta-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>push</h4> |
| <pre>protected final <a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><?> <a href="../../../src-html/org/apache/juneau/BeanTraverseSession.html#line.208">push</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> attrName, |
| <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> o, |
| <a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><?> eType) |
| throws <a href="../../../org/apache/juneau/BeanRecursionException.html" title="class in org.apache.juneau">BeanRecursionException</a></pre> |
| <div class="block">Push the specified object onto the stack.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>attrName</code> - The attribute name.</dd> |
| <dd><code>o</code> - The current object being traversed.</dd> |
| <dd><code>eType</code> - The expected class type.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The <a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau"><code>ClassMeta</code></a> of the object so that <c>instanceof</c> operations only need to be performed |
| once (since they can be expensive).</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/apache/juneau/BeanRecursionException.html" title="class in org.apache.juneau">BeanRecursionException</a></code> - If recursion occurred.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isRoot--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRoot</h4> |
| <pre>protected final boolean <a href="../../../src-html/org/apache/juneau/BeanTraverseSession.html#line.238">isRoot</a>()</pre> |
| <div class="block">Returns <jk>true</jk> if we're processing the root node. |
| |
| <p> |
| Must be called after <a href="../../../org/apache/juneau/BeanTraverseSession.html#push-java.lang.String-java.lang.Object-org.apache.juneau.ClassMeta-"><code>push(String, Object, ClassMeta)</code></a> and before <a href="../../../org/apache/juneau/BeanTraverseSession.html#pop--"><code>pop()</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><jk>true</jk> if we're processing the root node.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="willRecurse-java.lang.String-java.lang.Object-org.apache.juneau.ClassMeta-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>willRecurse</h4> |
| <pre>protected final boolean <a href="../../../src-html/org/apache/juneau/BeanTraverseSession.html#line.252">willRecurse</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> attrName, |
| <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> o, |
| <a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><?> cm) |
| throws <a href="../../../org/apache/juneau/BeanRecursionException.html" title="class in org.apache.juneau">BeanRecursionException</a></pre> |
| <div class="block">Returns <jk>true</jk> if <a href="../../../org/apache/juneau/BeanTraverseContext.Builder.html#detectRecursions--"><code>BeanTraverseContext.Builder.detectRecursions()</code></a> is enabled, and the specified |
| object is already higher up in the traversal chain.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>attrName</code> - The bean property attribute name, or some other identifier.</dd> |
| <dd><code>o</code> - The object to check for recursion.</dd> |
| <dd><code>cm</code> - The metadata on the object class.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><jk>true</jk> if recursion detected.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/apache/juneau/BeanRecursionException.html" title="class in org.apache.juneau">BeanRecursionException</a></code> - If recursion occurred.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="willExceedDepth--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>willExceedDepth</h4> |
| <pre>protected final boolean <a href="../../../src-html/org/apache/juneau/BeanTraverseSession.html#line.267">willExceedDepth</a>()</pre> |
| <div class="block">Returns <jk>true</jk> if we're about to exceed the max depth for the document.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><jk>true</jk> if we're about to exceed the max depth for the document.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="pop--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pop</h4> |
| <pre>protected final void <a href="../../../src-html/org/apache/juneau/BeanTraverseSession.html#line.274">pop</a>()</pre> |
| <div class="block">Pop an object off the stack.</div> |
| </li> |
| </ul> |
| <a name="isOptional-org.apache.juneau.ClassMeta-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOptional</h4> |
| <pre>protected final boolean <a href="../../../src-html/org/apache/juneau/BeanTraverseSession.html#line.292">isOptional</a>(<a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><?> cm)</pre> |
| <div class="block">Same as <a href="../../../org/apache/juneau/ClassMeta.html#isOptional--"><code>ClassMeta.isOptional()</code></a> but gracefully handles a null <a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau"><code>ClassMeta</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cm</code> - The meta to check.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><jk>true</jk> if the specified meta is an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util"><code>Optional</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOptionalType-org.apache.juneau.ClassMeta-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOptionalType</h4> |
| <pre>protected final <a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><?> <a href="../../../src-html/org/apache/juneau/BeanTraverseSession.html#line.302">getOptionalType</a>(<a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><?> cm)</pre> |
| <div class="block">Returns the inner type of an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util"><code>Optional</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cm</code> - The meta to check.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The inner type of an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util"><code>Optional</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOptionalValue-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOptionalValue</h4> |
| <pre>protected final <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> <a href="../../../src-html/org/apache/juneau/BeanTraverseSession.html#line.314">getOptionalValue</a>(<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> o)</pre> |
| <div class="block">If the specified object is an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util"><code>Optional</code></a>, returns the inner object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>o</code> - The object to check.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The inner object if it's an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util"><code>Optional</code></a>, <jk>null</jk> if it's <jk>null</jk>, or else the same object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onError-java.lang.Throwable-java.lang.String-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onError</h4> |
| <pre>protected void <a href="../../../src-html/org/apache/juneau/BeanTraverseSession.html#line.329">onError</a>(<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, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg, |
| <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>... args)</pre> |
| <div class="block">Logs a warning message.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>t</code> - The throwable that was thrown (if there was one).</dd> |
| <dd><code>msg</code> - The warning message.</dd> |
| <dd><code>args</code> - Optional <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true" title="class or interface in java.text"><code>MessageFormat</code></a>-style arguments.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStack-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStack</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../src-html/org/apache/juneau/BeanTraverseSession.html#line.363">getStack</a>(boolean full)</pre> |
| <div class="block">Returns the current stack trace.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>full</code> - If <jk>true</jk>, returns a full stack trace.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The current stack trace.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLastLocation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastLocation</h4> |
| <pre>public final <a href="../../../org/apache/juneau/collections/JsonMap.html" title="class in org.apache.juneau.collections">JsonMap</a> <a href="../../../src-html/org/apache/juneau/BeanTraverseSession.html#line.385">getLastLocation</a>()</pre> |
| <div class="block">Returns information used to determine at what location in the parse a failure occurred.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A map, typically containing something like <c>{line:123,column:456,currentProperty:"foobar"}</c></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isDetectRecursions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDetectRecursions</h4> |
| <pre>public final boolean <a href="../../../src-html/org/apache/juneau/BeanTraverseSession.html#line.405">isDetectRecursions</a>()</pre> |
| <div class="block">Automatically detect POJO recursions.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><jk>true</jk> if recursions should be checked for during traversal.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/apache/juneau/BeanTraverseContext.Builder.html#detectRecursions--"><code>BeanTraverseContext.Builder.detectRecursions()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isIgnoreRecursions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isIgnoreRecursions</h4> |
| <pre>public final boolean <a href="../../../src-html/org/apache/juneau/BeanTraverseSession.html#line.417">isIgnoreRecursions</a>()</pre> |
| <div class="block">Ignore recursion errors.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><jk>true</jk> if when we encounter the same object when traversing a tree, we set the value to <jk>null</jk>. |
| <br>Otherwise, a <a href="../../../org/apache/juneau/BeanRecursionException.html" title="class in org.apache.juneau"><code>BeanRecursionException</code></a> is thrown with the message <js>"Recursion occurred, stack=..."</js>.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/apache/juneau/BeanTraverseContext.Builder.html#ignoreRecursions--"><code>BeanTraverseContext.Builder.ignoreRecursions()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInitialDepth--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInitialDepth</h4> |
| <pre>public final int <a href="../../../src-html/org/apache/juneau/BeanTraverseSession.html#line.428">getInitialDepth</a>()</pre> |
| <div class="block">Initial depth.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The initial indentation level at the root.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/apache/juneau/BeanTraverseContext.Builder.html#initialDepth-int-"><code>BeanTraverseContext.Builder.initialDepth(int)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxDepth--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxDepth</h4> |
| <pre>public final int <a href="../../../src-html/org/apache/juneau/BeanTraverseSession.html#line.440">getMaxDepth</a>()</pre> |
| <div class="block">Max traversal depth.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The depth at which traversal is aborted if depth is reached in the POJO tree. |
| <br>If this depth is exceeded, an exception is thrown.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/apache/juneau/BeanTraverseContext.Builder.html#maxDepth-int-"><code>BeanTraverseContext.Builder.maxDepth(int)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="properties--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>properties</h4> |
| <pre>protected <a href="../../../org/apache/juneau/collections/JsonMap.html" title="class in org.apache.juneau.collections">JsonMap</a> <a href="../../../src-html/org/apache/juneau/BeanTraverseSession.html#line.449">properties</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../org/apache/juneau/ContextSession.html#properties--">ContextSession</a></code></span></div> |
| <div class="block">Returns the properties on this bean as a map for debugging.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../org/apache/juneau/ContextSession.html#properties--">properties</a></code> in class <code><a href="../../../org/apache/juneau/ContextSession.html" title="class in org.apache.juneau">ContextSession</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The properties on this bean as a map for debugging.</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> |
| <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/juneau/BeanTraverseContext.Builder.html" title="class in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/juneau/BeanTraverseSession.Builder.html" title="class in org.apache.juneau"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/juneau/BeanTraverseSession.html" target="_top">Frames</a></li> |
| <li><a href="BeanTraverseSession.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </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><a href="#constructor.detail">Constr</a> | </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 © 2016–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |