From cb585483ef0cd01c4292886ef17c0fa9a6bf0ac2 Mon Sep 17 00:00:00 2001 From: Frida Tveit Date: Thu, 22 Dec 2016 18:40:23 +0000 Subject: [PATCH 1/2] Added javadoc for ImageFileFilter --- .../javaanpr/gui/tools/ImageFileFilter.java | 24 ++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/src/main/java/net/sf/javaanpr/gui/tools/ImageFileFilter.java b/src/main/java/net/sf/javaanpr/gui/tools/ImageFileFilter.java index 3185d76..6808f6e 100644 --- a/src/main/java/net/sf/javaanpr/gui/tools/ImageFileFilter.java +++ b/src/main/java/net/sf/javaanpr/gui/tools/ImageFileFilter.java @@ -19,8 +19,16 @@ import javax.swing.filechooser.FileFilter; import java.io.File; +/** + * This class filters filenames using the filename extension + */ public class ImageFileFilter extends FileFilter { + /** + * This method will accept the given filename if its extension is .bmp, .jpg, .jpeg, .png or .gif. + * @param name The filename to check + * @return true if the filename has one of the accepted extensions + */ public static boolean accept(String name) { int lastIndex = name.lastIndexOf('.'); if (lastIndex < 0) { @@ -31,15 +39,25 @@ public static boolean accept(String name) { .equals("gif"); } + /** + * This method will accept the given file if it is a directory or if it has a filename which is accepted + * by {@link ImageFileFilter#accept(String)}. + * @param file The file to check + * @return true if the file is a directory or its filename is accepted by {@link ImageFileFilter#accept(String)} + */ @Override - public boolean accept(File f) { - if (f.isDirectory()) { + public boolean accept(File file) { + if (file.isDirectory()) { return true; } - String name = f.getName(); + String name = file.getName(); return accept(name); } + /** + * This method returns a description of the file extensions which are currently accepted + * @return "images (*.jpg, *.bmp, *.gif, *.png)" + */ @Override public String getDescription() { return "images (*.jpg, *.bmp, *.gif, *.png)"; From e20e971a292058e6401313492ecbaae914685d34 Mon Sep 17 00:00:00 2001 From: Frida Tveit Date: Fri, 23 Dec 2016 15:25:02 +0000 Subject: [PATCH 2/2] Added full stops to javadoc comments in ImageFileFilter --- src/main/java/net/sf/javaanpr/gui/tools/ImageFileFilter.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/java/net/sf/javaanpr/gui/tools/ImageFileFilter.java b/src/main/java/net/sf/javaanpr/gui/tools/ImageFileFilter.java index 6808f6e..05dd2d8 100644 --- a/src/main/java/net/sf/javaanpr/gui/tools/ImageFileFilter.java +++ b/src/main/java/net/sf/javaanpr/gui/tools/ImageFileFilter.java @@ -20,7 +20,7 @@ import java.io.File; /** - * This class filters filenames using the filename extension + * This class filters filenames using the filename extension. */ public class ImageFileFilter extends FileFilter { @@ -55,7 +55,7 @@ public boolean accept(File file) { } /** - * This method returns a description of the file extensions which are currently accepted + * This method returns a description of the file extensions which are currently accepted. * @return "images (*.jpg, *.bmp, *.gif, *.png)" */ @Override