org.jbehave.core.io
Class StoryFinder

java.lang.Object
  extended by org.jbehave.core.io.StoryFinder

public class StoryFinder
extends java.lang.Object

Finds stories by scanning file system. Stories can be either in the form of embeddable class names or story paths.


Constructor Summary
StoryFinder()
           
StoryFinder(java.util.Comparator<? super java.lang.String> sortingComparator)
           
StoryFinder(org.codehaus.plexus.util.DirectoryScanner scanner, java.lang.String classNameExtension, java.util.Comparator<? super java.lang.String> sortingComparator)
           
StoryFinder(java.lang.String classNameExtension)
           
 
Method Summary
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 searchInDirectory, java.util.List<java.lang.String> includes, java.util.List<java.lang.String> excludes)
          Finds java source paths from a base directory, allowing for includes/excludes, and converts them to class names.
 java.util.List<java.lang.String> findPaths(java.lang.String searchInDirectory, java.util.List<java.lang.String> includes, java.util.List<java.lang.String> excludes)
          Finds paths from a base directory, allowing for includes/excludes.
 java.util.List<java.lang.String> findPaths(java.lang.String searchInDirectory, java.util.List<java.lang.String> includes, java.util.List<java.lang.String> excludes, java.lang.String prefixWith)
          Finds paths from a base directory, allowing for includes/excludes.
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 basedir, 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)

StoryFinder

public StoryFinder(org.codehaus.plexus.util.DirectoryScanner scanner,
                   java.lang.String classNameExtension,
                   java.util.Comparator<? super java.lang.String> sortingComparator)
Method Detail

findClassNames

public java.util.List<java.lang.String> findClassNames(java.lang.String searchInDirectory,
                                                       java.util.List<java.lang.String> includes,
                                                       java.util.List<java.lang.String> excludes)
Finds java source paths from a base directory, allowing for includes/excludes, and converts them to class names.

Parameters:
searchInDirectory - the base directory 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.lang.String searchInDirectory,
                                                  java.util.List<java.lang.String> includes,
                                                  java.util.List<java.lang.String> excludes)
Finds paths from a base directory, allowing for includes/excludes. Paths found are normalised by StoryFinder#normalise(List).

Parameters:
searchInDirectory - the base directory 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 searchInDirectory,
                                                  java.util.List<java.lang.String> includes,
                                                  java.util.List<java.lang.String> excludes,
                                                  java.lang.String prefixWith)
Finds paths from a base directory, allowing for includes/excludes. Paths found are prefixed with specified path by StoryFinder#prefix(String, List) and normalised by StoryFinder#normalise(List).

Parameters:
searchInDirectory - the base directory 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 basedir,
                                                java.util.List<java.lang.String> includes,
                                                java.util.List<java.lang.String> excludes)


Copyright © 2003-2010. All Rights Reserved.