Skip to content

Commit ded7f22

Browse files
author
Gary Gregory
committed
Remove "line" in-line comments.
1 parent 083c584 commit ded7f22

22 files changed

Lines changed: 0 additions & 86 deletions

src/main/java/org/apache/commons/io/DirectoryWalker.java

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,6 @@ protected DirectoryWalker(IOFileFilter directoryFilter, IOFileFilter fileFilter,
316316
this.depthLimit = depthLimit;
317317
}
318318

319-
//-----------------------------------------------------------------------
320319
/**
321320
* Internal method that walks the directory hierarchy in a depth-first manner.
322321
* <p>
@@ -381,7 +380,6 @@ private void walk(final File directory, final int depth, final Collection<T> res
381380
checkIfCancelled(directory, depth, results);
382381
}
383382

384-
//-----------------------------------------------------------------------
385383
/**
386384
* Checks whether the walk has been cancelled by calling {@link #handleIsCancelled},
387385
* throwing a {@code CancelException} if it has.
@@ -469,7 +467,6 @@ protected void handleCancelled(final File startDirectory, final Collection<T> re
469467
throw cancel;
470468
}
471469

472-
//-----------------------------------------------------------------------
473470
/**
474471
* Overridable callback method invoked at the start of processing.
475472
* <p>
@@ -609,7 +606,6 @@ protected void handleEnd(final Collection<T> results) throws IOException {
609606
// do nothing - overridable by subclass
610607
}
611608

612-
//-----------------------------------------------------------------------
613609
/**
614610
* CancelException is thrown in DirectoryWalker to cancel the current
615611
* processing.

src/main/java/org/apache/commons/io/FileCleaner.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ public class FileCleaner {
4141
*/
4242
static final FileCleaningTracker theInstance = new FileCleaningTracker();
4343

44-
//-----------------------------------------------------------------------
4544
/**
4645
* Track the specified file, using the provided marker, deleting the file
4746
* when the marker instance is garbage collected.
@@ -104,7 +103,6 @@ public static void track(final String path, final Object marker, final FileDelet
104103
theInstance.track(path, marker, deleteStrategy);
105104
}
106105

107-
//-----------------------------------------------------------------------
108106
/**
109107
* Retrieve the number of files currently being tracked, and therefore
110108
* awaiting deletion.

src/main/java/org/apache/commons/io/FileCleaningTracker.java

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@ public class FileCleaningTracker {
6666
*/
6767
Thread reaper;
6868

69-
//-----------------------------------------------------------------------
7069
/**
7170
* Track the specified file, using the provided marker, deleting the file
7271
* when the marker instance is garbage collected.
@@ -143,7 +142,6 @@ private synchronized void addTracker(final String path, final Object marker, fin
143142
trackers.add(new Tracker(path, deleteStrategy, marker, q));
144143
}
145144

146-
//-----------------------------------------------------------------------
147145
/**
148146
* Retrieve the number of files currently being tracked, and therefore
149147
* awaiting deletion.
@@ -196,7 +194,6 @@ public synchronized void exitWhenFinished() {
196194
}
197195
}
198196

199-
//-----------------------------------------------------------------------
200197
/**
201198
* The reaper thread.
202199
*/
@@ -231,7 +228,6 @@ public void run() {
231228
}
232229
}
233230

234-
//-----------------------------------------------------------------------
235231
/**
236232
* Inner class which acts as the reference for a file pending deletion.
237233
*/

src/main/java/org/apache/commons/io/FileSystemUtils.java

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,6 @@ public class FileSystemUtils {
114114
public FileSystemUtils() {
115115
}
116116

117-
//-----------------------------------------------------------------------
118117
/**
119118
* Returns the free space on a drive or volume by invoking
120119
* the command line.
@@ -146,7 +145,6 @@ public static long freeSpace(final String path) throws IOException {
146145
return INSTANCE.freeSpaceOS(path, OS, false, Duration.ofMillis(-1));
147146
}
148147

149-
//-----------------------------------------------------------------------
150148
/**
151149
* Returns the free space on a drive or volume in kibibytes (1024 bytes)
152150
* by invoking the command line.
@@ -248,7 +246,6 @@ public static long freeSpaceKb(final long timeout) throws IOException {
248246
return freeSpaceKb(new File(".").getAbsolutePath(), timeout);
249247
}
250248

251-
//-----------------------------------------------------------------------
252249
/**
253250
* Returns the free space on a drive or volume in a cross-platform manner.
254251
* Note that some OS's are NOT currently supported, including OS/390.
@@ -288,7 +285,6 @@ long freeSpaceOS(final String path, final int os, final boolean kb, final Durati
288285
}
289286
}
290287

291-
//-----------------------------------------------------------------------
292288
/**
293289
* Find free space on the Windows platform using the 'dir' command.
294290
*
@@ -381,7 +377,6 @@ long parseDir(final String line, final String path) throws IOException {
381377
return parseBytes(buf.toString(), path);
382378
}
383379

384-
//-----------------------------------------------------------------------
385380
/**
386381
* Find free space on the *nix platform using the 'df' command.
387382
*
@@ -440,7 +435,6 @@ long freeSpaceUnix(final String path, final boolean kb, final boolean posix, fin
440435
return parseBytes(freeSpace, path);
441436
}
442437

443-
//-----------------------------------------------------------------------
444438
/**
445439
* Parses the bytes from a string.
446440
*

src/main/java/org/apache/commons/io/FilenameUtils.java

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,6 @@ public class FilenameUtils {
137137
public FilenameUtils() {
138138
}
139139

140-
//-----------------------------------------------------------------------
141140
/**
142141
* Determines if Windows file system is in use.
143142
*
@@ -147,7 +146,6 @@ static boolean isSystemWindows() {
147146
return SYSTEM_SEPARATOR == WINDOWS_SEPARATOR;
148147
}
149148

150-
//-----------------------------------------------------------------------
151149
/**
152150
* Checks if the character is a separator.
153151
*
@@ -158,7 +156,6 @@ private static boolean isSeparator(final char ch) {
158156
return ch == UNIX_SEPARATOR || ch == WINDOWS_SEPARATOR;
159157
}
160158

161-
//-----------------------------------------------------------------------
162159
/**
163160
* Normalizes a path, removing double and single dot path steps.
164161
* <p>
@@ -251,7 +248,6 @@ public static String normalize(final String fileName, final boolean unixSeparato
251248
return doNormalize(fileName, separator, true);
252249
}
253250

254-
//-----------------------------------------------------------------------
255251
/**
256252
* Normalizes a path, removing double and single dot path steps,
257253
* and removing any final directory separator.
@@ -451,7 +447,6 @@ private static String doNormalize(final String fileName, final char separator, f
451447
return new String(array, 0, size - 1); // lose trailing separator
452448
}
453449

454-
//-----------------------------------------------------------------------
455450
/**
456451
* Concatenates a fileName to a base path using normal command line style rules.
457452
* <p>
@@ -747,7 +742,6 @@ public static int indexOfExtension(final String fileName) throws IllegalArgument
747742
return lastSeparator > extensionPos ? NOT_FOUND : extensionPos;
748743
}
749744

750-
//-----------------------------------------------------------------------
751745
/**
752746
* Gets the prefix from a full fileName, such as {@code C:/}
753747
* or {@code ~/}.
@@ -1089,7 +1083,6 @@ private static int getAdsCriticalOffset(final String fileName) {
10891083
return Math.max(offset1, offset2) + 1;
10901084
}
10911085

1092-
//-----------------------------------------------------------------------
10931086
/**
10941087
* Removes the extension from a fileName.
10951088
* <p>
@@ -1120,7 +1113,6 @@ public static String removeExtension(final String fileName) {
11201113
return fileName.substring(0, index);
11211114
}
11221115

1123-
//-----------------------------------------------------------------------
11241116
/**
11251117
* Checks whether two fileNames are equal exactly.
11261118
* <p>
@@ -1151,7 +1143,6 @@ public static boolean equalsOnSystem(final String fileName1, final String fileNa
11511143
return equals(fileName1, fileName2, false, IOCase.SYSTEM);
11521144
}
11531145

1154-
//-----------------------------------------------------------------------
11551146
/**
11561147
* Checks whether two fileNames are equal after both have been normalized.
11571148
* <p>
@@ -1218,7 +1209,6 @@ public static boolean equals(
12181209
return caseSensitivity.checkEquals(fileName1, fileName2);
12191210
}
12201211

1221-
//-----------------------------------------------------------------------
12221212
/**
12231213
* Checks whether the extension of the fileName is that specified.
12241214
* <p>
@@ -1304,7 +1294,6 @@ public static boolean isExtension(final String fileName, final Collection<String
13041294
return false;
13051295
}
13061296

1307-
//-----------------------------------------------------------------------
13081297
/**
13091298
* Checks a fileName to see if it matches the specified wildcard matcher,
13101299
* always testing case-sensitive.

src/main/java/org/apache/commons/io/LineIterator.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,6 @@ public LineIterator(final Reader reader) throws IllegalArgumentException {
7575
}
7676
}
7777

78-
//-----------------------------------------------------------------------
7978
/**
8079
* Indicates whether the {@code Reader} has more lines.
8180
* If there is an {@code IOException} then {@link #close()} will
@@ -172,7 +171,6 @@ public void remove() {
172171
throw new UnsupportedOperationException("remove not supported");
173172
}
174173

175-
//-----------------------------------------------------------------------
176174
/**
177175
* Closes a {@code LineIterator} quietly.
178176
*

src/main/java/org/apache/commons/io/filefilter/FileFilterUtils.java

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,6 @@ public static IOFileFilter and(final IOFileFilter... filters) {
148148
return new AndFileFilter(toList(filters));
149149
}
150150

151-
//-----------------------------------------------------------------------
152151
/**
153152
* Returns a filter that ANDs the two specified filters.
154153
*
@@ -164,7 +163,6 @@ public static IOFileFilter andFileFilter(final IOFileFilter filter1, final IOFil
164163
return new AndFileFilter(filter1, filter2);
165164
}
166165

167-
//-----------------------------------------------------------------------
168166
/**
169167
* Returns an {@code IOFileFilter} that wraps the
170168
* {@code FileFilter} instance.
@@ -523,7 +521,6 @@ public static IOFileFilter makeCVSAware(final IOFileFilter filter) {
523521
return filter == null ? cvsFilter : and(filter, cvsFilter);
524522
}
525523

526-
//-----------------------------------------------------------------------
527524
/**
528525
* Decorates a filter so that it only applies to directories and not to files.
529526
*
@@ -656,7 +653,6 @@ public static IOFileFilter prefixFileFilter(final String prefix, final IOCase ca
656653
return new PrefixFileFilter(prefix, caseSensitivity);
657654
}
658655

659-
//-----------------------------------------------------------------------
660656
/**
661657
* Returns a filter that returns true if the file is bigger than a certain size.
662658
*

src/main/java/org/apache/commons/io/input/CountingInputStream.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ public CountingInputStream(final InputStream in) {
4343
super(in);
4444
}
4545

46-
//-----------------------------------------------------------------------
4746

4847
/**
4948
* Skips the stream over the specified number of bytes, adding the skipped
@@ -74,7 +73,6 @@ protected synchronized void afterRead(final int n) {
7473
}
7574
}
7675

77-
//-----------------------------------------------------------------------
7876
/**
7977
* The number of bytes that have passed through this stream.
8078
* <p>

src/main/java/org/apache/commons/io/output/CountingOutputStream.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ public CountingOutputStream( final OutputStream out ) {
4141
super(out);
4242
}
4343

44-
//-----------------------------------------------------------------------
4544

4645
/**
4746
* Updates the count with the number of bytes that are being written.
@@ -54,7 +53,6 @@ protected synchronized void beforeWrite(final int n) {
5453
count += n;
5554
}
5655

57-
//-----------------------------------------------------------------------
5856
/**
5957
* The number of bytes that have passed through this stream.
6058
* <p>

src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,6 @@ public FileWriterWithEncoding(final File file, final CharsetEncoder charsetEncod
210210
this.out = initWriter(file, charsetEncoder, append);
211211
}
212212

213-
//-----------------------------------------------------------------------
214213
/**
215214
* Initialize the wrapped file writer.
216215
* Ensure that a cleanup occurs if the writer creation fails.
@@ -249,7 +248,6 @@ private static Writer initWriter(final File file, final Object encoding, final b
249248
}
250249
}
251250

252-
//-----------------------------------------------------------------------
253251
/**
254252
* Write a character.
255253
* @param idx the character to write

0 commit comments

Comments
 (0)