lombok

Annotation Type Cleanup

@Target(value=LOCAL_VARIABLE)
 @Retention(value=SOURCE)
public @interface Cleanup

Ensures the variable declaration that you annotate will be cleaned up by calling its close method, regardless of what happens. Implemented by wrapping all statements following the local variable declaration to the end of your scope into a try block that, as a finally action, closes the resource.

Complete documentation is found at the project lombok features page for @Cleanup.

Example:

 public void copyFile(String in, String out) throws IOException {
     @Cleanup FileInputStream inStream = new FileInputStream(in);
     @Cleanup FileOutputStream outStream = new FileOutputStream(out);
     byte[] b = new byte[65536];
     while (true) {
         int r = inStream.read(b);
         if (r == -1) break;
         outStream.write(b, 0, r);
     }
 }
 

Will generate:

 public void copyFile(String in, String out) throws IOException {
     @Cleanup FileInputStream inStream = new FileInputStream(in);
     try {
         @Cleanup FileOutputStream outStream = new FileOutputStream(out);
         try {
             byte[] b = new byte[65536];
             while (true) {
                 int r = inStream.read(b);
                 if (r == -1) break;
                 outStream.write(b, 0, r);
             }
         } finally {
             if (outStream != null) outStream.close();
         }
     } finally {
         if (inStream != null) inStream.close();
     }
 }
 

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	value

Element Detail

value

public abstract String value

Returns:

The name of the method that cleans up the resource. By default, 'close'. The method must not have any parameters.

Default:

"close"