blob: cded1fe80b1650fa4fd04ff031ec83818b76a90c [file] [log] [blame]
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<body>
<h1>Tutorial 2 - Creating a Composite</h1>
<p>
In this tutorial we will create a TransientComposite interface that ties all pieces together.
The TransientComposite interface is a regular Java interface which extends the interfaces you
want to expose from your domain model, and which uses various annotations to declare
what Fragments to include. Fragments include Mixins, Concerns, SideEffects and Constraints.
In this tutorial we will only use Mixins. When a TransientComposite is instantiated at runtime
the framework will inspect the interface to determine what the TransientComposite instance should
look like in terms of used Fragments.
</p>
<p>
In Zestâ„¢ all method parameters are considered mandatory unless marked as @Optional. Therefore you can
remove the null checks in the Mixin. If a null value is passed in an exception will be thrown by Zestâ„¢.
</p>
<p>
Steps for this tutorial:
</p>
<ol>
<li>Create an interface that extends the domain interface HelloWorld and
org.qi4j.api.composite.TransientComposite.
</li>
<li>Add a @Mixins annotation to it with the name of the Mixin as argument.</li>
</ol>
</body>