| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (18) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.juneau.cp, class: BeanCreateMethodFinder"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">// ***************************************************************************************************************************</span> |
| <span class="source-line-no">002</span><span id="line-2">// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *</span> |
| <span class="source-line-no">003</span><span id="line-3">// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *</span> |
| <span class="source-line-no">004</span><span id="line-4">// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *</span> |
| <span class="source-line-no">005</span><span id="line-5">// * with the License. You may obtain a copy of the License at *</span> |
| <span class="source-line-no">006</span><span id="line-6">// * *</span> |
| <span class="source-line-no">007</span><span id="line-7">// * http://www.apache.org/licenses/LICENSE-2.0 *</span> |
| <span class="source-line-no">008</span><span id="line-8">// * *</span> |
| <span class="source-line-no">009</span><span id="line-9">// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *</span> |
| <span class="source-line-no">010</span><span id="line-10">// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *</span> |
| <span class="source-line-no">011</span><span id="line-11">// * specific language governing permissions and limitations under the License. *</span> |
| <span class="source-line-no">012</span><span id="line-12">// ***************************************************************************************************************************</span> |
| <span class="source-line-no">013</span><span id="line-13">package org.apache.juneau.cp;</span> |
| <span class="source-line-no">014</span><span id="line-14"></span> |
| <span class="source-line-no">015</span><span id="line-15">import static org.apache.juneau.common.internal.ArgUtils.*;</span> |
| <span class="source-line-no">016</span><span id="line-16"></span> |
| <span class="source-line-no">017</span><span id="line-17">import java.util.*;</span> |
| <span class="source-line-no">018</span><span id="line-18">import java.util.function.*;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import org.apache.juneau.*;</span> |
| <span class="source-line-no">021</span><span id="line-21">import org.apache.juneau.annotation.*;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.juneau.reflect.*;</span> |
| <span class="source-line-no">023</span><span id="line-23"></span> |
| <span class="source-line-no">024</span><span id="line-24">/**</span> |
| <span class="source-line-no">025</span><span id="line-25"> * Utility class for creating beans through creator methods.</span> |
| <span class="source-line-no">026</span><span id="line-26"> *</span> |
| <span class="source-line-no">027</span><span id="line-27"> * <p></span> |
| <span class="source-line-no">028</span><span id="line-28"> * Used for finding and invoking methods on an object that take in arbitrary parameters and returns bean instances.</span> |
| <span class="source-line-no">029</span><span id="line-29"> *</span> |
| <span class="source-line-no">030</span><span id="line-30"> * <p></span> |
| <span class="source-line-no">031</span><span id="line-31"> * This class is instantiated through the following methods:</span> |
| <span class="source-line-no">032</span><span id="line-32"> * <ul class='javatree'></span> |
| <span class="source-line-no">033</span><span id="line-33"> * <li class='jc'>{@link BeanStore}</span> |
| <span class="source-line-no">034</span><span id="line-34"> * <ul class='javatreec'></span> |
| <span class="source-line-no">035</span><span id="line-35"> * <li class='jm'>{@link BeanStore#createMethodFinder(Class)}</span> |
| <span class="source-line-no">036</span><span id="line-36"> * <li class='jm'>{@link BeanStore#createMethodFinder(Class,Class)}</span> |
| <span class="source-line-no">037</span><span id="line-37"> * <li class='jm'>{@link BeanStore#createMethodFinder(Class,Object)}</span> |
| <span class="source-line-no">038</span><span id="line-38"> * </ul></span> |
| <span class="source-line-no">039</span><span id="line-39"> * </li></span> |
| <span class="source-line-no">040</span><span id="line-40"> * </ul></span> |
| <span class="source-line-no">041</span><span id="line-41"> *</span> |
| <span class="source-line-no">042</span><span id="line-42"> * <h5 class='section'>Example:</h5></span> |
| <span class="source-line-no">043</span><span id="line-43"> * <p class='bjava'></span> |
| <span class="source-line-no">044</span><span id="line-44"> * <jc>// The bean we want to create.</jc></span> |
| <span class="source-line-no">045</span><span id="line-45"> * <jk>public class</jk> A {}</span> |
| <span class="source-line-no">046</span><span id="line-46"> *</span> |
| <span class="source-line-no">047</span><span id="line-47"> * <jc>// The bean that has a creator method for the bean above.</jc></span> |
| <span class="source-line-no">048</span><span id="line-48"> * <jk>public class</jk> B {</span> |
| <span class="source-line-no">049</span><span id="line-49"> *</span> |
| <span class="source-line-no">050</span><span id="line-50"> * <jc>// Creator method.</jc></span> |
| <span class="source-line-no">051</span><span id="line-51"> * <jc>// Bean store must have a C bean and optionally a D bean.</jc></span> |
| <span class="source-line-no">052</span><span id="line-52"> * <jk>public</jk> A createA(C <jv>c</jv>, Optional&lt;D&gt; <jv>d</jv>) {</span> |
| <span class="source-line-no">053</span><span id="line-53"> * <jk>return new</jk> A(<jv>c</jv>, <jv>d</jv>.orElse(<jk>null</jk>));</span> |
| <span class="source-line-no">054</span><span id="line-54"> * }</span> |
| <span class="source-line-no">055</span><span id="line-55"> * }</span> |
| <span class="source-line-no">056</span><span id="line-56"> *</span> |
| <span class="source-line-no">057</span><span id="line-57"> * <jc>// Instantiate the bean with the creator method.</jc></span> |
| <span class="source-line-no">058</span><span id="line-58"> * B <mv>b</mv> = <jk>new</jk> B();</span> |
| <span class="source-line-no">059</span><span id="line-59"> *</span> |
| <span class="source-line-no">060</span><span id="line-60"> * <jc>// Create a bean store with some mapped beans.</jc></span> |
| <span class="source-line-no">061</span><span id="line-61"> * BeanStore <mv>beanStore</mv> = BeanStore.<jsm>create</jsm>().addBean(C.<jk>class</jk>, <jk>new</jk> C());</span> |
| <span class="source-line-no">062</span><span id="line-62"> *</span> |
| <span class="source-line-no">063</span><span id="line-63"> * <jc>// Instantiate the bean using the creator method.</jc></span> |
| <span class="source-line-no">064</span><span id="line-64"> * A <mv>a</mv> = <mv>beanStore</mv></span> |
| <span class="source-line-no">065</span><span id="line-65"> * .createMethodFinder(A.<jk>class</jk>, <mv>b</mv>) <jc>// Looking for creator for A on b object.</jc></span> |
| <span class="source-line-no">066</span><span id="line-66"> * .find(<js>"createA"</js>) <jc>// Look for method called "createA".</jc></span> |
| <span class="source-line-no">067</span><span id="line-67"> * .thenFind(<js>"createA2"</js>) <jc>// Then look for method called "createA2".</jc></span> |
| <span class="source-line-no">068</span><span id="line-68"> * .withDefault(()-&gt;<jk>new</jk> A()) <jc>// Optionally supply a default value if method not found.</jc></span> |
| <span class="source-line-no">069</span><span id="line-69"> * .run(); <jc>// Execute.</jc></span> |
| <span class="source-line-no">070</span><span id="line-70"> * </p></span> |
| <span class="source-line-no">071</span><span id="line-71"> *</span> |
| <span class="source-line-no">072</span><span id="line-72"> * <h5 class='section'>See Also:</h5><ul></span> |
| <span class="source-line-no">073</span><span id="line-73"> * <li class='jc'>{@link BeanStore}</span> |
| <span class="source-line-no">074</span><span id="line-74"> * </ul></span> |
| <span class="source-line-no">075</span><span id="line-75"> *</span> |
| <span class="source-line-no">076</span><span id="line-76"> * @param <T> The bean type being created.</span> |
| <span class="source-line-no">077</span><span id="line-77"> */</span> |
| <span class="source-line-no">078</span><span id="line-78">public class BeanCreateMethodFinder<T> {</span> |
| <span class="source-line-no">079</span><span id="line-79"></span> |
| <span class="source-line-no">080</span><span id="line-80"> private Class<T> beanType;</span> |
| <span class="source-line-no">081</span><span id="line-81"> private final Class<?> resourceClass;</span> |
| <span class="source-line-no">082</span><span id="line-82"> private final Object resource;</span> |
| <span class="source-line-no">083</span><span id="line-83"> private final BeanStore beanStore;</span> |
| <span class="source-line-no">084</span><span id="line-84"></span> |
| <span class="source-line-no">085</span><span id="line-85"> private MethodInfo method;</span> |
| <span class="source-line-no">086</span><span id="line-86"> private Object[] args;</span> |
| <span class="source-line-no">087</span><span id="line-87"></span> |
| <span class="source-line-no">088</span><span id="line-88"> private Supplier<T> def = ()->null;</span> |
| <span class="source-line-no">089</span><span id="line-89"></span> |
| <span class="source-line-no">090</span><span id="line-90"> BeanCreateMethodFinder(Class<T> beanType, Object resource, BeanStore beanStore) {</span> |
| <span class="source-line-no">091</span><span id="line-91"> this.beanType = assertArgNotNull("beanType", beanType);</span> |
| <span class="source-line-no">092</span><span id="line-92"> this.resource = assertArgNotNull("resource", resource);</span> |
| <span class="source-line-no">093</span><span id="line-93"> this.resourceClass = resource.getClass();</span> |
| <span class="source-line-no">094</span><span id="line-94"> this.beanStore = BeanStore.of(beanStore, resource);</span> |
| <span class="source-line-no">095</span><span id="line-95"> }</span> |
| <span class="source-line-no">096</span><span id="line-96"></span> |
| <span class="source-line-no">097</span><span id="line-97"> BeanCreateMethodFinder(Class<T> beanType, Class<?> resourceClass, BeanStore beanStore) {</span> |
| <span class="source-line-no">098</span><span id="line-98"> this.beanType = assertArgNotNull("beanType", beanType);</span> |
| <span class="source-line-no">099</span><span id="line-99"> this.resource = null;</span> |
| <span class="source-line-no">100</span><span id="line-100"> this.resourceClass = assertArgNotNull("resourceClass", resourceClass);</span> |
| <span class="source-line-no">101</span><span id="line-101"> this.beanStore = BeanStore.of(beanStore);</span> |
| <span class="source-line-no">102</span><span id="line-102"> }</span> |
| <span class="source-line-no">103</span><span id="line-103"></span> |
| <span class="source-line-no">104</span><span id="line-104"> /**</span> |
| <span class="source-line-no">105</span><span id="line-105"> * Adds a bean to the lookup for parameters.</span> |
| <span class="source-line-no">106</span><span id="line-106"> *</span> |
| <span class="source-line-no">107</span><span id="line-107"> * @param <T2> The bean type.</span> |
| <span class="source-line-no">108</span><span id="line-108"> * @param c The bean type.</span> |
| <span class="source-line-no">109</span><span id="line-109"> * @param t The bean.</span> |
| <span class="source-line-no">110</span><span id="line-110"> * @return This object.</span> |
| <span class="source-line-no">111</span><span id="line-111"> */</span> |
| <span class="source-line-no">112</span><span id="line-112"> public <T2> BeanCreateMethodFinder<T> addBean(Class<T2> c, T2 t) {</span> |
| <span class="source-line-no">113</span><span id="line-113"> beanStore.addBean(c, t);</span> |
| <span class="source-line-no">114</span><span id="line-114"> return this;</span> |
| <span class="source-line-no">115</span><span id="line-115"> }</span> |
| <span class="source-line-no">116</span><span id="line-116"></span> |
| <span class="source-line-no">117</span><span id="line-117"> /**</span> |
| <span class="source-line-no">118</span><span id="line-118"> * Find the method matching the specified predicate.</span> |
| <span class="source-line-no">119</span><span id="line-119"> *</span> |
| <span class="source-line-no">120</span><span id="line-120"> * <p></span> |
| <span class="source-line-no">121</span><span id="line-121"> * In order for the method to be used, it must adhere to the following restrictions:</span> |
| <span class="source-line-no">122</span><span id="line-122"> * <ul></span> |
| <span class="source-line-no">123</span><span id="line-123"> * <li>The method must be public.</span> |
| <span class="source-line-no">124</span><span id="line-124"> * <li>The method can be static.</span> |
| <span class="source-line-no">125</span><span id="line-125"> * <li>The method name must match exactly.</span> |
| <span class="source-line-no">126</span><span id="line-126"> * <li>The method must not be deprecated or annotated with {@link BeanIgnore}.</span> |
| <span class="source-line-no">127</span><span id="line-127"> * <li>The method must have all parameter types specified in <c>requiredParams</c>.</span> |
| <span class="source-line-no">128</span><span id="line-128"> * <li>The bean store must contain beans for all parameter types.</span> |
| <span class="source-line-no">129</span><span id="line-129"> * <li>The bean store may contain beans for all {@link Optional} parameter types.</span> |
| <span class="source-line-no">130</span><span id="line-130"> * </ul></span> |
| <span class="source-line-no">131</span><span id="line-131"> *</span> |
| <span class="source-line-no">132</span><span id="line-132"> * <p></span> |
| <span class="source-line-no">133</span><span id="line-133"> * This method can be called multiple times with different method names or required parameters until a match is found.</span> |
| <span class="source-line-no">134</span><span id="line-134"> * <br>Once a method is found, subsequent calls to this method will be no-ops.</span> |
| <span class="source-line-no">135</span><span id="line-135"> *</span> |
| <span class="source-line-no">136</span><span id="line-136"> * See {@link BeanStore#createMethodFinder(Class, Object)} for usage.</span> |
| <span class="source-line-no">137</span><span id="line-137"> *</span> |
| <span class="source-line-no">138</span><span id="line-138"> * @param filter The predicate to apply.</span> |
| <span class="source-line-no">139</span><span id="line-139"> * @return This object.</span> |
| <span class="source-line-no">140</span><span id="line-140"> */</span> |
| <span class="source-line-no">141</span><span id="line-141"> public BeanCreateMethodFinder<T> find(Predicate<MethodInfo> filter) {</span> |
| <span class="source-line-no">142</span><span id="line-142"> if (method == null) {</span> |
| <span class="source-line-no">143</span><span id="line-143"> method = ClassInfo.of(resourceClass).getPublicMethod(</span> |
| <span class="source-line-no">144</span><span id="line-144"> x -> x.isNotDeprecated()</span> |
| <span class="source-line-no">145</span><span id="line-145"> && x.hasReturnType(beanType)</span> |
| <span class="source-line-no">146</span><span id="line-146"> && x.hasNoAnnotation(BeanIgnore.class)</span> |
| <span class="source-line-no">147</span><span id="line-147"> && filter.test(x)</span> |
| <span class="source-line-no">148</span><span id="line-148"> && beanStore.hasAllParams(x)</span> |
| <span class="source-line-no">149</span><span id="line-149"> && (x.isStatic() || resource != null)</span> |
| <span class="source-line-no">150</span><span id="line-150"> );</span> |
| <span class="source-line-no">151</span><span id="line-151"> if (method != null)</span> |
| <span class="source-line-no">152</span><span id="line-152"> args = beanStore.getParams(method);</span> |
| <span class="source-line-no">153</span><span id="line-153"> }</span> |
| <span class="source-line-no">154</span><span id="line-154"> return this;</span> |
| <span class="source-line-no">155</span><span id="line-155"> }</span> |
| <span class="source-line-no">156</span><span id="line-156"></span> |
| <span class="source-line-no">157</span><span id="line-157"> /**</span> |
| <span class="source-line-no">158</span><span id="line-158"> * Shortcut for calling <c>find(<jv>x</jv> -&gt; <jv>x</jv>.hasName(<jv>methodName</jv>))</c>.</span> |
| <span class="source-line-no">159</span><span id="line-159"> *</span> |
| <span class="source-line-no">160</span><span id="line-160"> * @param methodName The method name to match.</span> |
| <span class="source-line-no">161</span><span id="line-161"> * @return This object.</span> |
| <span class="source-line-no">162</span><span id="line-162"> */</span> |
| <span class="source-line-no">163</span><span id="line-163"> public BeanCreateMethodFinder<T> find(String methodName) {</span> |
| <span class="source-line-no">164</span><span id="line-164"> return find(x -> x.hasName(methodName));</span> |
| <span class="source-line-no">165</span><span id="line-165"> }</span> |
| <span class="source-line-no">166</span><span id="line-166"></span> |
| <span class="source-line-no">167</span><span id="line-167"> /**</span> |
| <span class="source-line-no">168</span><span id="line-168"> * Identical to {@link #find(Predicate)} but named for fluent-style calls.</span> |
| <span class="source-line-no">169</span><span id="line-169"> *</span> |
| <span class="source-line-no">170</span><span id="line-170"> * @param filter The predicate to apply.</span> |
| <span class="source-line-no">171</span><span id="line-171"> * @return This object.</span> |
| <span class="source-line-no">172</span><span id="line-172"> */</span> |
| <span class="source-line-no">173</span><span id="line-173"> public BeanCreateMethodFinder<T> thenFind(Predicate<MethodInfo> filter) {</span> |
| <span class="source-line-no">174</span><span id="line-174"> return find(filter);</span> |
| <span class="source-line-no">175</span><span id="line-175"> }</span> |
| <span class="source-line-no">176</span><span id="line-176"></span> |
| <span class="source-line-no">177</span><span id="line-177"> /**</span> |
| <span class="source-line-no">178</span><span id="line-178"> * Identical to {@link #find(Predicate)} but named for fluent-style calls.</span> |
| <span class="source-line-no">179</span><span id="line-179"> *</span> |
| <span class="source-line-no">180</span><span id="line-180"> * @param methodName The method name to match.</span> |
| <span class="source-line-no">181</span><span id="line-181"> * @return This object.</span> |
| <span class="source-line-no">182</span><span id="line-182"> */</span> |
| <span class="source-line-no">183</span><span id="line-183"> public BeanCreateMethodFinder<T> thenFind(String methodName) {</span> |
| <span class="source-line-no">184</span><span id="line-184"> return find(methodName);</span> |
| <span class="source-line-no">185</span><span id="line-185"> }</span> |
| <span class="source-line-no">186</span><span id="line-186"></span> |
| <span class="source-line-no">187</span><span id="line-187"> /**</span> |
| <span class="source-line-no">188</span><span id="line-188"> * A default value to return if no matching methods were found.</span> |
| <span class="source-line-no">189</span><span id="line-189"> *</span> |
| <span class="source-line-no">190</span><span id="line-190"> * @param def The default value. Can be <jk>null</jk>.</span> |
| <span class="source-line-no">191</span><span id="line-191"> * @return This object.</span> |
| <span class="source-line-no">192</span><span id="line-192"> */</span> |
| <span class="source-line-no">193</span><span id="line-193"> public BeanCreateMethodFinder<T> withDefault(T def) {</span> |
| <span class="source-line-no">194</span><span id="line-194"> return withDefault(()->def);</span> |
| <span class="source-line-no">195</span><span id="line-195"> }</span> |
| <span class="source-line-no">196</span><span id="line-196"></span> |
| <span class="source-line-no">197</span><span id="line-197"> /**</span> |
| <span class="source-line-no">198</span><span id="line-198"> * A default value to return if no matching methods were found.</span> |
| <span class="source-line-no">199</span><span id="line-199"> *</span> |
| <span class="source-line-no">200</span><span id="line-200"> * @param def The default value.</span> |
| <span class="source-line-no">201</span><span id="line-201"> * @return This object.</span> |
| <span class="source-line-no">202</span><span id="line-202"> */</span> |
| <span class="source-line-no">203</span><span id="line-203"> public BeanCreateMethodFinder<T> withDefault(Supplier<T> def) {</span> |
| <span class="source-line-no">204</span><span id="line-204"> assertArgNotNull("def", def);</span> |
| <span class="source-line-no">205</span><span id="line-205"> this.def = def;</span> |
| <span class="source-line-no">206</span><span id="line-206"> return this;</span> |
| <span class="source-line-no">207</span><span id="line-207"> }</span> |
| <span class="source-line-no">208</span><span id="line-208"></span> |
| <span class="source-line-no">209</span><span id="line-209"> /**</span> |
| <span class="source-line-no">210</span><span id="line-210"> * Executes the matched method and returns the result.</span> |
| <span class="source-line-no">211</span><span id="line-211"> *</span> |
| <span class="source-line-no">212</span><span id="line-212"> * @return The object returned by the method invocation, or the default value if method was not found.</span> |
| <span class="source-line-no">213</span><span id="line-213"> * @throws ExecutableException If method invocation threw an exception.</span> |
| <span class="source-line-no">214</span><span id="line-214"> */</span> |
| <span class="source-line-no">215</span><span id="line-215"> @SuppressWarnings("unchecked")</span> |
| <span class="source-line-no">216</span><span id="line-216"> public T run() throws ExecutableException {</span> |
| <span class="source-line-no">217</span><span id="line-217"> if (method != null)</span> |
| <span class="source-line-no">218</span><span id="line-218"> return (T)method.invoke(resource, args);</span> |
| <span class="source-line-no">219</span><span id="line-219"> return def.get();</span> |
| <span class="source-line-no">220</span><span id="line-220"> }</span> |
| <span class="source-line-no">221</span><span id="line-221"></span> |
| <span class="source-line-no">222</span><span id="line-222"> /**</span> |
| <span class="source-line-no">223</span><span id="line-223"> * Same as {@link #run()} but also executes a consumer if the returned value was not <jk>null</jk>.</span> |
| <span class="source-line-no">224</span><span id="line-224"> *</span> |
| <span class="source-line-no">225</span><span id="line-225"> * @param consumer The consumer of the response.</span> |
| <span class="source-line-no">226</span><span id="line-226"> * @return The object returned by the method invocation, or the default value if method was not found, or {@link Optional#empty()}.</span> |
| <span class="source-line-no">227</span><span id="line-227"> * @throws ExecutableException If method invocation threw an exception.</span> |
| <span class="source-line-no">228</span><span id="line-228"> */</span> |
| <span class="source-line-no">229</span><span id="line-229"> public T run(Consumer<? super T> consumer) throws ExecutableException {</span> |
| <span class="source-line-no">230</span><span id="line-230"> T t = run();</span> |
| <span class="source-line-no">231</span><span id="line-231"> if (t != null)</span> |
| <span class="source-line-no">232</span><span id="line-232"> consumer.accept(t);</span> |
| <span class="source-line-no">233</span><span id="line-233"> return t;</span> |
| <span class="source-line-no">234</span><span id="line-234"> }</span> |
| <span class="source-line-no">235</span><span id="line-235">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
