#107 RAII example JavaDoc

This commit is contained in:
Ilkka Seppala 2015-08-21 22:52:22 +03:00
parent 57a271d4fe
commit ace8b3e22f
2 changed files with 18 additions and 8 deletions

View File

@ -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.
*
* <p>
* In RAII resource is tied to object lifetime: resource allocation
* is done during object creation while resource deallocation is
* done during object destruction.
*
* <p>
* 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.
*
* <p>
* 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()) {

View File

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