You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2022/01/11 14:37:15 UTC
[commons-io] branch master updated: Convert most package.html to package-info.java.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-io.git
The following commit(s) were added to refs/heads/master by this push:
new 0fedd7a Convert most package.html to package-info.java.
0fedd7a is described below
commit 0fedd7a15871f28e77328c888d91d6da51ecbba7
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Jan 11 09:37:12 2022 -0500
Convert most package.html to package-info.java.
---
.../org/apache/commons/io/file/package-info.java | 21 ++++++++++++++++++
.../java/org/apache/commons/io/file/package.html | 22 -------------------
.../apache/commons/io/file/spi/package-info.java | 23 ++++++++++++++++++++
.../org/apache/commons/io/file/spi/package.html | 22 -------------------
.../apache/commons/io/function/package-info.java | 21 ++++++++++++++++++
.../org/apache/commons/io/function/package.html | 24 ---------------------
.../commons/io/input/buffer/package-info.java | 21 ++++++++++++++++++
.../apache/commons/io/input/buffer/package.html | 25 ----------------------
.../org/apache/commons/io/input/package-info.java | 21 ++++++++++++++++++
.../java/org/apache/commons/io/input/package.html | 25 ----------------------
.../apache/commons/io/monitor/package-info.java | 21 ++++++++++++++++++
.../org/apache/commons/io/monitor/package.html | 25 ----------------------
.../org/apache/commons/io/output/package-info.java | 21 ++++++++++++++++++
.../java/org/apache/commons/io/output/package.html | 25 ----------------------
.../commons/io/serialization/package-info.java | 21 ++++++++++++++++++
.../apache/commons/io/serialization/package.html | 24 ---------------------
16 files changed, 170 insertions(+), 192 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/file/package-info.java b/src/main/java/org/apache/commons/io/file/package-info.java
new file mode 100644
index 0000000..8396fa4
--- /dev/null
+++ b/src/main/java/org/apache/commons/io/file/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+
+/**
+ * This package provides extensions in the realm of {@link java.nio.file}.
+ */
+package org.apache.commons.io.file;
diff --git a/src/main/java/org/apache/commons/io/file/package.html b/src/main/java/org/apache/commons/io/file/package.html
deleted file mode 100644
index 57071b2..0000000
--- a/src/main/java/org/apache/commons/io/file/package.html
+++ /dev/null
@@ -1,22 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<!--
-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.
--->
-<html>
-<body>
- <p>This package provides extensions in the realm of java.nio.file.</p>
-</body>
-</html>
diff --git a/src/main/java/org/apache/commons/io/file/spi/package-info.java b/src/main/java/org/apache/commons/io/file/spi/package-info.java
new file mode 100644
index 0000000..d347ee5
--- /dev/null
+++ b/src/main/java/org/apache/commons/io/file/spi/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * 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.
+ */
+
+/**
+ * This package provides extensions in the realm of {@link java.nio.file.spi}.
+ *
+ * @since 2.9.0
+ */
+package org.apache.commons.io.file.spi;
diff --git a/src/main/java/org/apache/commons/io/file/spi/package.html b/src/main/java/org/apache/commons/io/file/spi/package.html
deleted file mode 100644
index 7f9ee23..0000000
--- a/src/main/java/org/apache/commons/io/file/spi/package.html
+++ /dev/null
@@ -1,22 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<!--
-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.
--->
-<html>
-<body>
- <p>This package provides extensions in the realm of java.nio.file.spi.</p>
-</body>
-</html>
diff --git a/src/main/java/org/apache/commons/io/function/package-info.java b/src/main/java/org/apache/commons/io/function/package-info.java
new file mode 100644
index 0000000..2ae667a
--- /dev/null
+++ b/src/main/java/org/apache/commons/io/function/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+
+/**
+ * This package defines IO-only related functional interfaces for lambda expressions and method references.
+ */
+package org.apache.commons.io.function;
diff --git a/src/main/java/org/apache/commons/io/function/package.html b/src/main/java/org/apache/commons/io/function/package.html
deleted file mode 100644
index 23017f7..0000000
--- a/src/main/java/org/apache/commons/io/function/package.html
+++ /dev/null
@@ -1,24 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<!--
-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.
--->
-<html>
-<body>
-<p>
-This package defines IO-only related functional interfaces for lambda expressions and method references.
-</p>
-</body>
-</html>
diff --git a/src/main/java/org/apache/commons/io/input/buffer/package-info.java b/src/main/java/org/apache/commons/io/input/buffer/package-info.java
new file mode 100644
index 0000000..9e1a0e9
--- /dev/null
+++ b/src/main/java/org/apache/commons/io/input/buffer/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+
+/**
+ * This package provides implementations of buffered input classes, such as {@code CircularBufferInputStream} and {@code PeekableInputStream}.
+ */
+package org.apache.commons.io.input.buffer;
diff --git a/src/main/java/org/apache/commons/io/input/buffer/package.html b/src/main/java/org/apache/commons/io/input/buffer/package.html
deleted file mode 100644
index 9bb7c99..0000000
--- a/src/main/java/org/apache/commons/io/input/buffer/package.html
+++ /dev/null
@@ -1,25 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<!--
-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.
--->
-<html>
-<body>
-<p>
-This package provides implementations of buffered input classes, such as
-<code>CircularBufferInputStream</code> and <code>PeekableInputStream</code>.
-</p>
-</body>
-</html>
diff --git a/src/main/java/org/apache/commons/io/input/package-info.java b/src/main/java/org/apache/commons/io/input/package-info.java
new file mode 100644
index 0000000..e51ea55
--- /dev/null
+++ b/src/main/java/org/apache/commons/io/input/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+
+/**
+ * This package provides implementations of input classes, such as {@code InputStream} and {@code Reader}.
+ */
+package org.apache.commons.io.input;
diff --git a/src/main/java/org/apache/commons/io/input/package.html b/src/main/java/org/apache/commons/io/input/package.html
deleted file mode 100644
index 440fa0f..0000000
--- a/src/main/java/org/apache/commons/io/input/package.html
+++ /dev/null
@@ -1,25 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<!--
-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.
--->
-<html>
-<body>
-<p>
-This package provides implementations of input classes, such as
-<code>InputStream</code> and <code>Reader</code>.
-</p>
-</body>
-</html>
diff --git a/src/main/java/org/apache/commons/io/monitor/package-info.java b/src/main/java/org/apache/commons/io/monitor/package-info.java
new file mode 100644
index 0000000..d576883
--- /dev/null
+++ b/src/main/java/org/apache/commons/io/monitor/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+
+/**
+ * This package provides a component for monitoring file system events (directory and file create, update and delete events).
+ */
+package org.apache.commons.io.monitor;
diff --git a/src/main/java/org/apache/commons/io/monitor/package.html b/src/main/java/org/apache/commons/io/monitor/package.html
deleted file mode 100644
index 82c1eae..0000000
--- a/src/main/java/org/apache/commons/io/monitor/package.html
+++ /dev/null
@@ -1,25 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<!--
-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.
--->
-<html>
-<body>
-<p>
-This package provides a component for monitoring file system events
-(directory and file create, update and delete events).
-</p>
-</body>
-</html>
diff --git a/src/main/java/org/apache/commons/io/output/package-info.java b/src/main/java/org/apache/commons/io/output/package-info.java
new file mode 100644
index 0000000..d98fa7e
--- /dev/null
+++ b/src/main/java/org/apache/commons/io/output/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+
+/**
+ * This package provides implementations of output classes, such as {@code OutputStream} and {@code Writer}.
+ */
+package org.apache.commons.io.output;
diff --git a/src/main/java/org/apache/commons/io/output/package.html b/src/main/java/org/apache/commons/io/output/package.html
deleted file mode 100644
index 4415613..0000000
--- a/src/main/java/org/apache/commons/io/output/package.html
+++ /dev/null
@@ -1,25 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<!--
-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.
--->
-<html>
-<body>
-<p>
-This package provides implementations of output classes, such as
-<code>OutputStream</code> and <code>Writer</code>.
-</p>
-</body>
-</html>
diff --git a/src/main/java/org/apache/commons/io/serialization/package-info.java b/src/main/java/org/apache/commons/io/serialization/package-info.java
new file mode 100644
index 0000000..b953219
--- /dev/null
+++ b/src/main/java/org/apache/commons/io/serialization/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+
+/**
+ * This package provides a framework for controlling the deserialization of classes.
+ */
+package org.apache.commons.io.serialization;
diff --git a/src/main/java/org/apache/commons/io/serialization/package.html b/src/main/java/org/apache/commons/io/serialization/package.html
deleted file mode 100644
index 89f3b40..0000000
--- a/src/main/java/org/apache/commons/io/serialization/package.html
+++ /dev/null
@@ -1,24 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<!--
-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.
--->
-<html>
-<body>
-<p>
-This package provides a framework for controlling the deserialization of classes.
-</p>
-</body>
-</html>