org.vishia.odt.readOdt

Class GetJavadocLabel

java.lang.Object

org.vishia.odt.readOdt.GetJavadocLabel

public class GetJavadocLabel
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	GetJavadocLabel.Link

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.Map<java.lang.String,GetJavadocLabel.Link>	idxClass2Html Index of all class names which are found in all '-javadoc=...' trees.
(package private) java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	idxHtmlFilesAnchors Index of Files, for which an index of all unique operation anchors are built already.
private org.vishia.msgDispatch.LogMessage	log

Constructor Summary

Constructors

Constructor and Description
GetJavadocLabel(org.vishia.msgDispatch.LogMessage log)

Method Summary

Modifier and Type	Method and Description
(package private) void	analyzeAllJavadocFiles(java.util.List<WriteOdt.DirPrepareJavadoc> listDirJavadoc, java.io.File fDirOdt)
(package private) java.util.Map<java.lang.String,java.lang.String>	createHtmlAnchorOperations(java.lang.String sHtml, java.io.File dirBase) Creates all labels to unique operations of the given html file.
void	reportClassesJavadoc(java.io.File fOut)

Methods inherited from class java.lang.Object

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

Field Detail

log

private org.vishia.msgDispatch.LogMessage log

idxHtmlFilesAnchors

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> idxHtmlFilesAnchors

Index of Files, for which an index of all unique operation anchors are built already. The inner Map is filled with #createHtmlAnchorOperations(String)

idxClass2Html

java.util.Map<java.lang.String,GetJavadocLabel.Link> idxClass2Html

Index of all class names which are found in all '-javadoc=...' trees. This allows to associate from a simple class name written as Java identifier to the link relative to local JavaDoc as also to the internet.

• This helps to find the correct link for a given class name in codeJava. 'codeJava' is a text block with <cJ:Class#field.> or <cJ:Class#operation(...).> or also <cJ:pkg.pkg1.Class.InnerClass#field.>. If this parts are found in ZmL a link is automatically created if the class is known here.
• The value String is the relative file name as it may be already evaluated in idxHtmlFilesAnchors respectively as used for the relative link, also manually written.
• It starts always with "./" as usual for the relative links in ZmL
• The key is built always from the primary class name of the file.
• Inner classes have the key "OuterClass.InnerClass". This should be given in a codeJava-text. Only the inner class name is not sufficient (because it may not be unique).
• Additionally the one and two package identifier are stored also. It means the same value is addressed also by the key "pkg1.ClassName" and "pkg2.pkg1.ClassName". This allows to write this string in Javacode text.
• Classes with the same name in different packages are not stored, because the name is not unique. But of course the "pkg.name" is stored. This should be used in codeJava text.

Constructor Detail

GetJavadocLabel

GetJavadocLabel(org.vishia.msgDispatch.LogMessage log)

Method Detail

createHtmlAnchorOperations

java.util.Map<java.lang.String,java.lang.String> createHtmlAnchorOperations(java.lang.String sHtml,
                                                                            java.io.File dirBase)
                                                                     throws java.io.IOException

Creates all labels to unique operations of the given html file.

Parameters:

sHtml -

dirBase -

Returns:

Throws:

java.io.IOException

analyzeAllJavadocFiles

void analyzeAllJavadocFiles(java.util.List<WriteOdt.DirPrepareJavadoc> listDirJavadoc,
                            java.io.File fDirOdt)
                     throws java.io.IOException

Throws:

java.io.IOException

reportClassesJavadoc

public void reportClassesJavadoc(java.io.File fOut)
                          throws java.io.IOException

Throws:

java.io.IOException