stream.doc

Class DocTree

java.lang.Object

stream.doc.DocTree

All Implemented Interfaces:

Comparable<DocTree>

public class DocTree
extends Object
implements Comparable<DocTree>

Author:

chris

Field Summary

Fields

Modifier and Type	Field and Description
(package private) SortedSet<DocTree>	children
(package private) static org.slf4j.Logger	log
(package private) String	name
(package private) DocTree	parent
(package private) String	prefix

Constructor Summary

Constructors

Constructor and Description
DocTree(String pkg)

Method Summary

Modifier and Type	Method and Description
void	add(DocTree child)
void	add(String[] path, DocTree child)
int	compareTo(DocTree arg0)
static DocTree	findDocs(Class<?>[] CLASSES, String[] patterns)
List<File>	generateDocs(File base)
private File	generateTex(File md)
DocTree	getChild(String n)
Set<DocTree>	getChildren()
static URL	getMarkDownFile(Class<?> clazz)
String	getPath()
String	getResourceName(String ext)
static URL	getTexFile(Class<?> clazz)
boolean	hasChild(String name)
boolean	isLeaf()
static boolean	matches(String[] patterns, Class<?> clazz)
void	print(String prefix)

Methods inherited from class java.lang.Object

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

Field Detail

log

static org.slf4j.Logger log

parent

DocTree parent

prefix

String prefix

name

final String name

children

final SortedSet<DocTree> children

Constructor Detail

DocTree

public DocTree(String pkg)

Method Detail

add

public void add(DocTree child)

getChildren

public Set<DocTree> getChildren()

add

public void add(String[] path,
                DocTree child)

getChild

public DocTree getChild(String n)

hasChild

public boolean hasChild(String name)

isLeaf

public boolean isLeaf()

compareTo

public int compareTo(DocTree arg0)

Specified by:

compareTo in interface Comparable<DocTree>

See Also:

Comparable.compareTo(java.lang.Object)

print

public void print(String prefix)

getPath

public String getPath()

generateDocs

public List<File> generateDocs(File base)
                        throws IOException

Throws:

IOException

getResourceName

public String getResourceName(String ext)

generateTex

private File generateTex(File md)

matches

public static boolean matches(String[] patterns,
                              Class<?> clazz)

findDocs

public static DocTree findDocs(Class<?>[] CLASSES,
                               String[] patterns)

getMarkDownFile

public static URL getMarkDownFile(Class<?> clazz)

getTexFile

public static URL getTexFile(Class<?> clazz)