forked from ebean-orm/ebean-orm.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathconstructors.html
More file actions
391 lines (311 loc) · 22.7 KB
/
constructors.html
File metadata and controls
391 lines (311 loc) · 22.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta id="layout-head" />
<title>Documentation</title>
<link rel="shortcut icon" href="/images/favicon.ico" >
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.1.0/css/all.css" integrity="sha384-lKuwvrZot6UHsBSfcMvOkWwlCMgc0TaWr+30HWe3a4ltaBwTZhyTEggF5tJv8tbt" crossorigin="anonymous">
<link rel="stylesheet" href="/css/pygments.css" type="text/css" />
<link rel="stylesheet" href="/css/site.css">
</head>
<body>
<div id="wrap">
<div id="header">
<div class="navbar" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".mobile-nav">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">
<img src="/images/lg5-21x100.png" height="35">
</a>
</div>
<div class="collapse navbar-collapse">
<ul class="nav navbar-nav pull-right nav-btn-rhs">
<li ><a href="/"><span class="fas fa-home"></span> Home</a></li>
<li class="active"><a href="/docs">Docs</a></li>
<li ><a href="/docs/getting-started">Get Started</a></li>
<li ><a href="/support">Help</a></li>
<li ><a href="/videos">Videos</a></li>
<li ><a target="_blank" href="/apidoc/11">ApiDocs</a></li>
<li ><a href="/releases">Releases</a></li>
<li><a target="_blank" href="https://github.com/ebean-orm/ebean"> <i class="fab fa-github"></i></a></li>
</ul>
</div>
<div class="mobile-nav">
<ul class="nav navbar-nav pull-right nav-btn-rhs">
<li ><a href="/"><span class="fas fa-home"></span> Home</a></li>
<li class="active"><a href="/docs">Docs</a></li>
<li ><a href="/docs/getting-started">Get Started</a></li>
<li ><a href="/support">Help</a></li>
<li ><a href="/videos">Videos</a></li>
<li ><a target="_blank" href="/apidoc/11">ApiDocs</a></li>
<li ><a href="/releases">Releases</a></li>
<li><a target="_blank" href="https://github.com/ebean-orm/ebean"> <i class="fab fa-github"></i></a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="main">
<div class="jumbotron mini">
<div class="container">
<h1><a href="/docs/">Documentation</a> / <a href="/docs/mapping">Mapping</a> / Constuctors</h1>
</div>
</div>
<div class="container doc-index bs-docs-container">
<div class="row">
<div class="col-md-9" role="main">
<form action="https://www.google.com/search" method="get">
<div class="page-inline-search" style="margin-bottom:8px;">
<div class="input-group">
<input name="q" id="searchinput" type="text" class="form-control" placeholder="Search... (press 's' to focus)" data-placeholder-focus="Search... (use '↑', '↓' and '⏎' to select results)" data-placeholder-blur="Search... (press 's' to focus)" autocomplete="off">
<input type="hidden" name="as_sitesearch" value="ebean.io">
<div class="input-group-btn">
<button class="btn btn-default form-control" type="submit"><i class="glyphicon glyphicon-search"></i></button>
</div>
</div>
<div class="search-results-inline-container" style="display: none;">
<ul id="search-results-container" class="search-results"><li class=" active"><a href="/docs" title="Docs"><span style="color:#777;">Docs</span> Documentation </a></li><li class=""><small style="color:#999;">And 101 more...</small></li></ul>
</div>
</div>
</form>
<h2 id="default-constructor">Default constructor</h2>
<p>
Ebean enhancement will <code>automatically add a default constructor</code> if one does not already exist on
the entity bean.
</p>
<h4>Example - Customer, No default constructor</h4>
<p>
In the example Customer entity bean below there is no default constructor and Ebean's enhancement
will add one automatically.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="cm">/**</span>
<span class="cm"> * Customer entity bean with no default constructor.</span>
<span class="cm"> */</span>
<span class="nd">@Entity</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">Customer</span> <span class="o">{</span>
<span class="kd">public</span> <span class="kd">static</span> <span class="kd">final</span> <span class="n">CustomerFinder</span> <span class="n">find</span> <span class="o">=</span> <span class="k">new</span> <span class="n">CustomerFinder</span><span class="o">();</span>
<span class="nd">@NotNull</span> <span class="nd">@Size</span><span class="o">(</span><span class="n">max</span> <span class="o">=</span> <span class="mi">100</span><span class="o">)</span>
<span class="n">String</span> <span class="n">name</span><span class="o">;</span>
<span class="o">...</span>
<span class="c1">// enhancement will add a default constructor</span>
<span class="c1">// if there is not one on the entity bean</span>
<span class="kd">public</span> <span class="nf">Customer</span><span class="o">(</span><span class="n">String</span> <span class="n">name</span><span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="na">name</span> <span class="o">=</span> <span class="n">name</span><span class="o">;</span>
<span class="o">}</span>
<span class="o">...</span> <span class="c1">// getters, setters etc</span>
</pre></div>
</div>
<h3 id="partial-objects">Partial objects</h3>
<p>
Note that you can make fields final if you wish, there is no restriction to Ebean for partially loading
the customer bean (without the name property) or creating reference beans (that only have their @Id
property loaded).
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="c1">// fetch partially populated beans that</span>
<span class="c1">// don't have the name property loaded</span>
<span class="n">List</span><span class="o"><</span><span class="n">Customer</span><span class="o">></span> <span class="n">customers</span> <span class="o">=</span>
<span class="n">Customer</span><span class="o">.</span><span class="na field">find</span><span class="o">.</span><span class="na">where</span><span class="o">()</span>
<span class="o">.</span><span class="na field">name</span><span class="o">.</span><span class="na">startsWith</span><span class="o">(</span><span class="s">"Rob"</span><span class="o">)</span>
<span class="o">.</span><span class="na">select</span><span class="o">(</span><span class="s">"id"</span><span class="o">)</span> <span class="c1">// only select id property</span>
<span class="o">.</span><span class="na">findList</span><span class="o">();</span>
</pre></div>
</div>
<h3 id="reference-bean">Reference bean</h3>
<p>
Ebean can construct reference beans which only have their <code>@Id</code> property loaded.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="c1">// reference bean with only @Id property loaded</span>
<span class="n">Customer</span> <span class="n">refBean</span> <span class="o">=</span> <span class="n">Customer</span><span class="o">.</span><span class="na field">find</span><span class="o">.</span><span class="na">ref</span><span class="o">(</span><span class="mi">42</span><span class="o">);</span>
<span class="c1">// reference beans don't hit the database unless</span>
<span class="c1">// lazy loading is invoked</span>
<span class="c1">// invoke lazy loading as name property is not loaded</span>
<span class="n">String</span> <span class="n">name</span> <span class="o">=</span> <span class="n">refBean</span><span class="o">.</span><span class="na">getName</span><span class="o">();</span>
</pre></div>
</div>
<h2 id="no-setters">Example - Country, No setters</h2>
<p>
With the Country entity bean below there are only 2 properties and these are both
set in the constructor. In this case there are no setters on this entity bean.
</p>
<p>
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="cm">/**</span>
<span class="cm"> * Country entity bean with no default constructor and</span>
<span class="cm"> * no setters (only getters).</span>
<span class="cm"> */</span>
<span class="nd">@Entity</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">Country</span> <span class="kd">extends</span> <span class="n">Model</span> <span class="o">{</span>
<span class="kd">public</span> <span class="kd">static</span> <span class="kd">final</span> <span class="n">CountryFinder</span> <span class="n">find</span> <span class="o">=</span> <span class="k">new</span> <span class="n">CountryFinder</span><span class="o">();</span>
<span class="nd">@Id</span> <span class="nd">@Size</span><span class="o">(</span><span class="n">max</span> <span class="o">=</span> <span class="mi">2</span><span class="o">)</span>
<span class="kd">final</span> <span class="n">String</span> <span class="n">code</span><span class="o">;</span>
<span class="nd">@NotNull</span> <span class="nd">@Size</span><span class="o">(</span><span class="n">max</span> <span class="o">=</span> <span class="mi">60</span><span class="o">)</span>
<span class="kd">final</span> <span class="n">String</span> <span class="n">name</span><span class="o">;</span>
<span class="c1">// enhancement will add a default constructor</span>
<span class="kd">public</span> <span class="nf">Country</span><span class="o">(</span><span class="n">String</span> <span class="n">code</span><span class="o">,</span> <span class="n">String</span> <span class="n">name</span><span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="na">code</span> <span class="o">=</span> <span class="n">code</span><span class="o">;</span>
<span class="k">this</span><span class="o">.</span><span class="na">name</span> <span class="o">=</span> <span class="n">name</span><span class="o">;</span>
<span class="o">}</span>
<span class="c1">// getters only for Country bean</span>
<span class="kd">public</span> <span class="n">String</span> <span class="nf">getCode</span><span class="o">()</span> <span class="o">{</span> <span class="k">return</span> <span class="n">code</span><span class="o">;</span> <span class="o">}</span>
<span class="kd">public</span> <span class="n">String</span> <span class="nf">getName</span><span class="o">()</span> <span class="o">{</span> <span class="k">return</span> <span class="n">name</span><span class="o">;</span> <span class="o">}</span>
<span class="o">}</span>
</pre></div>
</div>
<p>
Ebean can still support partially loaded entity beans and reference beans.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="c1">// insert a country</span>
<span class="k">new</span> <span class="n">Country</span><span class="o">(</span><span class="s">"NZ"</span><span class="o">,</span> <span class="s">"New Zealand"</span><span class="o">).</span><span class="na">save</span><span class="o">();</span>
<span class="c1">// reference bean (only has @Id property loaded)</span>
<span class="n">Country</span> <span class="n">nzRefBean</span> <span class="o">=</span> <span class="n">ebeanServer</span><span class="o">.</span><span class="na">getReference</span><span class="o">(</span><span class="n">Country</span><span class="o">.</span><span class="na">class</span><span class="o">,</span> <span class="s">"NZ"</span><span class="o">);</span>
<span class="c1">// reference bean using a "finder"</span>
<span class="n">Country</span> <span class="n">nzRefBean</span> <span class="o">=</span> <span class="n">Country</span><span class="o">.</span><span class="na field">find</span><span class="o">.</span><span class="na">ref</span><span class="o">(</span><span class="s">"NZ"</span><span class="o">);</span>
</pre></div>
</div>
<h2 id="kotlin">Kotlin</h2>
<h3>Country written in Kotlin</h3>
<p>
The code and name properties are non-null / required (no ? after the type declaration).
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="nd">@Entity</span>
<span class="nd">@Table</span><span class="o">(</span><span class="n">name</span> <span class="o">=</span> <span class="s">"country"</span><span class="o">)</span>
<span class="kd">class</span> <span class="nf">Country</span> <span class="o">(</span>
<span class="nd">@Id</span> <span class="nd">@Size</span><span class="o">(</span><span class="n">max</span> <span class="o">=</span> <span class="mi">2</span><span class="o">)</span>
<span class="k">var</span> <span class="n">code</span><span class="o">:</span> <span class="n">String</span><span class="o">,</span> <span class="c1">// non-null type</span>
<span class="nd">@NotNull</span> <span class="nd">@Size</span><span class="o">(</span><span class="n">max</span> <span class="o">=</span> <span class="mi">60</span><span class="o">)</span>
<span class="k">var</span> <span class="n">name</span><span class="o">:</span> <span class="n">String</span> <span class="c1">// non-null type</span>
<span class="o">)</span> <span class="o">:</span> <span class="n">Model</span><span class="o">()</span> <span class="o">{</span>
<span class="n">override</span> <span class="n">fun</span> <span class="nf">toString</span><span class="o">():</span> <span class="n">String</span> <span class="o">{</span>
<span class="k">return</span> <span class="s">"code:$code name:$name"</span><span class="o">;</span>
<span class="o">}</span>
<span class="n">companion</span> <span class="n">object</span> <span class="o">:</span> <span class="n">CountryFinder</span><span class="o">()</span> <span class="o">{}</span>
<span class="o">}</span>
</pre></div>
</div>
<p>
... using the Customer bean in Kotlin.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">Country</span><span class="o">(</span><span class="s">"NZ"</span><span class="o">,</span> <span class="s">"New Zealand"</span><span class="o">).</span><span class="na">save</span><span class="o">()</span>
<span class="c1">// reference bean</span>
<span class="k">val</span> <span class="n">nzRef</span> <span class="o">=</span> <span class="n">Country</span><span class="o">.</span><span class="na">ref</span><span class="o">(</span><span class="s">"NZ"</span><span class="o">)</span>
<span class="c1">// finder & query bean use</span>
<span class="k">val</span> <span class="n">nz</span> <span class="o">=</span> <span class="n">Country</span><span class="o">.</span><span class="na">where</span><span class="o">()</span>
<span class="o">.</span><span class="na field">code</span><span class="o">.</span><span class="na">equalTo</span><span class="o">(</span><span class="s">"NZ"</span><span class="o">)</span>
<span class="o">.</span><span class="na">findOne</span><span class="o">()</span>
</pre></div>
</div>
<h3>Customer written in Kotlin</h3>
<p>
The customer name property is declared as always non-null (no ? after the type declaration for name)
and must be passed when constructing a new customer instance.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="nd">@Entity</span>
<span class="nd">@Table</span><span class="o">(</span><span class="n">name</span> <span class="o">=</span> <span class="s">"customer"</span><span class="o">)</span>
<span class="kd">class</span> <span class="nf">Customer</span><span class="o">(</span>
<span class="nd">@NotNull</span> <span class="nd">@Size</span><span class="o">(</span><span class="n">max</span> <span class="o">=</span> <span class="mi">100</span><span class="o">)</span>
<span class="k">var</span> <span class="n">name</span><span class="o">:</span> <span class="n">String</span><span class="o">,</span> <span class="c1">// non-null type</span>
<span class="nd">@SoftDelete</span>
<span class="k">var</span> <span class="n">deleted</span><span class="o">:</span> <span class="n">Boolean</span> <span class="o">=</span> <span class="kc">false</span><span class="o">,</span>
<span class="k">var</span> <span class="n">registered</span><span class="o">:</span> <span class="n">Date</span><span class="o">?</span> <span class="o">=</span> <span class="kc">null</span><span class="o">,</span>
<span class="nd">@Size</span><span class="o">(</span><span class="n">max</span> <span class="o">=</span> <span class="mi">1000</span><span class="o">)</span>
<span class="k">var</span> <span class="n">comments</span><span class="o">:</span> <span class="n">String</span><span class="o">?</span> <span class="o">=</span> <span class="kc">null</span><span class="o">,</span>
<span class="nd">@ManyToOne</span><span class="o">(</span><span class="n">cascade</span> <span class="o">=</span> <span class="n">arrayOf</span><span class="o">(</span><span class="n">CascadeType</span><span class="o">.</span><span class="na">ALL</span><span class="o">))</span>
<span class="k">var</span> <span class="n">billingAddress</span><span class="o">:</span> <span class="n">Address</span><span class="o">?</span> <span class="o">=</span> <span class="kc">null</span><span class="o">,</span>
<span class="nd">@ManyToOne</span><span class="o">(</span><span class="n">cascade</span> <span class="o">=</span> <span class="n">arrayOf</span><span class="o">(</span><span class="n">CascadeType</span><span class="o">.</span><span class="na">ALL</span><span class="o">))</span>
<span class="k">var</span> <span class="n">shippingAddress</span><span class="o">:</span> <span class="n">Address</span><span class="o">?</span> <span class="o">=</span> <span class="kc">null</span><span class="o">,</span>
<span class="nd">@OneToMany</span><span class="o">(</span><span class="n">mappedBy</span> <span class="o">=</span> <span class="s">"customer"</span><span class="o">,</span> <span class="n">cascade</span> <span class="o">=</span> <span class="n">arrayOf</span><span class="o">(</span><span class="n">CascadeType</span><span class="o">.</span><span class="na">PERSIST</span><span class="o">))</span>
<span class="k">var</span> <span class="n">contacts</span><span class="o">:</span> <span class="n">MutableList</span><span class="o"><</span><span class="n">Contact</span><span class="o">></span> <span class="o">=</span> <span class="n">ArrayList</span><span class="o">()</span>
<span class="o">)</span> <span class="o">:</span> <span class="n">BaseModel</span><span class="o">()</span> <span class="o">{</span>
<span class="n">companion</span> <span class="n">object</span> <span class="n">find</span> <span class="o">:</span> <span class="n">CustomerFinder</span><span class="o">()</span> <span class="o">{}</span>
<span class="n">override</span> <span class="n">fun</span> <span class="nf">toString</span><span class="o">():</span> <span class="n">String</span> <span class="o">{</span>
<span class="k">return</span> <span class="s">"customer(id:$id name:$name)"</span><span class="o">;</span>
<span class="o">}</span>
<span class="o">}</span>
</pre></div>
</div>
<p>
... using Customer in Kotlin.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="c1">// new customer (requires name)</span>
<span class="k">val</span> <span class="n">rob</span> <span class="o">=</span> <span class="n">Customer</span><span class="o">(</span><span class="s">"Rob"</span><span class="o">)</span>
<span class="n">rob</span><span class="o">.</span><span class="na">save</span><span class="o">()</span>
<span class="c1">// reference bean</span>
<span class="k">val</span> <span class="n">refBean</span> <span class="o">=</span> <span class="n">Customer</span><span class="o">.</span><span class="na">ref</span><span class="o">(</span><span class="mi">42L</span><span class="o">)</span>
<span class="c1">// finder / query bean use</span>
<span class="k">val</span> <span class="n">customers</span> <span class="o">=</span>
<span class="n">Customer</span><span class="o">.</span><span class="na field">find</span><span class="o">.</span><span class="na">where</span><span class="o">()</span>
<span class="o">.</span><span class="na field">name</span><span class="o">.</span><span class="na">istartsWith</span><span class="o">(</span><span class="s">"rob"</span><span class="o">)</span>
<span class="o">.</span><span class="na">findList</span><span class="o">()</span>
</pre></div>
</div>
</div>
<div class="col-md-3" role="complementary">
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm">
<ul class="nav bs-docs-sidenav">
<li class="active">
<a href="/docs/mapping/constructors">Constructors</a>
<ul class="nav">
<li><a href="#default-constructor">Default constructor</a></li>
<li><a href="#partial-objects">Partial objects</a></li>
<li><a href="#reference-bean">Reference bean</a></li>
<li><a href="#no-setters">No setters example</a></li>
<li><a href="#kotlin">Kotlin</a></li>
</ul>
</li>
<li >
<a href="/docs/mapping/collections">Collections</a>
</li>
<li >
<a href="/docs/mapping/naming-convention">Naming convention</a>
</li>
<li >
<a href="/docs/mapping#validation-annotations">@Size and @NotNull</a>
</li>
<li >
<a href="/docs/mapping#limitations">Mapping limitations</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
</div>
</div>
<footer id="footer">
<div class="doc-footer">
<ul class="doc-footer-links">
<li><a href="/">Ebean ORM</a></li>
<li> | </li>
<li><a href="http://avaje-metric.github.io">Metrics</a></li>
</ul>
</div>
</footer>
<script type="text/javascript">
var categoryNames = {};
</script>
<script src="https://code.jquery.com/jquery-3.3.1.min.js"></script>
<script src="/js/bootstrap.min.js"></script>
<script src="/js/jquery.easing.min.js"></script>
<script src="/js/jquery.storageapi.min.js"></script>
<script src="/js/ebean-site.js"></script>
<script src="/js/extra.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-75181644-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>