[jira] [Closed] (LOG4J2-1553) AbstractManager should implement AutoCloseable

["Gary Gregory (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/LOG4J2-1553?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Gary Gregory closed LOG4J2-1553.
--------------------------------
    Resolution: Fixed

Closing.

> AbstractManager should implement AutoCloseable
> ----------------------------------------------
>
>                 Key: LOG4J2-1553
>                 URL: https://issues.apache.org/jira/browse/LOG4J2-1553
>             Project: Log4j 2
>          Issue Type: Improvement
>          Components: Appenders
>            Reporter: Gary Gregory
>            Assignee: Gary Gregory
>
> The class {{AbstractManager}} should implement {{java.lang.AutoCloseable}}.
> A manager holds on to resources that must be cleaned up. Typically these resources are allocated on instance creation and freed by calling the manager's {{release()}} method.
> For {{AbstractManager}} to implement {{java.lang.AutoCloseable}}, {{release()}} will re-implemented as {{close()}} and deprecated.
> There are several benefits to this change:
> - Make it obvious and formal that this kind of object must be properly managed.
> - A reader or cloner of the code will know that there is a pattern to follow.
> - This will make our tests cleaner, smaller and hopefully less error-prone. 
> Possible disadvantages:
> - Coders may think that managers can be used like resources like a {{java.io.File}}.
> - Some {{AutoCloseable}} implementations are short-lived, this one not so much, so we will add Javadoc for this effect and to note the benefit for unit tests.
> Our current unit test code follows this pattern:
> {code:java}
> SomeManager mgr = new SomeManager(lots, of, params);
> try {
>     // test code
> } finally {
>     mgr.close();
> }
> {code}
> Sometimes, we also have:
> {code:java}
> SomeManager mgr = new SomeManager(lots, of, params);
> try {
>     // test code
> } finally {
>     if (mgr != null) {
>       mgr.close();
>     }
> }
> {code}
> After the proposed change, our test code can look like this:
> {code:java}
> try (SomeManager mgr = new SomeManager(lots, of, params)) {
>     // test code
> }
> {code}
> New Javadoc:
> {code:java}
> /**
>  * Abstract base class used to register managers.
>  * <p>
>  * This class implements {@link AutoCloseable} mostly to allow unit tests to be written safely and succinctly. While
>  * managers do need to allocate resources (usually on construction) and then free these resources, a manager is longer
>  * lived than other auto-closeable objects like streams. None the less, making a manager AutoCloseable forces readers to
>  * be aware of the the pattern: allocate resources on construction and call {@link #close()} at some point.
>  * </p>
>  */
> public abstract class AbstractManager implements AutoCloseable {
> {code}



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: log4j-dev-unsubscribe@logging.apache.org
For additional commands, e-mail: log4j-dev-help@logging.apache.org