com.helger.commons.io.file

Interface IFileFilter

All Superinterfaces:

FileFilter, FilenameFilter, IPredicate<File>, Predicate<File>, Serializable

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface IFileFilter
extends FileFilter, FilenameFilter, IPredicate<File>

Abstract interface that collects FileFilter, FilenameFilter and IPredicate.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
default boolean	accept(File aFile)
default boolean	accept(File aDir, String sName)
static IFileFilter	directoryOnly()
static IFileFilter	directoryPublic()
static IFileFilter	filenameEndsWith(String sSuffix)
static IFileFilter	filenameEquals(String sFilename)
static IFileFilter	filenameEqualsIgnoreCase(String sFilename)
static IFileFilter	filenameHidden()
static IFileFilter	filenameMatchAny(String... aFilenames) Create a file filter that matches, if it matches one of the provided filenames.
static IFileFilter	filenameMatchAnyRegEx(String... aRegExs) Create a file filter that matches, if it matches one of the provided regular expressions
static IFileFilter	filenameMatchNone(String... aFilenames) Create a file filter that matches, if it matches none of the provided filenames.
static IFileFilter	filenameMatchNoRegEx(String... aRegExs) Create a file filter that matches, if it matches none of the provided regular expressions
static IFileFilter	filenameNotEquals(String sFilename)
static IFileFilter	filenameNotEqualsIgnoreCase(String sFilename)
static IFileFilter	filenameStartsWith(String sPrefix)
static IFileFilter	fileOnly()
static IFileFilter	parentDirectoryPublic()

Methods inherited from interface com.helger.commons.functional.IPredicate

all, and, and, isEqual, isNull, negate, none, notNull, or, or

Methods inherited from interface java.util.function.Predicate

test

Method Detail

accept

default boolean accept(@Nullable
                       File aFile)

Specified by:

accept in interface FileFilter

accept

default boolean accept(@Nullable
                       File aDir,
                       @Nullable
                       String sName)

Specified by:

accept in interface FilenameFilter

directoryOnly

@Nonnull
static IFileFilter directoryOnly()

Returns:

The created IFileFilter. Never null.

directoryPublic

@Nonnull
static IFileFilter directoryPublic()

Returns:

The created IFileFilter. Never null.

parentDirectoryPublic

@Nonnull
static IFileFilter parentDirectoryPublic()

Returns:

The created IFileFilter. Never null.

fileOnly

@Nonnull
static IFileFilter fileOnly()

Returns:

The created IFileFilter. Never null.

filenameHidden

@Nonnull
static IFileFilter filenameHidden()

Returns:

The created IFileFilter. Never null.

filenameStartsWith

@Nonnull
static IFileFilter filenameStartsWith(@Nonnull @Nonempty
                                                String sPrefix)

Parameters:

sPrefix - The extension to use. May neither be null nor empty.

Returns:

The created IFileFilter. Never null.

filenameEndsWith

@Nonnull
static IFileFilter filenameEndsWith(@Nonnull @Nonempty
                                              String sSuffix)

Parameters:

sSuffix - The suffix to use. May neither be null nor empty.

Returns:

The created IFileFilter. Never null.

filenameEquals

@Nonnull
static IFileFilter filenameEquals(@Nonnull @Nonempty
                                            String sFilename)

Parameters:

sFilename - The filename to use. May neither be null nor empty.

Returns:

The created IFileFilter. Never null.

filenameEqualsIgnoreCase

@Nonnull
static IFileFilter filenameEqualsIgnoreCase(@Nonnull @Nonempty
                                                      String sFilename)

Parameters:

sFilename - The filename to use. May neither be null nor empty.

Returns:

The created IFileFilter. Never null.

filenameNotEquals

@Nonnull
static IFileFilter filenameNotEquals(@Nonnull @Nonempty
                                               String sFilename)

Parameters:

sFilename - The filename to use. May neither be null nor empty.

Returns:

The created IFileFilter. Never null.

filenameNotEqualsIgnoreCase

@Nonnull
static IFileFilter filenameNotEqualsIgnoreCase(@Nonnull @Nonempty
                                                         String sFilename)

Parameters:

sFilename - The filename to use. May neither be null nor empty.

Returns:

The created IFileFilter. Never null.

filenameMatchAnyRegEx

@Nonnull
static IFileFilter filenameMatchAnyRegEx(@Nonnull @Nonempty
                                                   String... aRegExs)

Create a file filter that matches, if it matches one of the provided regular expressions

Parameters:

aRegExs - The regular expressions to match against. May neither be null nor empty.

Returns:

The created IFileFilter. Never null.

See Also:

filenameMatchNoRegEx(String...), filenameMatchAny(String...), filenameMatchNone(String...)

filenameMatchNoRegEx

@Nonnull
static IFileFilter filenameMatchNoRegEx(@Nonnull @Nonempty
                                                  String... aRegExs)

Create a file filter that matches, if it matches none of the provided regular expressions

Parameters:

aRegExs - The regular expressions to match against. May neither be null nor empty.

Returns:

The created IFileFilter. Never null.

See Also:

filenameMatchAnyRegEx(String...), filenameMatchAny(String...), filenameMatchNone(String...)

filenameMatchAny

@Nonnull
static IFileFilter filenameMatchAny(@Nonnull @Nonempty
                                              String... aFilenames)

Create a file filter that matches, if it matches one of the provided filenames.

Parameters:

aFilenames - The names to match against. May neither be null nor empty.

Returns:

The created IFileFilter. Never null.

See Also:

filenameMatchAnyRegEx(String...), filenameMatchNoRegEx(String...), filenameMatchNone(String...)

filenameMatchNone

@Nonnull
static IFileFilter filenameMatchNone(@Nonnull @Nonempty
                                               String... aFilenames)

Create a file filter that matches, if it matches none of the provided filenames.

Parameters:

aFilenames - The filenames to match against. May neither be null nor empty.

Returns:

The created IFileFilter. Never null.

See Also:

filenameMatchAnyRegEx(String...), filenameMatchNoRegEx(String...), filenameMatchAny(String...)