biz.aQute.bnd.reporter.codesnippet

Class CodeSnippetExtractor

java.lang.Object

biz.aQute.bnd.reporter.codesnippet.CodeSnippetExtractor

public class CodeSnippetExtractor
extends Object

This class allows to extract code snippets from source codes contained in a set of directory paths.

A code snippet is a sample of source codes with a title and a short description that serves to illustrate a specific code usage. Code snippets can either provide a single snippet or contain a list of steps, each one with a title and a description.

Constructor Summary

Constructors

Constructor and Description
CodeSnippetExtractor() Construct a code snippet extractor.

Method Summary

Modifier and Type	Method and Description
List<CodeSnippetDTO>	extract(String... directoryPaths) Extract a list of code snippet by analyzing source codes contained in the directory paths given in argument.

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeSnippetExtractor

public CodeSnippetExtractor()

Construct a code snippet extractor.

Method Detail

extract

public List<CodeSnippetDTO> extract(String... directoryPaths)

Extract a list of code snippet by analyzing source codes contained in the directory paths given in argument.

Code snippets are ordered as they appear in the directories (files are first sorted in a lexicographic order).

Parameters:

directoryPaths - a list of directory paths from which code snippets are looked up.

Returns:

an ordered list of code snippets.