org.opendaylight.mdsal.binding.yang.unified.doc.generator

Class GeneratorImpl

java.lang.Object

org.opendaylight.mdsal.binding.yang.unified.doc.generator.GeneratorImpl

Direct Known Subclasses:

DocumentationGeneratorImpl

public class GeneratorImpl
extends Object

Constructor Summary

Constructors

Constructor and Description
GeneratorImpl()

Method Summary

Modifier and Type	Method and Description
CharSequence	anchorLink(CharSequence anchor, CharSequence text)
String	asRestconfPath(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier identifier)
String	asXmlPath(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier identifier)
String	augmentations(org.opendaylight.yangtools.yang.model.api.Module module, org.opendaylight.yangtools.yang.model.api.SchemaContext context)
CharSequence	body(org.opendaylight.yangtools.yang.model.api.Module module, org.opendaylight.yangtools.yang.model.api.SchemaContext ctx)
CharSequence	casesTree(Collection<org.opendaylight.yangtools.yang.model.api.CaseSchemaNode> nodes, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
CharSequence	childInfo(org.opendaylight.yangtools.yang.model.api.DataSchemaNode node, Map<org.opendaylight.yangtools.yang.model.api.SchemaPath,org.opendaylight.yangtools.yang.model.api.DataSchemaNode> childNodes)
CharSequence	childNodes(org.opendaylight.yangtools.yang.model.api.Module module)
CharSequence	childNodesInfoTree(Map<org.opendaylight.yangtools.yang.model.api.SchemaPath,org.opendaylight.yangtools.yang.model.api.DataSchemaNode> childNodes)
CharSequence	code(String string)
String	dataStore(org.opendaylight.yangtools.yang.model.api.Module module)
CharSequence	descAndRef(org.opendaylight.yangtools.yang.model.api.SchemaNode node)
CharSequence	descAndRefLi(org.opendaylight.yangtools.yang.model.api.SchemaNode node)
String	extensions(org.opendaylight.yangtools.yang.model.api.Module module)
String	features(org.opendaylight.yangtools.yang.model.api.Module module)
HashSet<File>	generate(org.sonatype.plexus.build.incremental.BuildContext buildContext, org.opendaylight.yangtools.yang.model.api.SchemaContext context, File targetPath, Set<org.opendaylight.yangtools.yang.model.api.Module> modulesToGen)
CharSequence	generate(org.opendaylight.yangtools.yang.model.api.Module module, org.opendaylight.yangtools.yang.model.api.SchemaContext ctx)
File	generateDocumentation(org.sonatype.plexus.build.incremental.BuildContext buildContext, org.opendaylight.yangtools.yang.model.api.Module module, org.opendaylight.yangtools.yang.model.api.SchemaContext ctx)
CharSequence	header(int level, org.opendaylight.yangtools.yang.common.QName name)
CharSequence	header(int level, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier name)
CharSequence	header(org.opendaylight.yangtools.yang.model.api.Module module)
CharSequence	listKeys(org.opendaylight.yangtools.yang.model.api.ListSchemaNode node)
CharSequence	localLink(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier identifier, CharSequence text)
String	notifications(org.opendaylight.yangtools.yang.model.api.Module module)
CharSequence	printBaseInfo(org.opendaylight.yangtools.yang.model.api.SchemaNode node)
CharSequence	printChildren(Iterable<org.opendaylight.yangtools.yang.model.api.DataSchemaNode> nodes, int level, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
CharSequence	printGrouping(org.opendaylight.yangtools.yang.model.api.GroupingDefinition grouping)
CharSequence	printInfo(org.opendaylight.yangtools.yang.model.api.SchemaNode node, String nodeType)
CharSequence	printSchemaNodeInfo(org.opendaylight.yangtools.yang.model.api.DataSchemaNode node)
CharSequence	printShortInfo(org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode node, int level, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
CharSequence	printShortInfo(org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode node, int level, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
CharSequence	printShortInfo(org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode node, int level, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
CharSequence	printShortInfo(org.opendaylight.yangtools.yang.model.api.LeafSchemaNode node, int level, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
CharSequence	printShortInfo(org.opendaylight.yangtools.yang.model.api.ListSchemaNode node, int level, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
CharSequence	printUses(org.opendaylight.yangtools.yang.model.api.UsesNode usesNode)
void	process(org.opendaylight.yangtools.yang.model.api.Module module)
String	rpcs(org.opendaylight.yangtools.yang.model.api.Module module)
CharSequence	schemaPathToId(org.opendaylight.yangtools.yang.model.api.SchemaPath path)
CharSequence	toBaseStmt(org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> baseType)
CharSequence	toLengthStmt(Optional<org.opendaylight.yangtools.yang.model.api.type.LengthConstraint> lengths)
CharSequence	toRangeStmt(Optional<? extends org.opendaylight.yangtools.yang.model.api.type.RangeConstraint<?>> constraint)
CharSequence	tree(org.opendaylight.yangtools.yang.model.api.Module module)
String	typeAnchorLink(org.opendaylight.yangtools.yang.model.api.SchemaPath path, CharSequence text)
String	typeDefinitions(org.opendaylight.yangtools.yang.model.api.Module module)
CharSequence	xmlExample(Iterable<org.opendaylight.yangtools.yang.model.api.DataSchemaNode> nodes, org.opendaylight.yangtools.yang.common.QName name, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
String	xmlExampleTag(org.opendaylight.yangtools.yang.common.QName name, CharSequence data)
CharSequence	xmplExampleTags(Iterable<org.opendaylight.yangtools.yang.model.api.DataSchemaNode> nodes, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier identifier)

Methods inherited from class java.lang.Object

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

Constructor Detail

GeneratorImpl

public GeneratorImpl()

Method Detail

generate

public HashSet<File> generate(org.sonatype.plexus.build.incremental.BuildContext buildContext,
                              org.opendaylight.yangtools.yang.model.api.SchemaContext context,
                              File targetPath,
                              Set<org.opendaylight.yangtools.yang.model.api.Module> modulesToGen)
                       throws IOException

Throws:

IOException

generateDocumentation

public File generateDocumentation(org.sonatype.plexus.build.incremental.BuildContext buildContext,
                                  org.opendaylight.yangtools.yang.model.api.Module module,
                                  org.opendaylight.yangtools.yang.model.api.SchemaContext ctx)

generate

public CharSequence generate(org.opendaylight.yangtools.yang.model.api.Module module,
                             org.opendaylight.yangtools.yang.model.api.SchemaContext ctx)

body

public CharSequence body(org.opendaylight.yangtools.yang.model.api.Module module,
                         org.opendaylight.yangtools.yang.model.api.SchemaContext ctx)

typeDefinitions

public String typeDefinitions(org.opendaylight.yangtools.yang.model.api.Module module)

dataStore

public String dataStore(org.opendaylight.yangtools.yang.model.api.Module module)

augmentations

public String augmentations(org.opendaylight.yangtools.yang.model.api.Module module,
                            org.opendaylight.yangtools.yang.model.api.SchemaContext context)

notifications

public String notifications(org.opendaylight.yangtools.yang.model.api.Module module)

rpcs

public String rpcs(org.opendaylight.yangtools.yang.model.api.Module module)

extensions

public String extensions(org.opendaylight.yangtools.yang.model.api.Module module)

features

public String features(org.opendaylight.yangtools.yang.model.api.Module module)

header

public CharSequence header(org.opendaylight.yangtools.yang.model.api.Module module)

schemaPathToId

public CharSequence schemaPathToId(org.opendaylight.yangtools.yang.model.api.SchemaPath path)

code

public CharSequence code(String string)

process

public void process(org.opendaylight.yangtools.yang.model.api.Module module)

tree

public CharSequence tree(org.opendaylight.yangtools.yang.model.api.Module module)

casesTree

public CharSequence casesTree(Collection<org.opendaylight.yangtools.yang.model.api.CaseSchemaNode> nodes,
                              org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)

childNodes

public CharSequence childNodes(org.opendaylight.yangtools.yang.model.api.Module module)

printSchemaNodeInfo

public CharSequence printSchemaNodeInfo(org.opendaylight.yangtools.yang.model.api.DataSchemaNode node)

typeAnchorLink

public String typeAnchorLink(org.opendaylight.yangtools.yang.model.api.SchemaPath path,
                             CharSequence text)

printBaseInfo

public CharSequence printBaseInfo(org.opendaylight.yangtools.yang.model.api.SchemaNode node)

printInfo

public CharSequence printInfo(org.opendaylight.yangtools.yang.model.api.SchemaNode node,
                              String nodeType)

printUses

public CharSequence printUses(org.opendaylight.yangtools.yang.model.api.UsesNode usesNode)

printGrouping

public CharSequence printGrouping(org.opendaylight.yangtools.yang.model.api.GroupingDefinition grouping)

printChildren

public CharSequence printChildren(Iterable<org.opendaylight.yangtools.yang.model.api.DataSchemaNode> nodes,
                                  int level,
                                  org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)

xmlExample

public CharSequence xmlExample(Iterable<org.opendaylight.yangtools.yang.model.api.DataSchemaNode> nodes,
                               org.opendaylight.yangtools.yang.common.QName name,
                               org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)

xmplExampleTags

public CharSequence xmplExampleTags(Iterable<org.opendaylight.yangtools.yang.model.api.DataSchemaNode> nodes,
                                    org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier identifier)

xmlExampleTag

public String xmlExampleTag(org.opendaylight.yangtools.yang.common.QName name,
                            CharSequence data)

header

public CharSequence header(int level,
                           org.opendaylight.yangtools.yang.common.QName name)

header

public CharSequence header(int level,
                           org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier name)

printShortInfo

public CharSequence printShortInfo(org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode node,
                                   int level,
                                   org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)

printShortInfo

public CharSequence printShortInfo(org.opendaylight.yangtools.yang.model.api.ListSchemaNode node,
                                   int level,
                                   org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)

printShortInfo

public CharSequence printShortInfo(org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode node,
                                   int level,
                                   org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)

printShortInfo

public CharSequence printShortInfo(org.opendaylight.yangtools.yang.model.api.LeafSchemaNode node,
                                   int level,
                                   org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)

printShortInfo

public CharSequence printShortInfo(org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode node,
                                   int level,
                                   org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)

anchorLink

public CharSequence anchorLink(CharSequence anchor,
                               CharSequence text)

localLink

public CharSequence localLink(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier identifier,
                              CharSequence text)

asXmlPath

public String asXmlPath(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier identifier)

asRestconfPath

public String asRestconfPath(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier identifier)

childNodesInfoTree

public CharSequence childNodesInfoTree(Map<org.opendaylight.yangtools.yang.model.api.SchemaPath,org.opendaylight.yangtools.yang.model.api.DataSchemaNode> childNodes)

childInfo

public CharSequence childInfo(org.opendaylight.yangtools.yang.model.api.DataSchemaNode node,
                              Map<org.opendaylight.yangtools.yang.model.api.SchemaPath,org.opendaylight.yangtools.yang.model.api.DataSchemaNode> childNodes)

listKeys

public CharSequence listKeys(org.opendaylight.yangtools.yang.model.api.ListSchemaNode node)

toLengthStmt

public CharSequence toLengthStmt(Optional<org.opendaylight.yangtools.yang.model.api.type.LengthConstraint> lengths)

toRangeStmt

public CharSequence toRangeStmt(Optional<? extends org.opendaylight.yangtools.yang.model.api.type.RangeConstraint<?>> constraint)

toBaseStmt

public CharSequence toBaseStmt(org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> baseType)

descAndRefLi

public CharSequence descAndRefLi(org.opendaylight.yangtools.yang.model.api.SchemaNode node)

descAndRef

public CharSequence descAndRef(org.opendaylight.yangtools.yang.model.api.SchemaNode node)