gaspersic/java-design-patterns
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

#107 JavaDoc improvements for Layers example

Browse Source
This commit is contained in:
Ilkka Seppala
2015-08-19 22:03:03 +03:00
parent 5295ad6c2f
commit 48cb04f98a
1 changed files with 0 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
layers/src/main/java/com/iluwatar/layers/App.java
View File

@@ -4,33 +4,22 @@ import java.util.Arrays;
/** /**
* *
* <p>
* Layers is an architectural style where software responsibilities are * Layers is an architectural style where software responsibilities are
* divided among the different layers of the application. * divided among the different layers of the application.
* </p>
*
* <p> * <p>
* This example demonstrates a traditional 3-layer architecture consisting of data access * This example demonstrates a traditional 3-layer architecture consisting of data access
* layer, business layer and presentation layer. * layer, business layer and presentation layer.
* </p>
*
* <p> * <p>
* The data access layer is formed of Spring Data repositories <code>CakeDao</code>, <code>CakeToppingDao</code> and * 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 * <code>CakeLayerDao</code>. The repositories can be used for CRUD operations on cakes, cake toppings
* and cake layers respectively. * and cake layers respectively.
* </p>
*
* <p> * <p>
* The business layer is built on top of the data access layer. <code>CakeBakingService</code> offers * 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 * 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. * service is used to create new cakes out of cake toppings and cake layers.
* </p>
*
* <p> * <p>
* The presentation layer is built on the business layer and in this example it simply lists * The presentation layer is built on the business layer and in this example it simply lists
* the cakes that have been baked. * the cakes that have been baked.
* </p>
*
* <p> * <p>
* We have applied so called strict layering which means that the layers can only access * 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 * 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>) * 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 * 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. * other layers than the business layer and thus is not affected by changes to them.
* </p>
* *
* @see Cake * @see Cake
* @see CakeTopping * @see CakeTopping