@@ -182,6 +182,18 @@ private static boolean isOsNameMatch(final String osName, final String osNamePre
182182 private final int maxPathLength ;
183183 private final String [] reservedFileNames ;
184184
185+ /**
186+ * Constructs a new instance.
187+ *
188+ * @param maxFileLength
189+ * the maximum length for file names. The file name does not include folders.
190+ * @param maxPathLength
191+ * the maximum length of the path to a file. This can include folders.
192+ * @param illegalFileNameChars
193+ * illegal characters for this file system.
194+ * @param reservedFileNames
195+ * the reserved file names.
196+ */
185197 private FileSystem (final int maxFileLength , final int maxPathLength , final char [] illegalFileNameChars ,
186198 final String [] reservedFileNames ) {
187199 this .maxFileNameLength = maxFileLength ;
@@ -218,6 +230,13 @@ public int getMaxPathLength() {
218230 return maxPathLength ;
219231 }
220232
233+ /**
234+ * Returns {@code true} if the given character is illegal in a file name, {@code false} otherwise.
235+ *
236+ * @param c
237+ * the character to test
238+ * @return {@code true} if the given character is illegal in a file name, {@code false} otherwise.
239+ */
221240 private boolean isIllegalFileNameChar (final char c ) {
222241 return Arrays .binarySearch (illegalFileNameChars , c ) >= 0 ;
223242 }
@@ -289,6 +308,11 @@ public boolean isLegalFileName(final CharSequence candidate) {
289308 return true ;
290309 }
291310
311+ /**
312+ * Gets the reserved file names.
313+ *
314+ * @return the reserved file names.
315+ */
292316 public String [] getReservedFileNames () {
293317 return reservedFileNames ;
294318 }
0 commit comments