nl.flotsam.pecia
Interface AnnotatedArticle<T>

Type Parameters:
T - The outer context.
All Superinterfaces:
Article<T>, Contents<Article<T>>, DocumentElement<T>, SimpleContents<Article<T>>
All Known Subinterfaces:
ArticleBuilder<T>, ArticleDocument
All Known Implementing Classes:
DefaultArticleBuilder, DefaultArticleDocument

public interface AnnotatedArticle<T>
extends Article<T>

An annotated Article. Articles can have metadata. This interface allows you to add that metadata. Once you start adding content to the article, there is no way of turning back to the article's metadata.

Author:
Wilfred Springer

Method Summary
 Author<AnnotatedArticle<T>> author()
          Adds author metadata to the start of the article.
 AnnotatedArticle<T> copyright(String holder, int... year)
          Adds a copyright notice to the start of the article.
 
Methods inherited from interface nl.flotsam.pecia.Contents
section
 
Methods inherited from interface nl.flotsam.pecia.SimpleContents
document, itemizedList, orderedList, para, para, table2Cols, table3Cols, table4Cols, table5Cols, verbatim
 
Methods inherited from interface nl.flotsam.pecia.DocumentElement
end, getParent
 

Method Detail

author

Author<AnnotatedArticle<T>> author()
Adds author metadata to the start of the article.

Returns:
The Author context, allowing you to add author metadata.

copyright

AnnotatedArticle<T> copyright(String holder,
                              int... year)
Adds a copyright notice to the start of the article.

Parameters:
holder - The copyright holder.
year - The copyright year.
Returns:
This context.


Copyright © 2010. All Rights Reserved.