| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>BeanMeta (Apache Juneau 9.0.0)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.juneau, class: BeanMeta"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../javadoc.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| <script type="text/javascript" src="../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="class-declaration"> |
| <script type="text/javascript">var data = {"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}; |
| 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"; |
| var pathtoroot = "../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flexBox"> |
| <header role="banner" class="flexHeader"> |
| <nav role="navigation"> |
| <!-- ========= 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="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"> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </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> |
| <div class="navListSearch"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="skipNav"><a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| </nav> |
| </header> |
| <div class="flexContent"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.juneau</a></div> |
| <h1 title="Class BeanMeta" class="title">Class BeanMeta<T></h1> |
| </div> |
| <div class="contentContainer"> |
| <div class="inheritance" title="Inheritance Tree">java.lang.Object |
| <div class="inheritance">org.apache.juneau.BeanMeta<T></div> |
| </div> |
| <section class="description"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The class type that this metadata applies to.</dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="BeanMetaFiltered.html" title="class in org.apache.juneau">BeanMetaFiltered</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.63">BeanMeta</a><T> |
| extends java.lang.Object</pre> |
| <div class="block">Encapsulates all access to the properties of a bean class (like a souped-up <code>BeanInfo</code>). |
| |
| <h5 class='topic'>Description</h5> |
| |
| Uses introspection to find all the properties associated with this class. If the <a href="annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotation |
| is present on the class, then that information is used to determine the properties on the class. |
| Otherwise, the <code>BeanInfo</code> functionality in Java is used to determine the properties on the class. |
| |
| <h5 class='topic'>Bean property ordering</h5> |
| |
| The order of the properties are as follows: |
| <ul class='spaced-list'> |
| <li> |
| If <a href="annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotation is specified on class, then the order is the same as the list of properties |
| in the annotation. |
| <li> |
| If <a href="annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotation is not specified on the class, then the order is based on the following. |
| <ul> |
| <li>Public fields (same order as <code>Class.getFields()</code>). |
| <li>Properties returned by <code>BeanInfo.getPropertyDescriptors()</code>. |
| <li>Non-standard getters/setters with <a href="annotation/Beanp.html" title="annotation in org.apache.juneau.annotation"><code>@Beanp</code></a> annotation defined on them. |
| </ul> |
| </ul> |
| |
| <ul class='seealso'> |
| |
| </ul></div> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="fieldSummary"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h2>Field Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="BeanFilter.html" title="class in org.apache.juneau">BeanFilter</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#beanFilter">beanFilter</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Optional bean filter associated with the target class.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected java.lang.Class<<a href="BeanMeta.html" title="type parameter in BeanMeta">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#c">c</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The target class that this meta object describes.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><<a href="BeanMeta.html" title="type parameter in BeanMeta">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#classMeta">classMeta</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The target class type that this meta object describes.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="reflect/ConstructorInfo.html" title="class in org.apache.juneau.reflect">ConstructorInfo</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#constructor">constructor</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The constructor for this bean.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#constructorArgs">constructorArgs</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">For beans with constructors with Beanc annotation, this is the list of constructor arg properties.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="BeanContext.html" title="class in org.apache.juneau">BeanContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ctx">ctx</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The bean context that created this metadata object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.util.Map<java.lang.reflect.Method,​java.lang.String></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getterProps">getterProps</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The getter properties on the target class.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected java.util.Map<java.lang.String,​<a href="BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hiddenProperties">hiddenProperties</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The hidden properties on the target class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.util.Map<java.lang.String,​<a href="BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#properties">properties</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The properties on the target class.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#propertyArray">propertyArray</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The properties on the target class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.util.Map<java.lang.reflect.Method,​java.lang.String></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setterProps">setterProps</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The setter properties on the target class.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected java.util.Map<java.lang.Class<?>,​java.lang.Class<?>[]></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#typeVarImpls">typeVarImpls</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Type variables implemented by this bean.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li class="blockList"> |
| <section class="constructorSummary"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h2>Constructor Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colSecond" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.juneau.ClassMeta,org.apache.juneau.BeanContext,org.apache.juneau.BeanFilter,java.lang.String%5B%5D,org.apache.juneau.reflect.ConstructorInfo)">BeanMeta</a></span>​(<a href="ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><<a href="BeanMeta.html" title="type parameter in BeanMeta">T</a>> classMeta, |
| <a href="BeanContext.html" title="class in org.apache.juneau">BeanContext</a> ctx, |
| <a href="BeanFilter.html" title="class in org.apache.juneau">BeanFilter</a> beanFilter, |
| java.lang.String[] pNames, |
| <a href="reflect/ConstructorInfo.html" title="class in org.apache.juneau.reflect">ConstructorInfo</a> implClassConstructor)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructor.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <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> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>​(java.lang.Object o)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code><T2> java.util.Optional<T2></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#firstProperty(java.util.function.Predicate,java.util.function.Function)">firstProperty</a></span>​(java.util.function.Predicate<<a href="BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a>> filter, |
| java.util.function.Function<<a href="BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a>,​T2> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Performs a function on the first property that matches the specified filter.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forEachProperty(java.util.function.Predicate,java.util.function.Consumer)">forEachProperty</a></span>​(java.util.function.Predicate<<a href="BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a>> filter, |
| java.util.function.Consumer<<a href="BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a>> action)</code></th> |
| <td class="colLast"> |
| <div class="block">Performs an action on all matching properties.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code><a href="ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><<a href="BeanMeta.html" title="type parameter in BeanMeta">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getClassMeta()">getClassMeta</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the <a href="ClassMeta.html" title="class in org.apache.juneau"><code>ClassMeta</code></a> of this bean.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDictionaryName()">getDictionaryName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the dictionary name for this bean as defined through the <a href="annotation/Bean.html#typeName()"><code>@Bean(typeName)</code></a> annotation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code><a href="BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPropertyMeta(java.lang.String)">getPropertyMeta</a></span>​(java.lang.String name)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns metadata about the specified property.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code>java.util.Collection<<a href="BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPropertyMetas()">getPropertyMetas</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the metadata on all properties associated with this bean.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <td class="colFirst"><code><a href="BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTypeProperty()">getTypeProperty</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a mock bean property that resolves to the name <js>"_type"</js> and whose value always resolves to the |
| dictionary name of the bean.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i9"> |
| <td class="colFirst"><code>protected <a href="BeanMeta.html" title="type parameter in BeanMeta">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newBean(java.lang.Object)">newBean</a></span>​(java.lang.Object outer)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new instance of this bean.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i10"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onReadProperty(java.lang.Object,java.lang.String,java.lang.Object)">onReadProperty</a></span>​(java.lang.Object bean, |
| java.lang.String name, |
| java.lang.Object value)</code></th> |
| <td class="colLast"> |
| <div class="block">Property read interceptor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i11"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onWriteProperty(java.lang.Object,java.lang.String,java.lang.Object)">onWriteProperty</a></span>​(java.lang.Object bean, |
| java.lang.String name, |
| java.lang.Object value)</code></th> |
| <td class="colLast"> |
| <div class="block">Property write interceptor.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i12"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a><code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li class="blockList"> |
| <section class="fieldDetails"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h2>Field Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="classMeta">classMeta</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected final</span> <span class="returnType"><a href="ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><<a href="BeanMeta.html" title="type parameter in BeanMeta">T</a>></span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.68">classMeta</a></span></div> |
| <div class="block">The target class type that this meta object describes.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="c">c</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected final</span> <span class="returnType">java.lang.Class<<a href="BeanMeta.html" title="type parameter in BeanMeta">T</a>></span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.71">c</a></span></div> |
| <div class="block">The target class that this meta object describes.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="properties">properties</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected final</span> <span class="returnType">java.util.Map<java.lang.String,​<a href="BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a>></span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.74">properties</a></span></div> |
| <div class="block">The properties on the target class.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="propertyArray">propertyArray</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected final</span> <span class="returnType"><a href="BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a>[]</span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.77">propertyArray</a></span></div> |
| <div class="block">The properties on the target class.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="hiddenProperties">hiddenProperties</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected final</span> <span class="returnType">java.util.Map<java.lang.String,​<a href="BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a>></span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.80">hiddenProperties</a></span></div> |
| <div class="block">The hidden properties on the target class.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getterProps">getterProps</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected final</span> <span class="returnType">java.util.Map<java.lang.reflect.Method,​java.lang.String></span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.83">getterProps</a></span></div> |
| <div class="block">The getter properties on the target class.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setterProps">setterProps</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected final</span> <span class="returnType">java.util.Map<java.lang.reflect.Method,​java.lang.String></span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.86">setterProps</a></span></div> |
| <div class="block">The setter properties on the target class.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="ctx">ctx</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected final</span> <span class="returnType"><a href="BeanContext.html" title="class in org.apache.juneau">BeanContext</a></span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.89">ctx</a></span></div> |
| <div class="block">The bean context that created this metadata object.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="beanFilter">beanFilter</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected final</span> <span class="returnType"><a href="BeanFilter.html" title="class in org.apache.juneau">BeanFilter</a></span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.92">beanFilter</a></span></div> |
| <div class="block">Optional bean filter associated with the target class.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="typeVarImpls">typeVarImpls</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected final</span> <span class="returnType">java.util.Map<java.lang.Class<?>,​java.lang.Class<?>[]></span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.95">typeVarImpls</a></span></div> |
| <div class="block">Type variables implemented by this bean.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="constructor">constructor</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected final</span> <span class="returnType"><a href="reflect/ConstructorInfo.html" title="class in org.apache.juneau.reflect">ConstructorInfo</a></span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.98">constructor</a></span></div> |
| <div class="block">The constructor for this bean.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="constructorArgs">constructorArgs</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected final</span> <span class="returnType">java.lang.String[]</span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.101">constructorArgs</a></span></div> |
| <div class="block">For beans with constructors with Beanc annotation, this is the list of constructor arg properties.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li class="blockList"> |
| <section class="constructorDetails"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h2>Constructor Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>(org.apache.juneau.ClassMeta,org.apache.juneau.BeanContext,org.apache.juneau.BeanFilter,java.lang.String[],org.apache.juneau.reflect.ConstructorInfo)">BeanMeta</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.122">BeanMeta</a></span>​(<span class="arguments"><a href="ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><<a href="BeanMeta.html" title="type parameter in BeanMeta">T</a>> classMeta, |
| <a href="BeanContext.html" title="class in org.apache.juneau">BeanContext</a> ctx, |
| <a href="BeanFilter.html" title="class in org.apache.juneau">BeanFilter</a> beanFilter, |
| java.lang.String[] pNames, |
| <a href="reflect/ConstructorInfo.html" title="class in org.apache.juneau.reflect">ConstructorInfo</a> implClassConstructor)</span></div> |
| <div class="block">Constructor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>classMeta</code> - The target class.</dd> |
| <dd><code>ctx</code> - The bean context that created this object.</dd> |
| <dd><code>beanFilter</code> - Optional bean filter associated with the target class. Can be <jk>null</jk>.</dd> |
| <dd><code>pNames</code> - Explicit list of property names and order of properties. If <jk>null</jk>, determine automatically.</dd> |
| <dd><code>implClassConstructor</code> - The constructor to use if one cannot be found. Can be <jk>null</jk>.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getClassMeta()">getClassMeta</a></h3> |
| <div class="memberSignature"><span class="modifiers">public final</span> <span class="returnType"><a href="ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><<a href="BeanMeta.html" title="type parameter in BeanMeta">T</a>></span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.552">getClassMeta</a></span>()</div> |
| <div class="block">Returns the <a href="ClassMeta.html" title="class in org.apache.juneau"><code>ClassMeta</code></a> of this bean.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The <a href="ClassMeta.html" title="class in org.apache.juneau"><code>ClassMeta</code></a> of this bean.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getDictionaryName()">getDictionaryName</a></h3> |
| <div class="memberSignature"><span class="modifiers">public final</span> <span class="returnType">java.lang.String</span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.561">getDictionaryName</a></span>()</div> |
| <div class="block">Returns the dictionary name for this bean as defined through the <a href="annotation/Bean.html#typeName()"><code>@Bean(typeName)</code></a> annotation.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The dictionary name for this bean, or <jk>null</jk> if it has no dictionary name defined.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getTypeProperty()">getTypeProperty</a></h3> |
| <div class="memberSignature"><span class="modifiers">public final</span> <span class="returnType"><a href="BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a></span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.571">getTypeProperty</a></span>()</div> |
| <div class="block">Returns a mock bean property that resolves to the name <js>"_type"</js> and whose value always resolves to the |
| dictionary name of the bean.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The type name property.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getPropertyMetas()">getPropertyMetas</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">java.util.Collection<<a href="BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a>></span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.810">getPropertyMetas</a></span>()</div> |
| <div class="block">Returns the metadata on all properties associated with this bean.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata on all properties associated with this bean.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="forEachProperty(java.util.function.Predicate,java.util.function.Consumer)">forEachProperty</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.820">forEachProperty</a></span>​(<span class="arguments">java.util.function.Predicate<<a href="BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a>> filter, |
| java.util.function.Consumer<<a href="BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a>> action)</span></div> |
| <div class="block">Performs an action on all matching properties.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filter</code> - The filter to apply.</dd> |
| <dd><code>action</code> - The action to apply.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="firstProperty(java.util.function.Predicate,java.util.function.Function)">firstProperty</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="typeParameters"><T2></span> <span class="returnType">java.util.Optional<T2></span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.834">firstProperty</a></span>​(<span class="arguments">java.util.function.Predicate<<a href="BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a>> filter, |
| java.util.function.Function<<a href="BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a>,​T2> function)</span></div> |
| <div class="block">Performs a function on the first property that matches the specified filter.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T2</code> - The type to convert the property to.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filter</code> - The filter to apply.</dd> |
| <dd><code>function</code> - The function to apply to the matching property.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The result of the function. Never <jk>null</jk>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getPropertyMeta(java.lang.String)">getPropertyMeta</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a></span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.847">getPropertyMeta</a></span>​(<span class="arguments">java.lang.String name)</span></div> |
| <div class="block">Returns metadata about the specified property.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of the property on this bean.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The metadata about the property, or <jk>null</jk> if no such property exists on this bean.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="newBean(java.lang.Object)">newBean</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="BeanMeta.html" title="type parameter in BeanMeta">T</a></span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.863">newBean</a></span>​(<span class="arguments">java.lang.Object outer)</span> |
| throws <span class="exceptions"><a href="ExecutableException.html" title="class in org.apache.juneau">ExecutableException</a></span></div> |
| <div class="block">Creates a new instance of this bean.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>outer</code> - The outer object if bean class is a non-static inner member class.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new instance of this bean if possible, or <jk>null</jk> if not.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ExecutableException.html" title="class in org.apache.juneau">ExecutableException</a></code> - Exception occurred on invoked constructor/method/field.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="onReadProperty(java.lang.Object,java.lang.String,java.lang.Object)">onReadProperty</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">java.lang.Object</span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.953">onReadProperty</a></span>​(<span class="arguments">java.lang.Object bean, |
| java.lang.String name, |
| java.lang.Object value)</span></div> |
| <div class="block">Property read interceptor. |
| |
| <p> |
| Called immediately after calling the getter to allow the value to be overridden.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bean</code> - The bean from which the property was read.</dd> |
| <dd><code>name</code> - The property name.</dd> |
| <dd><code>value</code> - The value just extracted from calling the bean getter.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The value to serialize. Default is just to return the existing value.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="onWriteProperty(java.lang.Object,java.lang.String,java.lang.Object)">onWriteProperty</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">java.lang.Object</span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.968">onWriteProperty</a></span>​(<span class="arguments">java.lang.Object bean, |
| java.lang.String name, |
| java.lang.Object value)</span></div> |
| <div class="block">Property write interceptor. |
| |
| <p> |
| Called immediately before calling theh setter to allow value to be overwridden.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bean</code> - The bean from which the property was read.</dd> |
| <dd><code>name</code> - The property name.</dd> |
| <dd><code>value</code> - The value just parsed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The value to serialize. Default is just to return the existing value.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toString()">toString</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">java.lang.String</span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.989">toString</a></span>()</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="hashCode()">hashCode</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">int</span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.999">hashCode</a></span>()</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="equals(java.lang.Object)">equals</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName"><a href="../../../src-html/org/apache/juneau/BeanMeta.html#line.1004">equals</a></span>​(<span class="arguments">java.lang.Object o)</span></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>equals</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <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="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"> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </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> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2016–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
