[GitHub] [ignite-3] tkalkirill commented on a diff in pull request #1291: IGNITE-18032 Do not implement AutoCloseable on classes instances of which are not meant to be used in try-with-resources

[GitBox <gi...@apache.org>]

tkalkirill commented on code in PR #1291:
URL: https://github.com/apache/ignite-3/pull/1291#discussion_r1010456737


##########
modules/core/src/main/java/org/apache/ignite/internal/ManuallyCloseable.java:
##########
@@ -0,0 +1,39 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.ignite.internal;
+
+/**
+ * Represents something that must be eventually closed. It is different from {@link AutoCloseable} which is for being
+ * used in try-with-resources; IDEs treat any usage of an AutoCloseable outside of a try-with-resources block as a suspicious
+ * and issue a warning, so it becomes a drag to work with code that uses AutoCloseable for classes which instances
+ * are used with patterns different from the try-with-resources pattern.
+ *
+ * <p>The main reason of this interface appearance was the desire to mark 'must-be-eventually-closed' types so that
+ * we don't forget closing their instances.
+ *
+ * <p>Subinterfaces and classes implementing this interface should declare a narrower {@code throws} declaration (either
+ * having concrete subclasses of {@link Exception} or declaring no exceptions at all).
+ */
+public interface ManuallyCloseable {

Review Comment:
   Do I understand correctly that this interface is similar to a marker one? It seems to me that there is no need for it.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@ignite.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org