|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object nl.flotsam.pecia.builder.base.AbstractBuilder<T> nl.flotsam.pecia.builder.base.DefaultArticleBuilder<T>
public class DefaultArticleBuilder<T>
Constructor Summary | |
---|---|
DefaultArticleBuilder(DocumentBuilder builder,
T parent,
String title,
LifecycleListener listener)
|
Method Summary | |
---|---|
Author<AnnotatedArticle<T>> |
author()
Adds author metadata to the start of the article. |
AnnotatedArticle<T> |
copyright(String owner,
int... year)
Adds a copyright notice to the start of the article. |
Article<T> |
document(Documenter<SimpleContents<?>> target)
Generates documentation, and returns the current context. |
String |
getAuthorEmail()
|
String |
getAuthorFirstname()
|
String |
getAuthorSurname()
|
String |
getCopyright()
|
String |
getTitle()
|
ItemizedList<? extends Article<T>> |
itemizedList()
Adds an itemized list. |
ItemizedList<? extends Article<T>> |
orderedList()
Adds an ordered list. |
Para<? extends Article<T>> |
para()
Adds a paragraph. |
Article<T> |
para(String text)
Adds a paragraph ( Para ) containing the text passed in. |
AnnotatedSection<? extends Article<T>> |
section(String title)
Adds a new section. |
AnnotatedArticle<T> |
start()
|
Table2Cols<? extends Article<T>> |
table2Cols()
Adds a two-column table. |
Table3Cols<? extends Article<T>> |
table3Cols()
Adds a three-column table. |
Table4Cols<? extends Article<T>> |
table4Cols()
Adds a four-column table. |
Table5Cols<? extends Article<T>> |
table5Cols()
Adds a five-column table. |
Verbatim<? extends Article<T>> |
verbatim()
Adds verbatim content. |
Methods inherited from class nl.flotsam.pecia.builder.base.AbstractBuilder |
---|
end, getBuilder, getListener, getParent |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface nl.flotsam.pecia.DocumentElement |
---|
end, getParent |
Constructor Detail |
---|
public DefaultArticleBuilder(DocumentBuilder builder, T parent, String title, LifecycleListener listener)
Method Detail |
---|
public ItemizedList<? extends Article<T>> itemizedList()
SimpleContents
itemizedList
in interface SimpleContents<Article<T>>
public ItemizedList<? extends Article<T>> orderedList()
SimpleContents
orderedList
in interface SimpleContents<Article<T>>
public Para<? extends Article<T>> para()
SimpleContents
para
in interface SimpleContents<Article<T>>
public AnnotatedSection<? extends Article<T>> section(String title)
Contents
section
in interface Contents<Article<T>>
title
- The title of the section.
public Table2Cols<? extends Article<T>> table2Cols()
SimpleContents
table2Cols
in interface SimpleContents<Article<T>>
public Table3Cols<? extends Article<T>> table3Cols()
SimpleContents
table3Cols
in interface SimpleContents<Article<T>>
public Table4Cols<? extends Article<T>> table4Cols()
SimpleContents
table4Cols
in interface SimpleContents<Article<T>>
public Table5Cols<? extends Article<T>> table5Cols()
SimpleContents
table5Cols
in interface SimpleContents<Article<T>>
public Verbatim<? extends Article<T>> verbatim()
SimpleContents
verbatim
in interface SimpleContents<Article<T>>
public AnnotatedArticle<T> start()
start
in interface Initializer<AnnotatedArticle<T>>
public String getTitle()
getTitle
in interface ArticleBuilder<T>
public AnnotatedArticle<T> copyright(String owner, int... year)
AnnotatedArticle
copyright
in interface AnnotatedArticle<T>
owner
- The copyright holder.year
- The copyright year.
public String getCopyright()
public Author<AnnotatedArticle<T>> author()
AnnotatedArticle
author
in interface AnnotatedArticle<T>
Author
context, allowing you to add author metadata.public String getAuthorEmail()
getAuthorEmail
in interface ArticleBuilder<T>
public String getAuthorFirstname()
getAuthorFirstname
in interface ArticleBuilder<T>
public String getAuthorSurname()
getAuthorSurname
in interface ArticleBuilder<T>
public Article<T> para(String text)
SimpleContents
Para
) containing the text passed in.
para
in interface SimpleContents<Article<T>>
text
- The text to be added to the paragraph.
public Article<T> document(Documenter<SimpleContents<?>> target)
SimpleContents
document
in interface SimpleContents<Article<T>>
target
- The object generating the documentation.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |