Package com.owenfeehan.pathpatternfinder.commonpath

Class FindCommonPathElements

Object

com.owenfeehan.pathpatternfinder.commonpath.FindCommonPathElements

public class FindCommonPathElements
extends Object

Finds common (left-most) elements among Paths.

Elements are common if they are present (from left to right) among all paths.

The root of the path (e.g. c:\) is treated as an element, if it is present.

Author:

Owen Feehan

Method Summary

Modifier and Type	Method	Description
static Optional<PathElements>	findForFilePaths(Iterable<Path> pathsToFiles)	Finds the common (left-most) elements among Paths.
static Optional<PathElements>	findForFilePaths(Iterable<Path> pathsToFiles, CasedStringComparer comparer)	Finds the common (left-most) elements among Paths, with a customizable means via a CasedStringComparer for comparing strings.
static Optional<PathElements>	findForFilePaths(Iterable<Path> pathsToFiles, IOCase ioCase)	Finds the common (left-most) elements among Paths, with a customizable means via an IOCase for comparing strings.

Methods inherited from class java.lang.Object

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

Method Details

findForFilePaths

public static Optional<PathElements> findForFilePaths(Iterable<Path> pathsToFiles)

Finds the common (left-most) elements among Paths.

Parameters:

pathsToFiles - paths to files

Returns:

the common path-elements among all of pathsToFiles, if any common elements exist.

Throws:

IllegalArgumentException - if pathsToFiles is empty.

findForFilePaths

public static Optional<PathElements> findForFilePaths(Iterable<Path> pathsToFiles, IOCase ioCase)

Finds the common (left-most) elements among Paths, with a customizable means via an IOCase for comparing strings.

Parameters:

pathsToFiles - paths to files

ioCase - whether to be case-sensitive or not in comparisons.

Returns:

the common path-elements among all of pathsToFiles, if any common elements exist.

Throws:

IllegalArgumentException - if pathsToFiles is empty.

findForFilePaths

public static Optional<PathElements> findForFilePaths(Iterable<Path> pathsToFiles, CasedStringComparer comparer)

Finds the common (left-most) elements among Paths, with a customizable means via a CasedStringComparer for comparing strings.

Parameters:

pathsToFiles - paths to files

comparer - how to compare two strings (whether to be case-sensitive or not).

Returns:

the common path-elements among all of pathsToFiles, if any common elements exist.

Throws:

IllegalArgumentException - if pathsToFiles is empty.