#107 JavaDoc for Service Layer

This commit is contained in:
Ilkka Seppala 2015-08-21 22:57:24 +03:00
parent 1b2a1fd19f
commit 488e5dd281
3 changed files with 14 additions and 5 deletions

View File

@ -18,7 +18,7 @@ import com.iluwatar.servicelayer.wizard.WizardDaoImpl;
/** /**
* Service layer defines an application's boundary with a layer of services that establishes * Service layer defines an application's boundary with a layer of services that establishes
* a set of available operations and coordinates the application's response in each operation. * a set of available operations and coordinates the application's response in each operation.
* * <p>
* Enterprise applications typically require different kinds of interfaces to the data * Enterprise applications typically require different kinds of interfaces to the data
* they store and the logic they implement: data loaders, user interfaces, integration gateways, * they store and the logic they implement: data loaders, user interfaces, integration gateways,
* and others. Despite their different purposes, these interfaces often need common interactions * and others. Despite their different purposes, these interfaces often need common interactions
@ -26,15 +26,19 @@ import com.iluwatar.servicelayer.wizard.WizardDaoImpl;
* interactions may be complex, involving transactions across multiple resources and the * interactions may be complex, involving transactions across multiple resources and the
* coordination of several responses to an action. Encoding the logic of the interactions * coordination of several responses to an action. Encoding the logic of the interactions
* separately in each interface causes a lot of duplication. * separately in each interface causes a lot of duplication.
* * <p>
* The example application demonstrates interactions between a client (App) and a service * The example application demonstrates interactions between a client ({@link App}) and a service
* (MagicService). The service is implemented with 3-layer architecture (entity, dao, service). * ({@link MagicService}). The service is implemented with 3-layer architecture (entity, dao, service).
* For persistence the example uses in-memory H2 database which is populated on each application * For persistence the example uses in-memory H2 database which is populated on each application
* startup. * startup.
* *
*/ */
public class App { public class App {
/**
* Program entry point
* @param args command line args
*/
public static void main( String[] args ) { public static void main( String[] args ) {
// populate the in-memory database // populate the in-memory database
initData(); initData();

View File

@ -9,7 +9,7 @@ import com.iluwatar.servicelayer.wizard.Wizard;
/** /**
* *
* Produces the Hibernate SessionFactory. * Produces the Hibernate {@link SessionFactory}.
* *
*/ */
public class HibernateUtil { public class HibernateUtil {

View File

@ -4,6 +4,11 @@ import org.junit.Test;
import com.iluwatar.servicelayer.app.App; import com.iluwatar.servicelayer.app.App;
/**
*
* Application test
*
*/
public class AppTest { public class AppTest {
@Test @Test