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 2023/03/19 13:27:07 UTC
[commons-io] branch master updated (fda06ca4 -> d51704fa)
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-io.git
from fda06ca4 Bump actions/checkout from 3.3.0 to 3.4.0 (#441)
new ba19189f Javadoc: Convert package.html to package-info.java
new e22fa747 Javadoc: Convert package.html to package-info.java
new d51704fa Javadoc: Convert package.html to package-info.java
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../apache/commons/io/comparator/package-info.java | 179 ++++++++++++++++++++
.../org/apache/commons/io/comparator/package.html | 184 ---------------------
.../apache/commons/io/filefilter/package-info.java | 174 +++++++++++++++++++
.../org/apache/commons/io/filefilter/package.html | 177 --------------------
.../java/org/apache/commons/io/package-info.java | 37 +++++
src/main/java/org/apache/commons/io/package.html | 47 ------
6 files changed, 390 insertions(+), 408 deletions(-)
create mode 100644 src/main/java/org/apache/commons/io/comparator/package-info.java
delete mode 100644 src/main/java/org/apache/commons/io/comparator/package.html
create mode 100644 src/main/java/org/apache/commons/io/filefilter/package-info.java
delete mode 100644 src/main/java/org/apache/commons/io/filefilter/package.html
create mode 100644 src/main/java/org/apache/commons/io/package-info.java
delete mode 100644 src/main/java/org/apache/commons/io/package.html
[commons-io] 03/03: Javadoc: Convert package.html to package-info.java
Posted by gg...@apache.org.
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
commit d51704fa1cda6794482140a829670ec1a85600ae
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Mar 19 09:27:03 2023 -0400
Javadoc: Convert package.html to package-info.java
---
.../java/org/apache/commons/io/package-info.java | 37 +++++++++++++++++
src/main/java/org/apache/commons/io/package.html | 47 ----------------------
2 files changed, 37 insertions(+), 47 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/package-info.java b/src/main/java/org/apache/commons/io/package-info.java
new file mode 100644
index 00000000..d7c21650
--- /dev/null
+++ b/src/main/java/org/apache/commons/io/package-info.java
@@ -0,0 +1,37 @@
+/*
+ * 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 utility classes for working with streams, readers, writers and files. The most commonly used classes are described here:
+ * <p>
+ * <b>IOUtils</b> is the most frequently used class. It provides operations to read, write, copy and close streams.
+ * </p>
+ * <p>
+ * <b>FileUtils</b> provides operations based around the JDK File class. These include reading, writing, copying, comparing and deleting.
+ * </p>
+ * <p>
+ * <b>FilenameUtils</b> provides utilities based on filenames. This utility class manipulates filenames without using File objects. It aims to simplify the
+ * transition between Windows and Unix. Before using this class however, you should consider whether you should be using File objects.
+ * </p>
+ * <p>
+ * <b>FileSystemUtils</b> allows access to the filing system in ways the JDK does not support. At present this allows you to get the free space on a drive.
+ * </p>
+ * <p>
+ * <b>EndianUtils</b> swaps data between Big-Endian and Little-Endian formats.
+ * </p>
+ */
+package org.apache.commons.io;
diff --git a/src/main/java/org/apache/commons/io/package.html b/src/main/java/org/apache/commons/io/package.html
deleted file mode 100644
index 914a0a60..00000000
--- a/src/main/java/org/apache/commons/io/package.html
+++ /dev/null
@@ -1,47 +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 bgcolor="white">
-<p>
-This package defines utility classes for working with streams, readers,
-writers and files. The most commonly used classes are described here:
-</p>
-<p>
-<b>IOUtils</b> is the most frequently used class.
-It provides operations to read, write, copy and close streams.
-</p>
-<p>
-<b>FileUtils</b> provides operations based around the JDK File class.
-These include reading, writing, copying, comparing and deleting.
-</p>
-<p>
-<b>FilenameUtils</b> provides utilities based on filenames.
-This utility class manipulates filenames without using File objects.
-It aims to simplify the transition between Windows and Unix.
-Before using this class however, you should consider whether you should
-be using File objects.
-</p>
-<p>
-<b>FileSystemUtils</b> allows access to the filing system in ways the JDK
-does not support. At present this allows you to get the free space on a drive.
-</p>
-<p>
-<b>EndianUtils</b> swaps data between Big-Endian and Little-Endian formats.
-</p>
-</body>
-</html>
[commons-io] 01/03: Javadoc: Convert package.html to package-info.java
Posted by gg...@apache.org.
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
commit ba19189f8c560a7fb0337b34e2d91be13771cdb3
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Mar 19 09:26:52 2023 -0400
Javadoc: Convert package.html to package-info.java
---
.../apache/commons/io/comparator/package-info.java | 179 ++++++++++++++++++++
.../org/apache/commons/io/comparator/package.html | 184 ---------------------
2 files changed, 179 insertions(+), 184 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/comparator/package-info.java b/src/main/java/org/apache/commons/io/comparator/package-info.java
new file mode 100644
index 00000000..b1272c1e
--- /dev/null
+++ b/src/main/java/org/apache/commons/io/comparator/package-info.java
@@ -0,0 +1,179 @@
+/*
+ * 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 various {@link java.util.Comparator} implementations
+ * for {@link java.io.File}s.
+ * <h2>Sorting</h2>
+ * <p>
+ * All the comparators include <i>convenience</i> utility <code>sort(File...)</code> and
+ * <code>sort(List)</code> methods.
+ * </p>
+ * <p>
+ * For example, to sort the files in a directory by name:
+ * </p>
+ * <pre>
+ * File[] files = dir.listFiles();
+ * NameFileComparator.NAME_COMPARATOR.sort(files);
+ * </pre>
+ * <p>
+ * ...alternatively you can do this in one line:
+ * </p>
+ * <pre>
+ * File[] files = NameFileComparator.NAME_COMPARATOR.sort(dir.listFiles());
+ * </pre>
+ * <h2>Composite Comparator</h2>
+ * <p>
+ * The <a href="CompositeFileComparator.html">CompositeFileComparator</a> can be used
+ * to compare (and sort lists or arrays of files) by combining a number of other comparators.
+ * </p>
+ * <p>
+ * For example, to sort an array of files by type (i.e. directory or file)
+ * and then by name:
+ * </p>
+ * <pre>
+ * CompositeFileComparator comparator =
+ * new CompositeFileComparator(
+ * DirectoryFileComparator.DIRECTORY_COMPARATOR,
+ * NameFileComparator.NAME_COMPARATOR);
+ * File[] files = dir.listFiles();
+ * comparator.sort(files);
+ * </pre>
+ * <h2>Singleton Instances (thread-safe)</h2>
+ * <p>
+ * The {@link java.util.Comparator} implementations have some <i>convenience</i>
+ * singleton(<i>thread-safe</i>) instances ready to use:
+ * </p>
+ * <ul>
+ * <li><a href="DefaultFileComparator.html">DefaultFileComparator</a> - default file compare:
+ * <ul>
+ * <li><a href="DefaultFileComparator.html#DEFAULT_COMPARATOR">DEFAULT_COMPARATOR</a>
+ * - Compare using <code>File.compareTo(File)</code> method.
+ * </li>
+ * <li><a href="DefaultFileComparator.html#DEFAULT_REVERSE">DEFAULT_REVERSE</a>
+ * - Reverse compare of <code>File.compareTo(File)</code> method.
+ * </li>
+ * </ul>
+ * </li>
+ * <li><a href="DirectoryFileComparator.html">DirectoryFileComparator</a> - compare by type (directory or file):
+ * <ul>
+ * <li><a href="DirectoryFileComparator.html#DIRECTORY_COMPARATOR">DIRECTORY_COMPARATOR</a>
+ * - Compare using <code>File.isDirectory()</code> method (directories < files).
+ * </li>
+ * <li><a href="DirectoryFileComparator.html#DIRECTORY_REVERSE">DIRECTORY_REVERSE</a>
+ * - Reverse compare of <code>File.isDirectory()</code> method (directories >files).
+ * </li>
+ * </ul>
+ * </li>
+ * <li><a href="ExtensionFileComparator.html">ExtensionFileComparator</a> - compare file extensions:
+ * <ul>
+ * <li><a href="ExtensionFileComparator.html#EXTENSION_COMPARATOR">EXTENSION_COMPARATOR</a>
+ * - Compare using <code>FilenameUtils.getExtension(String)</code> method.
+ * </li>
+ * <li><a href="ExtensionFileComparator.html#EXTENSION_REVERSE">EXTENSION_REVERSE</a>
+ * - Reverse compare of <code>FilenameUtils.getExtension(String)</code> method.
+ * </li>
+ * <li><a href="ExtensionFileComparator.html#EXTENSION_INSENSITIVE_COMPARATOR">EXTENSION_INSENSITIVE_COMPARATOR</a>
+ * - Case-insensitive compare using <code>FilenameUtils.getExtension(String)</code> method.
+ * </li>
+ * <li><a href="ExtensionFileComparator.html#EXTENSION_INSENSITIVE_REVERSE">EXTENSION_INSENSITIVE_REVERSE</a>
+ * - Reverse case-insensitive compare of <code>FilenameUtils.getExtension(String)</code> method.
+ * </li>
+ * <li><a href="ExtensionFileComparator.html#EXTENSION_SYSTEM_COMPARATOR">EXTENSION_SYSTEM_COMPARATOR</a>
+ * - System sensitive compare using <code>FilenameUtils.getExtension(String)</code> method.
+ * </li>
+ * <li><a href="ExtensionFileComparator.html#EXTENSION_SYSTEM_REVERSE">EXTENSION_SYSTEM_REVERSE</a>
+ * - Reverse system sensitive compare of <code>FilenameUtils.getExtension(String)</code> method.
+ * </li>
+ * </ul>
+ * </li>
+ * <li><a href="LastModifiedFileComparator.html">LastModifiedFileComparator</a>
+ * - compare the file's last modified date/time:
+ * <ul>
+ * <li><a href="LastModifiedFileComparator.html#LASTMODIFIED_COMPARATOR">LASTMODIFIED_COMPARATOR</a>
+ * - Compare using <code>File.lastModified()</code> method.
+ * </li>
+ * <li><a href="LastModifiedFileComparator.html#LASTMODIFIED_REVERSE">LASTMODIFIED_REVERSE</a>
+ * - Reverse compare of <code>File.lastModified()</code> method.
+ * </li>
+ * </ul>
+ * </li>
+ * <li><a href="NameFileComparator.html">NameFileComparator</a> - compare file names:
+ * <ul>
+ * <li><a href="NameFileComparator.html#NAME_COMPARATOR">NAME_COMPARATOR</a>
+ * - Compare using <code>File.getName()</code> method.
+ * </li>
+ * <li><a href="NameFileComparator.html#NAME_REVERSE">NAME_REVERSE</a>
+ * - Reverse compare of <code>File.getName()</code> method.
+ * </li>
+ * <li><a href="NameFileComparator.html#NAME_INSENSITIVE_COMPARATOR">NAME_INSENSITIVE_COMPARATOR</a>
+ * - Case-insensitive compare using <code>File.getName()</code> method.
+ * </li>
+ * <li><a href="NameFileComparator.html#NAME_INSENSITIVE_REVERSE">NAME_INSENSITIVE_REVERSE</a>
+ * - Reverse case-insensitive compare of <code>File.getName()</code> method.
+ * </li>
+ * <li><a href="NameFileComparator.html#NAME_SYSTEM_COMPARATOR">NAME_SYSTEM_COMPARATOR</a>
+ * - System sensitive compare using <code>File.getName()</code> method.
+ * </li>
+ * <li><a href="NameFileComparator.html#NAME_SYSTEM_REVERSE">NAME_SYSTEM_REVERSE</a>
+ * - Reverse system sensitive compare of <code>File.getName()</code> method.
+ * </li>
+ * </ul>
+ * </li>
+ * <li><a href="PathFileComparator.html">PathFileComparator</a> - compare file paths:
+ * <ul>
+ * <li><a href="PathFileComparator.html#PATH_COMPARATOR">PATH_COMPARATOR</a>
+ * - Compare using <code>File.getPath()</code> method.
+ * </li>
+ * <li><a href="PathFileComparator.html#PATH_REVERSE">PATH_REVERSE</a>
+ * - Reverse compare of <code>File.getPath()</code> method.
+ * </li>
+ * <li><a href="PathFileComparator.html#PATH_INSENSITIVE_COMPARATOR">PATH_INSENSITIVE_COMPARATOR</a>
+ * - Case-insensitive compare using <code>File.getPath()</code> method.
+ * </li>
+ * <li><a href="PathFileComparator.html#PATH_INSENSITIVE_REVERSE">PATH_INSENSITIVE_REVERSE</a>
+ * - Reverse case-insensitive compare of <code>File.getPath()</code> method.
+ * </li>
+ * <li><a href="PathFileComparator.html#PATH_SYSTEM_COMPARATOR">PATH_SYSTEM_COMPARATOR</a>
+ * - System sensitive compare using <code>File.getPath()</code> method.
+ * </li>
+ * <li><a href="PathFileComparator.html#PATH_SYSTEM_REVERSE">PATH_SYSTEM_REVERSE</a>
+ * - Reverse system sensitive compare of <code>File.getPath()</code> method.
+ * </li>
+ * </ul>
+ * </li>
+ * <li><a href="SizeFileComparator.html">SizeFileComparator</a> - compare the file's size:
+ * <ul>
+ * <li><a href="SizeFileComparator.html#SIZE_COMPARATOR">SIZE_COMPARATOR</a>
+ * - Compare using <code>File.length()</code> method (directories treated as zero length).
+ * </li>
+ * <li><a href="SizeFileComparator.html#SIZE_REVERSE">LASTMODIFIED_REVERSE</a>
+ * - Reverse compare of <code>File.length()</code> method (directories treated as zero length).
+ * </li>
+ * <li><a href="SizeFileComparator.html#SIZE_SUMDIR_COMPARATOR">SIZE_SUMDIR_COMPARATOR</a>
+ * - Compare using <code>FileUtils.sizeOfDirectory(File)</code> method
+ * (sums the size of a directory's contents).
+ * </li>
+ * <li><a href="SizeFileComparator.html#SIZE_SUMDIR_REVERSE">SIZE_SUMDIR_REVERSE</a>
+ * - Reverse compare of <code>FileUtils.sizeOfDirectory(File)</code> method
+ * (sums the size of a directory's contents).
+ * </li>
+ * </ul>
+ * </li>
+ * </ul>
+ */
+package org.apache.commons.io.comparator;
diff --git a/src/main/java/org/apache/commons/io/comparator/package.html b/src/main/java/org/apache/commons/io/comparator/package.html
deleted file mode 100644
index 433420ae..00000000
--- a/src/main/java/org/apache/commons/io/comparator/package.html
+++ /dev/null
@@ -1,184 +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 various {@link java.util.Comparator} implementations
-for {@link java.io.File}s.
-</p>
-<h2>Sorting</h2>
-<p>
- All the comparators include <i>convenience</i> utility <code>sort(File...)</code> and
- <code>sort(List)</code> methods.
-</p>
-<p>
- For example, to sort the files in a directory by name:
-</p>
- <pre>
- File[] files = dir.listFiles();
- NameFileComparator.NAME_COMPARATOR.sort(files);
- </pre>
-<p>
- ...alternatively you can do this in one line:
-</p>
-<pre>
- File[] files = NameFileComparator.NAME_COMPARATOR.sort(dir.listFiles());
-</pre>
-
-<h2>Composite Comparator</h2>
-<p>
- The <a href="CompositeFileComparator.html">CompositeFileComparator</a> can be used
- to compare (and sort lists or arrays of files) by combining a number of other comparators.
-</p>
-<p>
- For example, to sort an array of files by type (i.e. directory or file)
- and then by name:
-</p>
-<pre>
- CompositeFileComparator comparator =
- new CompositeFileComparator(
- DirectoryFileComparator.DIRECTORY_COMPARATOR,
- NameFileComparator.NAME_COMPARATOR);
- File[] files = dir.listFiles();
- comparator.sort(files);
-</pre>
-
-<h2>Singleton Instances (thread-safe)</h2>
-<p>
- The {@link java.util.Comparator} implementations have some <i>convenience</i>
- singleton(<i>thread-safe</i>) instances ready to use:
-</p>
-<ul>
- <li><a href="DefaultFileComparator.html">DefaultFileComparator</a> - default file compare:
- <ul>
- <li><a href="DefaultFileComparator.html#DEFAULT_COMPARATOR">DEFAULT_COMPARATOR</a>
- - Compare using <code>File.compareTo(File)</code> method.
- </li>
- <li><a href="DefaultFileComparator.html#DEFAULT_REVERSE">DEFAULT_REVERSE</a>
- - Reverse compare of <code>File.compareTo(File)</code> method.
- </li>
- </ul>
- </li>
- <li><a href="DirectoryFileComparator.html">DirectoryFileComparator</a> - compare by type (directory or file):
- <ul>
- <li><a href="DirectoryFileComparator.html#DIRECTORY_COMPARATOR">DIRECTORY_COMPARATOR</a>
- - Compare using <code>File.isDirectory()</code> method (directories < files).
- </li>
- <li><a href="DirectoryFileComparator.html#DIRECTORY_REVERSE">DIRECTORY_REVERSE</a>
- - Reverse compare of <code>File.isDirectory()</code> method (directories >files).
- </li>
- </ul>
- </li>
- <li><a href="ExtensionFileComparator.html">ExtensionFileComparator</a> - compare file extensions:
- <ul>
- <li><a href="ExtensionFileComparator.html#EXTENSION_COMPARATOR">EXTENSION_COMPARATOR</a>
- - Compare using <code>FilenameUtils.getExtension(String)</code> method.
- </li>
- <li><a href="ExtensionFileComparator.html#EXTENSION_REVERSE">EXTENSION_REVERSE</a>
- - Reverse compare of <code>FilenameUtils.getExtension(String)</code> method.
- </li>
- <li><a href="ExtensionFileComparator.html#EXTENSION_INSENSITIVE_COMPARATOR">EXTENSION_INSENSITIVE_COMPARATOR</a>
- - Case-insensitive compare using <code>FilenameUtils.getExtension(String)</code> method.
- </li>
- <li><a href="ExtensionFileComparator.html#EXTENSION_INSENSITIVE_REVERSE">EXTENSION_INSENSITIVE_REVERSE</a>
- - Reverse case-insensitive compare of <code>FilenameUtils.getExtension(String)</code> method.
- </li>
- <li><a href="ExtensionFileComparator.html#EXTENSION_SYSTEM_COMPARATOR">EXTENSION_SYSTEM_COMPARATOR</a>
- - System sensitive compare using <code>FilenameUtils.getExtension(String)</code> method.
- </li>
- <li><a href="ExtensionFileComparator.html#EXTENSION_SYSTEM_REVERSE">EXTENSION_SYSTEM_REVERSE</a>
- - Reverse system sensitive compare of <code>FilenameUtils.getExtension(String)</code> method.
- </li>
- </ul>
- </li>
- <li><a href="LastModifiedFileComparator.html">LastModifiedFileComparator</a>
- - compare the file's last modified date/time:
- <ul>
- <li><a href="LastModifiedFileComparator.html#LASTMODIFIED_COMPARATOR">LASTMODIFIED_COMPARATOR</a>
- - Compare using <code>File.lastModified()</code> method.
- </li>
- <li><a href="LastModifiedFileComparator.html#LASTMODIFIED_REVERSE">LASTMODIFIED_REVERSE</a>
- - Reverse compare of <code>File.lastModified()</code> method.
- </li>
- </ul>
- </li>
- <li><a href="NameFileComparator.html">NameFileComparator</a> - compare file names:
- <ul>
- <li><a href="NameFileComparator.html#NAME_COMPARATOR">NAME_COMPARATOR</a>
- - Compare using <code>File.getName()</code> method.
- </li>
- <li><a href="NameFileComparator.html#NAME_REVERSE">NAME_REVERSE</a>
- - Reverse compare of <code>File.getName()</code> method.
- </li>
- <li><a href="NameFileComparator.html#NAME_INSENSITIVE_COMPARATOR">NAME_INSENSITIVE_COMPARATOR</a>
- - Case-insensitive compare using <code>File.getName()</code> method.
- </li>
- <li><a href="NameFileComparator.html#NAME_INSENSITIVE_REVERSE">NAME_INSENSITIVE_REVERSE</a>
- - Reverse case-insensitive compare of <code>File.getName()</code> method.
- </li>
- <li><a href="NameFileComparator.html#NAME_SYSTEM_COMPARATOR">NAME_SYSTEM_COMPARATOR</a>
- - System sensitive compare using <code>File.getName()</code> method.
- </li>
- <li><a href="NameFileComparator.html#NAME_SYSTEM_REVERSE">NAME_SYSTEM_REVERSE</a>
- - Reverse system sensitive compare of <code>File.getName()</code> method.
- </li>
- </ul>
- </li>
- <li><a href="PathFileComparator.html">PathFileComparator</a> - compare file paths:
- <ul>
- <li><a href="PathFileComparator.html#PATH_COMPARATOR">PATH_COMPARATOR</a>
- - Compare using <code>File.getPath()</code> method.
- </li>
- <li><a href="PathFileComparator.html#PATH_REVERSE">PATH_REVERSE</a>
- - Reverse compare of <code>File.getPath()</code> method.
- </li>
- <li><a href="PathFileComparator.html#PATH_INSENSITIVE_COMPARATOR">PATH_INSENSITIVE_COMPARATOR</a>
- - Case-insensitive compare using <code>File.getPath()</code> method.
- </li>
- <li><a href="PathFileComparator.html#PATH_INSENSITIVE_REVERSE">PATH_INSENSITIVE_REVERSE</a>
- - Reverse case-insensitive compare of <code>File.getPath()</code> method.
- </li>
- <li><a href="PathFileComparator.html#PATH_SYSTEM_COMPARATOR">PATH_SYSTEM_COMPARATOR</a>
- - System sensitive compare using <code>File.getPath()</code> method.
- </li>
- <li><a href="PathFileComparator.html#PATH_SYSTEM_REVERSE">PATH_SYSTEM_REVERSE</a>
- - Reverse system sensitive compare of <code>File.getPath()</code> method.
- </li>
- </ul>
- </li>
- <li><a href="SizeFileComparator.html">SizeFileComparator</a> - compare the file's size:
- <ul>
- <li><a href="SizeFileComparator.html#SIZE_COMPARATOR">SIZE_COMPARATOR</a>
- - Compare using <code>File.length()</code> method (directories treated as zero length).
- </li>
- <li><a href="SizeFileComparator.html#SIZE_REVERSE">LASTMODIFIED_REVERSE</a>
- - Reverse compare of <code>File.length()</code> method (directories treated as zero length).
- </li>
- <li><a href="SizeFileComparator.html#SIZE_SUMDIR_COMPARATOR">SIZE_SUMDIR_COMPARATOR</a>
- - Compare using <code>FileUtils.sizeOfDirectory(File)</code> method
- (sums the size of a directory's contents).
- </li>
- <li><a href="SizeFileComparator.html#SIZE_SUMDIR_REVERSE">SIZE_SUMDIR_REVERSE</a>
- - Reverse compare of <code>FileUtils.sizeOfDirectory(File)</code> method
- (sums the size of a directory's contents).
- </li>
- </ul>
- </li>
-</ul>
-
-</body>
-</html>
[commons-io] 02/03: Javadoc: Convert package.html to package-info.java
Posted by gg...@apache.org.
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
commit e22fa74760b8b9f1378d18cc4004c569d43b5269
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Mar 19 09:26:57 2023 -0400
Javadoc: Convert package.html to package-info.java
---
.../apache/commons/io/filefilter/package-info.java | 174 ++++++++++++++++++++
.../org/apache/commons/io/filefilter/package.html | 177 ---------------------
2 files changed, 174 insertions(+), 177 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/filefilter/package-info.java b/src/main/java/org/apache/commons/io/filefilter/package-info.java
new file mode 100644
index 00000000..73f980fe
--- /dev/null
+++ b/src/main/java/org/apache/commons/io/filefilter/package-info.java
@@ -0,0 +1,174 @@
+/*
+ * 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 an interface (IOFileFilter) that combines both
+ * {@link java.io.FileFilter} and {@link java.io.FilenameFilter}.
+ * <p>Besides that the package offers a series of ready-to-use implementations of the
+ * IOFileFilter interface including implementation that allow you to combine
+ * other such filters.</p>
+ * <p>These filter can be used to list files or in {@link java.awt.FileDialog},
+ * for example.</p>
+ * <table>
+ * <caption>There are a number of 'primitive' filters:</caption>
+ * <tbody>
+ * <tr>
+ * <td><a href="DirectoryFileFilter.html">DirectoryFilter</a></td>
+ * <td>Only accept directories</td>
+ * </tr>
+ * <tr>
+ * <td><a href="PrefixFileFilter.html">PrefixFileFilter</a></td>
+ * <td>Filter based on a prefix</td>
+ * </tr>
+ * <tr>
+ * <td><a href="SuffixFileFilter.html">SuffixFileFilter</a></td>
+ * <td>Filter based on a suffix</td>
+ * </tr>
+ * <tr>
+ * <td><a href="NameFileFilter.html">NameFileFilter</a></td>
+ * <td>Filter based on a filename</td>
+ * </tr>
+ * <tr>
+ * <td><a href="WildcardFileFilter.html">WildcardFileFilter</a></td>
+ * <td>Filter based on wildcards</td>
+ * </tr>
+ * <tr>
+ * <td><a href="AgeFileFilter.html">AgeFileFilter</a></td>
+ * <td>Filter based on last modified time of file</td>
+ * </tr>
+ * <tr>
+ * <td><a href="SizeFileFilter.html">SizeFileFilter</a></td>
+ * <td>Filter based on file size</td>
+ * </tr>
+ * </tbody>
+ * </table>
+ * <table>
+ * <caption>And there are five 'boolean' filters:</caption>
+ * <tbody>
+ * <tr>
+ * <td><a href="TrueFileFilter.html">TrueFileFilter</a></td>
+ * <td>Accept all files</td>
+ * </tr>
+ * <tr>
+ * <td><a href="FalseFileFilter.html">FalseFileFilter</a></td>
+ * <td>Accept no files</td>
+ * </tr>
+ * <tr>
+ * <td><a href="NotFileFilter.html">NotFileFilter</a></td>
+ * <td>Applies a logical NOT to an existing filter</td>
+ * </tr>
+ * <tr>
+ * <td><a href="AndFileFilter.html">AndFileFilter</a></td>
+ * <td>Combines two filters using a logical AND</td>
+ * </tr>
+ * <tr>
+ * <td><a href="OrFileFilter.html">OrFileFilter</a></td>
+ * <td>Combines two filter using a logical OR</td>
+ * </tr>
+ *
+ * </tbody>
+ * </table>
+ * <h2>Using Classic IO</h2>
+ * <p>These boolean FilenameFilters can be nested, to allow arbitrary expressions.
+ * For example, here is how one could print all non-directory files in the
+ * current directory, starting with "A", and ending in ".java" or ".class":</p>
+ *
+ * <pre>
+ * File dir = new File(".");
+ * String[] files = dir.list(
+ * new AndFileFilter(
+ * new AndFileFilter(
+ * new PrefixFileFilter("A"),
+ * new OrFileFilter(
+ * new SuffixFileFilter(".class"),
+ * new SuffixFileFilter(".java")
+ * )
+ * ),
+ * new NotFileFilter(
+ * new DirectoryFileFilter()
+ * )
+ * )
+ * );
+ * for (int i=0; i<files.length; i++) {
+ * System.out.println(files[i]);
+ * }
+ * </pre>
+ * <p>
+ * You can alternatively build a filter tree using the "and", "or", and "not" methods on filters themselves:
+ * </p>
+ * <pre>
+ * File dir = new File(".");
+ * String[] files = dir.list(
+ * new AndFileFilter(
+ * new PrefixFileFilter("A").and(
+ * new SuffixFileFilter(".class").or(new SuffixFileFilter(".java"))),
+ * new DirectoryFileFilter().not()
+ * )
+ * );
+ * for (int i=0; i<files.length; i++) {
+ * System.out.println(files[i]);
+ * }
+ * </pre>
+ * <p>This package also contains a utility class:
+ * <a href="FileFilterUtils.html">FileFilterUtils</a>. It allows you to use all
+ * file filters without having to put them in the import section. Here's how the
+ * above example will look using FileFilterUtils:</p>
+ * <pre>
+ * File dir = new File(".");
+ * String[] files = dir.list(
+ * FileFilterUtils.andFileFilter(
+ * FileFilterUtils.andFileFilter(
+ * FileFilterUtils.prefixFileFilter("A"),
+ * FileFilterUtils.orFileFilter(
+ * FileFilterUtils.suffixFileFilter(".class"),
+ * FileFilterUtils.suffixFileFilter(".java")
+ * )
+ * ),
+ * FileFilterUtils.notFileFilter(
+ * FileFilterUtils.directoryFileFilter()
+ * )
+ * )
+ * );
+ * for (int i=0; i<files.length; i++) {
+ * System.out.println(files[i]);
+ * }
+ * </pre>
+ * <h2>Using NIO</h2>
+ * <p>You can combine Java <b>file tree walking</b> by using <code>java.nio.file.Files.walk()</code> APIs with filters:</p>
+ * <pre>
+ * final Path dir = Paths.get("");
+ * // We are interested in files older than one day
+ * final long cutoff = System.currentTimeMillis() - (24 * 60 * 60 * 1000);
+ * final AccumulatorPathVisitor visitor = AccumulatorPathVisitor.withLongCounters(new AgeFileFilter(cutoff));
+ * //
+ * // Walk one dir
+ * Files.<b>walkFileTree</b>(dir, Collections.emptySet(), 1, visitor);
+ * System.out.println(visitor.getPathCounters());
+ * System.out.println(visitor.getFileList());
+ * //
+ * visitor.getPathCounters().reset();
+ * //
+ * // Walk dir tree
+ * Files.<b>walkFileTree</b>(dir, visitor);
+ * System.out.println(visitor.getPathCounters());
+ * System.out.println(visitor.getDirList());
+ * System.out.println(visitor.getFileList());
+ * </pre>
+ * <p>There are a few other goodies in that class so please have a look at the
+ * documentation in detail.</p>
+ */
+package org.apache.commons.io.filefilter;
diff --git a/src/main/java/org/apache/commons/io/filefilter/package.html b/src/main/java/org/apache/commons/io/filefilter/package.html
deleted file mode 100644
index 545ee6a1..00000000
--- a/src/main/java/org/apache/commons/io/filefilter/package.html
+++ /dev/null
@@ -1,177 +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 an interface (IOFileFilter) that combines both
-{@link java.io.FileFilter} and {@link java.io.FilenameFilter}. Besides
-that the package offers a series of ready-to-use implementations of the
-IOFileFilter interface including implementation that allow you to combine
-other such filters.</p>
-<p>These filter can be used to list files or in {@link java.awt.FileDialog},
-for example.</p>
-
-<table>
- <caption>There are a number of 'primitive' filters:</caption>
- <tbody>
- <tr>
- <td><a href="DirectoryFileFilter.html">DirectoryFilter</a></td>
- <td>Only accept directories</td>
- </tr>
- <tr>
- <td><a href="PrefixFileFilter.html">PrefixFileFilter</a></td>
- <td>Filter based on a prefix</td>
- </tr>
- <tr>
- <td><a href="SuffixFileFilter.html">SuffixFileFilter</a></td>
- <td>Filter based on a suffix</td>
- </tr>
- <tr>
- <td><a href="NameFileFilter.html">NameFileFilter</a></td>
- <td>Filter based on a filename</td>
- </tr>
- <tr>
- <td><a href="WildcardFileFilter.html">WildcardFileFilter</a></td>
- <td>Filter based on wildcards</td>
- </tr>
- <tr>
- <td><a href="AgeFileFilter.html">AgeFileFilter</a></td>
- <td>Filter based on last modified time of file</td>
- </tr>
- <tr>
- <td><a href="SizeFileFilter.html">SizeFileFilter</a></td>
- <td>Filter based on file size</td>
- </tr>
- </tbody>
-</table>
-<table>
- <caption>And there are five 'boolean' filters:</caption>
- <tbody>
- <tr>
- <td><a href="TrueFileFilter.html">TrueFileFilter</a></td>
- <td>Accept all files</td>
- </tr>
- <tr>
- <td><a href="FalseFileFilter.html">FalseFileFilter</a></td>
- <td>Accept no files</td>
- </tr>
- <tr>
- <td><a href="NotFileFilter.html">NotFileFilter</a></td>
- <td>Applies a logical NOT to an existing filter</td>
- </tr>
- <tr>
- <td><a href="AndFileFilter.html">AndFileFilter</a></td>
- <td>Combines two filters using a logical AND</td>
- </tr>
- <tr>
- <td><a href="OrFileFilter.html">OrFileFilter</a></td>
- <td>Combines two filter using a logical OR</td>
- </tr>
-
- </tbody>
-</table>
-
-<h2>Using Classic IO</h2>
-<p>These boolean FilenameFilters can be nested, to allow arbitrary expressions.
-For example, here is how one could print all non-directory files in the
-current directory, starting with "A", and ending in ".java" or ".class":</p>
-
-<pre>
- File dir = new File(".");
- String[] files = dir.list(
- new AndFileFilter(
- new AndFileFilter(
- new PrefixFileFilter("A"),
- new OrFileFilter(
- new SuffixFileFilter(".class"),
- new SuffixFileFilter(".java")
- )
- ),
- new NotFileFilter(
- new DirectoryFileFilter()
- )
- )
- );
- for (int i=0; i<files.length; i++) {
- System.out.println(files[i]);
- }
-</pre>
-<p>
-You can alternatively build a filter tree using the "and", "or", and "not" methods on filters themselves:
-</p>
-<pre>
- File dir = new File(".");
- String[] files = dir.list(
- new AndFileFilter(
- new PrefixFileFilter("A").and(
- new SuffixFileFilter(".class").or(new SuffixFileFilter(".java"))),
- new DirectoryFileFilter().not()
- )
- );
- for (int i=0; i<files.length; i++) {
- System.out.println(files[i]);
- }
-</pre>
-<p>This package also contains a utility class:
-<a href="FileFilterUtils.html">FileFilterUtils</a>. It allows you to use all
-file filters without having to put them in the import section. Here's how the
-above example will look using FileFilterUtils:</p>
-<pre>
- File dir = new File(".");
- String[] files = dir.list(
- FileFilterUtils.andFileFilter(
- FileFilterUtils.andFileFilter(
- FileFilterUtils.prefixFileFilter("A"),
- FileFilterUtils.orFileFilter(
- FileFilterUtils.suffixFileFilter(".class"),
- FileFilterUtils.suffixFileFilter(".java")
- )
- ),
- FileFilterUtils.notFileFilter(
- FileFilterUtils.directoryFileFilter()
- )
- )
- );
- for (int i=0; i<files.length; i++) {
- System.out.println(files[i]);
- }
-</pre>
-<h2>Using NIO</h2>
-<p>You can combine Java <b>file tree walking</b> by using <code>java.nio.file.Files.walk()</code> APIs with filters:</p>
-<pre>
- final Path dir = Paths.get("");
- // We are interested in files older than one day
- final long cutoff = System.currentTimeMillis() - (24 * 60 * 60 * 1000);
- final AccumulatorPathVisitor visitor = AccumulatorPathVisitor.withLongCounters(new AgeFileFilter(cutoff));
- //
- // Walk one dir
- Files.<b>walkFileTree</b>(dir, Collections.emptySet(), 1, visitor);
- System.out.println(visitor.getPathCounters());
- System.out.println(visitor.getFileList());
- //
- visitor.getPathCounters().reset();
- //
- // Walk dir tree
- Files.<b>walkFileTree</b>(dir, visitor);
- System.out.println(visitor.getPathCounters());
- System.out.println(visitor.getDirList());
- System.out.println(visitor.getFileList());
-</pre>
-<p>There are a few other goodies in that class so please have a look at the
-documentation in detail.</p>
- </body>
-</html>