avail/avail.stacks/LinkingFileMap

LinkingFileMap

class LinkingFileMap

A holder for all categories in stacks

Author

Richard Arriaga

Constructors

LinkingFileMap

constructor()

Properties

aliasesToFileLink

val aliasesToFileLink: MutableMap<String, MutableSet<String>>

A map of aliases to file links.

categoryMethodList

val categoryMethodList: MutableMap<String, MutableList<Pair<String, String>>>

The map containing categories. Keyed by name to description.

categoryToDescription

val categoryToDescription: MutableMap<String, StacksDescription>

The map containing categories. Keyed by name to description.

internalLinks

var internalLinks: MutableMap<String, String>?

A map of aliases to file links.

moduleComments

val moduleComments: MutableSet<ModuleComment>

The list of ModuleComments for this compilation

namedFileLinks

val namedFileLinks: MutableMap<String, String>

A map of aliases to file links.

Functions

addAlias

fun addAlias(alias: String, fileLink: String)

addCategoryMethodPair

fun addCategoryMethodPair(categoryName: String, methodLeafName: String, methodAndMethodLink: String)

Add a new method to the category method map, categoryMethodList, Map,List,String>>>

addCategoryToDescription

fun addCategoryToDescription(name: String, description: StacksDescription)

Add a new category

addModuleComment

fun addModuleComment(comment: ModuleComment)

Add a ModuleComment.

addNamedFileLinks

fun addNamedFileLinks(alias: String, fileLink: String)

categoryMethodsToJson

fun categoryMethodsToJson(): String

Create a json file that has the categories' methods links.

clear

fun clear()

Clear the field maps.

internalLinks

fun internalLinks(links: MutableMap<String, String>)

isCategory

fun isCategory(key: String): Boolean

Check to see if key is a listed category.

writeCategoryDescriptionToJSON

fun writeCategoryDescriptionToJSON(path: Path, errorLog: StacksErrorLog)

A method that writes all the category comments discovered during parsing

writeCategoryLinksToJSON

fun writeCategoryLinksToJSON(path: Path)

A method that writes a JSON file of all the internal linking of Stacks files

writeInternalLinksToJSON

fun writeInternalLinksToJSON(path: Path)

A method that writes a JSON file of all the internal linking of Stacks files

writeModuleCommentsToJSON

fun writeModuleCommentsToJSON(path: Path, errorLog: StacksErrorLog)

A method that writes all the module comments discovered during parsing to a file