You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@commons.apache.org by GitBox <gi...@apache.org> on 2021/02/05 20:37:29 UTC
[GitHub] [commons-net] garydgregory commented on a change in pull request #72: Minor Improvement:
garydgregory commented on a change in pull request #72:
URL: https://github.com/apache/commons-net/pull/72#discussion_r571232271
##########
File path: src/main/java/org/apache/commons/net/util/NetConstants.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.commons.net.util;
+
+/**
+ * <p>
+ * An constant class providing functionality related to the {@code
+ * apache.commons.net} package.
Review comment:
Package name is wrong and this is not just for this package. Since this class is only public for access from other packages, we could/should only say "Constants provided as public only for our own implementation, you can consider this private for now."
##########
File path: src/main/java/org/apache/commons/net/util/NetConstants.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.commons.net.util;
+
+/**
+ * <p>
+ * An constant class providing functionality related to the {@code
+ * apache.commons.net} package.
+ * </p>
+ *
+ * @since 3.7
+ */
+public class NetConstants {
+
+ /**
+ * An empty immutable {@code String} array.
+ */
+ public static final String[] EMPTY_STRING_ARRAY = new String[0];
+ /**
+ * Private constructor so that no instances can be created. This class
+ * contains only static utility methods and constant.
Review comment:
Fix comment, there are no methods in this class. All that the comment needs to say is "Prevents instantiation." IMO.
##########
File path: src/main/java/org/apache/commons/net/util/NetConstants.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.commons.net.util;
+
+/**
+ * <p>
+ * An constant class providing functionality related to the {@code
+ * apache.commons.net} package.
+ * </p>
+ *
+ * @since 3.7
Review comment:
The since tag is wrong, pom.xml currently has 3.7.3 as the next version, but, since this is a new public element, we could bump the version up to 3.8.0. Let's keep 3.7.3 since this is just a constant that happens to be public for internal convenience.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org