StarUML API

Modules (50)

FileIndex

Description

FileIndex is an internal module used by FileSystem to maintain an index of all files and directories.

This module is only used by FileSystem, and should not be called directly.

Classes Summary

Classes

Constructor

FileIndex

Properties
Methods

Properties

_index

Master index

Methods

addEntry

Add an entry.

entry FileSystemEntry
The entry to add.

clear

Clear the file index cache.

entryRenamed

Notify the index that an entry has been renamed. This updates all affected entries in the index.

oldPath string
newPath string
isDirectory boolean

getEntry

Returns the cached entry for the specified path, or undefined if the path has not been cached.

path string
The path of the entry to return.
Returns: File,Directory
The entry for the path, or undefined if it hasn't been cached yet.

removeEntry

Remove an entry.

entry FileSystemEntry
The entry to remove.

visitAll

Visits every entry in the entire index; no stopping condition.

Called non-nullable function(FileSystemEntry, string):void
with an entry and its fullPath