#107 JavaDoc improvements for Layers example
This commit is contained in:
parent
5295ad6c2f
commit
48cb04f98a
@ -4,33 +4,22 @@ import java.util.Arrays;
|
||||
|
||||
/**
|
||||
*
|
||||
* <p>
|
||||
* Layers is an architectural style where software responsibilities are
|
||||
* divided among the different layers of the application.
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
* This example demonstrates a traditional 3-layer architecture consisting of data access
|
||||
* layer, business layer and presentation layer.
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
* The data access layer is formed of Spring Data repositories <code>CakeDao</code>, <code>CakeToppingDao</code> and
|
||||
* <code>CakeLayerDao</code>. The repositories can be used for CRUD operations on cakes, cake toppings
|
||||
* and cake layers respectively.
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
* The business layer is built on top of the data access layer. <code>CakeBakingService</code> offers
|
||||
* methods to retrieve available cake toppings and cake layers and baked cakes. Also the
|
||||
* service is used to create new cakes out of cake toppings and cake layers.
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
* The presentation layer is built on the business layer and in this example it simply lists
|
||||
* the cakes that have been baked.
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
* We have applied so called strict layering which means that the layers can only access
|
||||
* the classes directly beneath them. This leads the solution to create an additional set of
|
||||
@ -41,7 +30,6 @@ import java.util.Arrays;
|
||||
* layer DTOs (<code>CakeInfo</code>, <code>CakeToppingInfo</code>, <code>CakeLayerInfo</code>)
|
||||
* and returns them instead. This way the presentation layer does not have any knowledge of
|
||||
* other layers than the business layer and thus is not affected by changes to them.
|
||||
* </p>
|
||||
*
|
||||
* @see Cake
|
||||
* @see CakeTopping
|
||||
|
Loading…
x
Reference in New Issue
Block a user