zserio.extension.doc

Class SymbolTemplateData

java.lang.Object

zserio.extension.doc.SymbolTemplateData

All Implemented Interfaces:

java.lang.Comparable<SymbolTemplateData>

public final class SymbolTemplateData
extends java.lang.Object
implements java.lang.Comparable<SymbolTemplateData>

FreeMarker template data for symbol used by Package emitter. Symbol holds all information needed to show correct hyperlink to the symbol.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SymbolTemplateData.HtmlLink

Constructor Summary

Constructors

Constructor and Description
SymbolTemplateData(java.lang.String name, java.lang.String typeName, java.lang.String htmlTitle)
SymbolTemplateData(java.lang.String name, java.lang.String typeName, java.lang.String htmlTitle, java.util.List<SymbolTemplateData> templateArguments)
SymbolTemplateData(java.lang.String name, java.lang.String typeName, java.lang.String htmlTitle, java.lang.String htmlLinkPage, java.lang.String htmlLinkAnchor)
SymbolTemplateData(java.lang.String name, java.lang.String typeName, java.lang.String htmlTitle, java.lang.String htmlLinkPage, java.lang.String htmlLinkAnchor, java.util.List<SymbolTemplateData> templateArguments)
SymbolTemplateData(java.lang.String name, java.lang.String typeName, java.lang.String htmlTitle, SymbolTemplateData.HtmlLink htmlLink, java.util.List<SymbolTemplateData> templateArguments)

Method Summary

Modifier and Type	Method and Description
int	compareTo(SymbolTemplateData other)
boolean	equals(java.lang.Object other)
SymbolTemplateData.HtmlLink	getHtmlLink()
java.lang.String	getHtmlTitle()
java.lang.String	getName()
java.lang.Iterable<SymbolTemplateData>	getTemplateArguments()
java.lang.String	getTypeName()
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

SymbolTemplateData

public SymbolTemplateData(java.lang.String name,
                          java.lang.String typeName,
                          java.lang.String htmlTitle,
                          java.lang.String htmlLinkPage,
                          java.lang.String htmlLinkAnchor)

SymbolTemplateData

public SymbolTemplateData(java.lang.String name,
                          java.lang.String typeName,
                          java.lang.String htmlTitle,
                          java.lang.String htmlLinkPage,
                          java.lang.String htmlLinkAnchor,
                          java.util.List<SymbolTemplateData> templateArguments)

SymbolTemplateData

public SymbolTemplateData(java.lang.String name,
                          java.lang.String typeName,
                          java.lang.String htmlTitle)

SymbolTemplateData

public SymbolTemplateData(java.lang.String name,
                          java.lang.String typeName,
                          java.lang.String htmlTitle,
                          java.util.List<SymbolTemplateData> templateArguments)

SymbolTemplateData

public SymbolTemplateData(java.lang.String name,
                          java.lang.String typeName,
                          java.lang.String htmlTitle,
                          SymbolTemplateData.HtmlLink htmlLink,
                          java.util.List<SymbolTemplateData> templateArguments)

Method Detail

compareTo

public int compareTo(SymbolTemplateData other)

Specified by:

compareTo in interface java.lang.Comparable<SymbolTemplateData>

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getName

public java.lang.String getName()

getTypeName

public java.lang.String getTypeName()

getHtmlTitle

public java.lang.String getHtmlTitle()

getHtmlLink

public SymbolTemplateData.HtmlLink getHtmlLink()

getTemplateArguments

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