From ace8b3e22fa50e9e6f42438c8d81886911239ec7 Mon Sep 17 00:00:00 2001 From: Ilkka Seppala Date: Fri, 21 Aug 2015 22:52:22 +0300 Subject: [PATCH] #107 RAII example JavaDoc --- .../acquisition/is/initialization/App.java | 21 ++++++++++++------- .../is/initialization/AppTest.java | 5 +++++ 2 files changed, 18 insertions(+), 8 deletions(-) diff --git a/resource-acquisition-is-initialization/src/main/java/com/iluwatar/resource/acquisition/is/initialization/App.java b/resource-acquisition-is-initialization/src/main/java/com/iluwatar/resource/acquisition/is/initialization/App.java index b947d31d0..141aea4ec 100644 --- a/resource-acquisition-is-initialization/src/main/java/com/iluwatar/resource/acquisition/is/initialization/App.java +++ b/resource-acquisition-is-initialization/src/main/java/com/iluwatar/resource/acquisition/is/initialization/App.java @@ -5,27 +5,32 @@ package com.iluwatar.resource.acquisition.is.initialization; * Resource Acquisition Is Initialization pattern was developed * for exception safe resource management by C++ creator Bjarne * Stroustrup. - * + *

* In RAII resource is tied to object lifetime: resource allocation * is done during object creation while resource deallocation is * done during object destruction. - * + *

* In Java RAII is achieved with try-with-resources statement and - * interfaces Closeable and AutoCloseable. The try-with-resources + * interfaces {@link Closeable} and {@link AutoCloseable}. The try-with-resources * statement ensures that each resource is closed at the end of the - * statement. Any object that implements java.lang.AutoCloseable, which - * includes all objects which implement java.io.Closeable, can be used + * statement. Any object that implements {@link java.lang.AutoCloseable}, which + * includes all objects which implement {@link java.io.Closeable}, can be used * as a resource. * - * In this example, SlidingDoor implements AutoCloseable and - * TreasureChest implements Closeable. Running the example, we can + * In this example, {@link SlidingDoor} implements {@link AutoCloseable} and + * {@link TreasureChest} implements {@link Closeable}. Running the example, we can * observe that both resources are automatically closed. - * + *

* http://docs.oracle.com/javase/7/docs/technotes/guides/language/try-with-resources.html * */ public class App { + /** + * Program entry point + * @param args command line args + * @throws Exception + */ public static void main( String[] args ) throws Exception { try (SlidingDoor slidingDoor = new SlidingDoor()) { diff --git a/resource-acquisition-is-initialization/src/test/java/com/iluwatar/resource/acquisition/is/initialization/AppTest.java b/resource-acquisition-is-initialization/src/test/java/com/iluwatar/resource/acquisition/is/initialization/AppTest.java index 097ea4711..e20815c3f 100644 --- a/resource-acquisition-is-initialization/src/test/java/com/iluwatar/resource/acquisition/is/initialization/AppTest.java +++ b/resource-acquisition-is-initialization/src/test/java/com/iluwatar/resource/acquisition/is/initialization/AppTest.java @@ -4,6 +4,11 @@ import org.junit.Test; import com.iluwatar.resource.acquisition.is.initialization.App; +/** + * + * Application test + * + */ public class AppTest { @Test