zserio.extension.doc

Class BeginPackageTemplateData

java.lang.Object

zserio.extension.doc.BeginPackageTemplateData

public final class BeginPackageTemplateData
extends java.lang.Object

FreeMarker template data for beginning of the package used by Package emitter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BeginPackageTemplateData.CompatibilityVersionTemplateData
static class	BeginPackageTemplateData.ImportTemplateData
static class	BeginPackageTemplateData.PackageSymbolOverviewTemplateData

Constructor Summary

Constructors

Constructor and Description
BeginPackageTemplateData(zserio.extension.doc.PackageTemplateDataContext context, Package pkg, java.util.Map<Package,java.util.List<AstNode>> nodesMap, HeaderNavigationTemplateData headerNavigation)

Method Summary

Modifier and Type	Method and Description
BeginPackageTemplateData.CompatibilityVersionTemplateData	getCompatibilityVersion()
java.lang.String	getCssDirectory()
DocCommentsTemplateData	getDocComments()
HeaderNavigationTemplateData	getHeaderNavigation()
java.lang.Iterable<BeginPackageTemplateData.ImportTemplateData>	getImportNodes()
boolean	getIsDefaultPackage()
java.lang.Iterable<BeginPackageTemplateData.PackageSymbolOverviewTemplateData>	getPackages()
java.lang.String	getStylesheetName()
SymbolTemplateData	getSymbol()
java.lang.Iterable<SymbolTemplateData>	getTocSymbols()

Methods inherited from class java.lang.Object

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

Constructor Detail

BeginPackageTemplateData

public BeginPackageTemplateData(zserio.extension.doc.PackageTemplateDataContext context,
                                Package pkg,
                                java.util.Map<Package,java.util.List<AstNode>> nodesMap,
                                HeaderNavigationTemplateData headerNavigation)
                         throws ZserioExtensionException

Throws:

ZserioExtensionException

Method Detail

getCssDirectory

public java.lang.String getCssDirectory()

getStylesheetName

public java.lang.String getStylesheetName()

getIsDefaultPackage

public boolean getIsDefaultPackage()

getSymbol

public SymbolTemplateData getSymbol()

getDocComments

public DocCommentsTemplateData getDocComments()

getHeaderNavigation

public HeaderNavigationTemplateData getHeaderNavigation()

getCompatibilityVersion

public BeginPackageTemplateData.CompatibilityVersionTemplateData getCompatibilityVersion()

getImportNodes

public java.lang.Iterable<BeginPackageTemplateData.ImportTemplateData> getImportNodes()

getPackages

public java.lang.Iterable<BeginPackageTemplateData.PackageSymbolOverviewTemplateData> getPackages()

getTocSymbols

public java.lang.Iterable<SymbolTemplateData> getTocSymbols()