com.helger.commons.io.file

Class ComparatorFileName

java.lang.Object

com.helger.commons.compare.AbstractComparator<DATATYPE>

com.helger.commons.compare.AbstractCollationComparator<File>

com.helger.commons.io.file.ComparatorFileName

All Implemented Interfaces:

Serializable, Comparator<File>

@NotThreadSafe
public final class ComparatorFileName
extends AbstractCollationComparator<File>

Sort files by their base name.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ComparatorFileName()
ComparatorFileName(Comparator<? super File> aNestedComparator)
ComparatorFileName(ESortOrder eSortOrder)
ComparatorFileName(ESortOrder eSortOrder, Comparator<? super File> aNestedComparator)
ComparatorFileName(Locale aSortLocale)
ComparatorFileName(Locale aSortLocale, Comparator<? super File> aNestedComparator)
ComparatorFileName(Locale aSortLocale, ESortOrder eSortOrder, Comparator<? super File> aNestedComparator)

Method Summary

Modifier and Type	Method and Description
protected String	asString(File aObject) Abstract method that needs to be overridden to convert an object to a string representation for comparison.

Methods inherited from class com.helger.commons.compare.AbstractCollationComparator

getCollator, mainCompare, toString

Methods inherited from class com.helger.commons.compare.AbstractComparator

compare, getNestedComparator, getSortOrder, setSortOrder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

ComparatorFileName

public ComparatorFileName()

ComparatorFileName

public ComparatorFileName(@Nullable
                          Locale aSortLocale)

ComparatorFileName

public ComparatorFileName(@Nonnull
                          ESortOrder eSortOrder)

ComparatorFileName

public ComparatorFileName(@Nullable
                          Comparator<? super File> aNestedComparator)

ComparatorFileName

public ComparatorFileName(@Nonnull
                          ESortOrder eSortOrder,
                          @Nullable
                          Comparator<? super File> aNestedComparator)

ComparatorFileName

public ComparatorFileName(@Nullable
                          Locale aSortLocale,
                          @Nullable
                          Comparator<? super File> aNestedComparator)

ComparatorFileName

public ComparatorFileName(@Nullable
                          Locale aSortLocale,
                          @Nonnull
                          ESortOrder eSortOrder,
                          @Nullable
                          Comparator<? super File> aNestedComparator)

Method Detail

asString

protected String asString(@Nonnull
                          File aObject)

Description copied from class: AbstractCollationComparator

Abstract method that needs to be overridden to convert an object to a string representation for comparison.

Specified by:

asString in class AbstractCollationComparator<File>

Parameters:

aObject - The object to be converted. May not be null depending on the elements to be sorted.

Returns:

The string representation of the object. May be null.