org.jbehave.core.io

Class StoryFinder

java.lang.Object

org.jbehave.core.io.StoryFinder

public class StoryFinder
extends java.lang.Object

Finds stories by scanning source paths, which can be either filesystem directories or jars. Jars are identified by paths ending in ".jar". Stories can be either in the form of class names or story paths. Stories can be sorted by providing a sorting comparator.

Constructor Summary

Constructors

Constructor and Description
StoryFinder()
StoryFinder(java.util.Comparator<? super java.lang.String> sortingComparator)
StoryFinder(java.lang.String classNameExtension)

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	classNameExtension()
protected java.util.List<java.lang.String>	classNames(java.util.List<java.lang.String> paths)
java.util.List<java.lang.String>	findClassNames(java.lang.String searchIn, java.util.List<java.lang.String> includes, java.util.List<java.lang.String> excludes) Finds Java classes from a source path, allowing for includes/excludes, and converts them to class names.
java.util.List<java.lang.String>	findPaths(java.lang.String searchIn, java.util.List<java.lang.String> includes, java.util.List<java.lang.String> excludes) Finds paths from a source path, allowing for include/exclude patterns.
java.util.List<java.lang.String>	findPaths(java.lang.String searchIn, java.util.List<java.lang.String> includes, java.util.List<java.lang.String> excludes, java.lang.String prefixWith) Finds paths from a source path, allowing for includes/excludes.
java.util.List<java.lang.String>	findPaths(java.lang.String searchIn, java.lang.String[] includes, java.lang.String[] excludes) Finds paths from a source path, allowing for include/exclude patterns.
java.util.List<java.lang.String>	findPaths(java.lang.String searchIn, java.lang.String include, java.lang.String exclude) Finds paths from a source path, allowing for include/exclude patterns, which can be comma-separated values of multiple patterns.
java.util.List<java.lang.String>	findPaths(java.net.URL searchIn, java.util.List<java.lang.String> includes, java.util.List<java.lang.String> excludes) Finds paths from a source URL, allowing for includes/excludes patterns.
java.util.List<java.lang.String>	findPaths(java.net.URL searchIn, java.lang.String[] includes, java.lang.String[] excludes) Finds paths from a source URL, allowing for includes/excludes patterns.
java.util.List<java.lang.String>	findPaths(java.net.URL searchIn, java.lang.String include, java.lang.String exclude) Finds paths from a source URL, allowing for single include/exclude pattern.
protected java.util.List<java.lang.String>	normalise(java.util.List<java.lang.String> paths)
protected java.util.List<java.lang.String>	prefix(java.lang.String prefixWith, java.util.List<java.lang.String> paths)
protected java.util.List<java.lang.String>	scan(java.lang.String source, java.util.List<java.lang.String> includes, java.util.List<java.lang.String> excludes)
protected java.util.List<java.lang.String>	scanJar(java.lang.String jarPath, java.util.List<java.lang.String> includes, java.util.List<java.lang.String> excludes)
protected java.util.List<java.lang.String>	sort(java.util.List<java.lang.String> input)
protected java.util.Comparator<? super java.lang.String>	sortingComparator() Comparator used for sorting.

Methods inherited from class java.lang.Object

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

Constructor Detail

StoryFinder

public StoryFinder()

StoryFinder

public StoryFinder(java.lang.String classNameExtension)

StoryFinder

public StoryFinder(java.util.Comparator<? super java.lang.String> sortingComparator)

Method Detail

findClassNames

public java.util.List<java.lang.String> findClassNames(java.lang.String searchIn,
                                              java.util.List<java.lang.String> includes,
                                              java.util.List<java.lang.String> excludes)

Finds Java classes from a source path, allowing for includes/excludes, and converts them to class names.

Parameters:

searchIn - the path to search in

includes - the List of include patterns, or null if none

excludes - the List of exclude patterns, or null if none

Returns:

A List of class names found

findPaths

public java.util.List<java.lang.String> findPaths(java.net.URL searchIn,
                                         java.lang.String include,
                                         java.lang.String exclude)

Finds paths from a source URL, allowing for single include/exclude pattern. Paths found are normalised by StoryFinder#normalise(List)

Parameters:

searchIn - the source URL to search in

include - the include pattern, or "" if none

exclude - the exclude pattern, or "" if none

Returns:

A List of paths found

findPaths

public java.util.List<java.lang.String> findPaths(java.net.URL searchIn,
                                         java.lang.String[] includes,
                                         java.lang.String[] excludes)

Finds paths from a source URL, allowing for includes/excludes patterns. Paths found are normalised by StoryFinder#normalise(List)

Parameters:

searchIn - the source URL to search in

includes - the Array of include patterns, or null if none

excludes - the Array of exclude patterns, or null if none

Returns:

A List of paths found

findPaths

public java.util.List<java.lang.String> findPaths(java.lang.String searchIn,
                                         java.lang.String include,
                                         java.lang.String exclude)

Finds paths from a source path, allowing for include/exclude patterns, which can be comma-separated values of multiple patterns. Paths found are normalised by StoryFinder#normalise(List)

Parameters:

searchIn - the source path to search in

include - the CSV include pattern, or null if none

exclude - the CSV exclude pattern, or null if none

Returns:

A List of paths found

findPaths

public java.util.List<java.lang.String> findPaths(java.lang.String searchIn,
                                         java.lang.String[] includes,
                                         java.lang.String[] excludes)

Finds paths from a source path, allowing for include/exclude patterns. Paths found are normalised by StoryFinder#normalise(List)

Parameters:

searchIn - the source path to search in

includes - the Array of include patterns, or null if none

excludes - the Array of exclude patterns, or null if none

Returns:

A List of paths found

findPaths

public java.util.List<java.lang.String> findPaths(java.net.URL searchIn,
                                         java.util.List<java.lang.String> includes,
                                         java.util.List<java.lang.String> excludes)

Finds paths from a source URL, allowing for includes/excludes patterns. Paths found are normalised by StoryFinder#normalise(List)

Parameters:

searchIn - the source URL to search in

includes - the List of include patterns, or null if none

excludes - the List of exclude patterns, or null if none

Returns:

A List of paths found

findPaths

public java.util.List<java.lang.String> findPaths(java.lang.String searchIn,
                                         java.util.List<java.lang.String> includes,
                                         java.util.List<java.lang.String> excludes)

Finds paths from a source path, allowing for include/exclude patterns. Paths found are normalised by StoryFinder#normalise(List) .

Parameters:

searchIn - the source path to search in

includes - the List of include patterns, or null if none

excludes - the List of exclude patterns, or null if none

Returns:

A List of paths found

findPaths

public java.util.List<java.lang.String> findPaths(java.lang.String searchIn,
                                         java.util.List<java.lang.String> includes,
                                         java.util.List<java.lang.String> excludes,
                                         java.lang.String prefixWith)

Finds paths from a source path, allowing for includes/excludes. Paths found are prefixed with specified path by StoryFinder#prefix(String, List) and normalised by StoryFinder#normalise(List).

Parameters:

searchIn - the source path to search in

includes - the List of include patterns, or null if none

excludes - the List of exclude patterns, or null if none

prefixWith - the root path prefixed to all paths found, or null if none

Returns:

A List of paths found

normalise

protected java.util.List<java.lang.String> normalise(java.util.List<java.lang.String> paths)

prefix

protected java.util.List<java.lang.String> prefix(java.lang.String prefixWith,
                                      java.util.List<java.lang.String> paths)

classNames

protected java.util.List<java.lang.String> classNames(java.util.List<java.lang.String> paths)

classNameExtension

protected java.lang.String classNameExtension()

sort

protected java.util.List<java.lang.String> sort(java.util.List<java.lang.String> input)

sortingComparator

protected java.util.Comparator<? super java.lang.String> sortingComparator()

Comparator used for sorting. A null comparator means that Collections#sort() will use natural ordering.

Returns:

A Comparator or null for natural ordering.

scan

protected java.util.List<java.lang.String> scan(java.lang.String source,
                                    java.util.List<java.lang.String> includes,
                                    java.util.List<java.lang.String> excludes)

scanJar

protected java.util.List<java.lang.String> scanJar(java.lang.String jarPath,
                                       java.util.List<java.lang.String> includes,
                                       java.util.List<java.lang.String> excludes)