8268736: Use apiNote in AutoCloseable.close javadoc

Reviewed-by: bpb, naoto
This commit is contained in:
Joe Darcy 2021-06-15 18:52:54 +00:00
parent 76cad4b1ae
commit 31a055e67a

View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2009, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2009, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -54,7 +54,8 @@ public interface AutoCloseable {
* This method is invoked automatically on objects managed by the * This method is invoked automatically on objects managed by the
* {@code try}-with-resources statement. * {@code try}-with-resources statement.
* *
* <p>While this interface method is declared to throw {@code * @apiNote
* While this interface method is declared to throw {@code
* Exception}, implementers are <em>strongly</em> encouraged to * Exception}, implementers are <em>strongly</em> encouraged to
* declare concrete implementations of the {@code close} method to * declare concrete implementations of the {@code close} method to
* throw more specific exceptions, or to throw no exception at all * throw more specific exceptions, or to throw no exception at all