Package org.talend.sdk.component.tools

Class DocBaseGenerator

java.lang.Object

org.talend.sdk.component.tools.DocBaseGenerator

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

AsciidocDocumentationGenerator, DitaDocumentationGenerator

public abstract class DocBaseGenerator
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	DocBaseGenerator.ComponentDescription
protected static class	DocBaseGenerator.Condition
static class	DocBaseGenerator.Conditions
protected static class	DocBaseGenerator.Param
protected static class	DocBaseGenerator.UIInfo

Field Summary

Fields

Modifier and Type	Field	Description
protected final File[]	classes
protected final Log	log
protected final File	output

Method Summary

Modifier and Type	Method	Description
protected Predicate<Class<?>>	apiTester(Class<? extends Annotation> api)
protected Stream<DocBaseGenerator.ComponentDescription>	components()
protected abstract void	doRun()
protected String	emptyDefaultValue()
protected void	ensureParentExists(File output)
protected Stream<Class<?>>	findComponents(org.apache.xbean.finder.AnnotationFinder finder)
protected ResourceBundle	findResourceBundle(Class<?> component)
protected Locale	getLocale()
protected org.apache.xbean.finder.AnnotationFinder	newFinder()
final void	run()
protected void	write(File output, String content)

Methods inherited from class java.lang.Object

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

Field Details

log

protected final Log log

output

protected final File output

classes

protected final File[] classes

Method Details

run

public final void run()

doRun

protected abstract void doRun()

components

protected Stream<DocBaseGenerator.ComponentDescription> components()

findComponents

protected Stream<Class<?>> findComponents(org.apache.xbean.finder.AnnotationFinder finder)

write

protected void write(File output,
 String content)

ensureParentExists

protected void ensureParentExists(File output)

emptyDefaultValue

protected String emptyDefaultValue()

newFinder

protected org.apache.xbean.finder.AnnotationFinder newFinder()

apiTester

protected Predicate<Class<?>> apiTester(Class<? extends Annotation> api)

findResourceBundle

protected ResourceBundle findResourceBundle(Class<?> component)

getLocale

protected Locale getLocale()