org.ballerinalang.langserver.compiler.workspace

Interface WorkspaceDocumentManager

All Known Implementing Classes:

ExtendedWorkspaceDocumentManagerImpl, WorkspaceDocumentManagerImpl

public interface WorkspaceDocumentManager

This represents a Document Manager for the workspace. Example, an in-memory document manager that keeps dirty files in-memory and will match the collection of files currently open in tool's workspace.

Method Summary

Modifier and Type	Method and Description
void	closeFile(Path filePath) Close the given file in document manager.
String	getFileContent(Path filePath) Gets uptodate content of the file.
boolean	isFileOpen(Path filePath) Checks whether the given file is open in workspace.
Optional<Lock>	lockFile(Path filePath) Acquire a file lock.
void	openFile(Path filePath, String content) Opens the given file in document manager.
void	updateFile(Path filePath, String updatedContent) Updates given file in document manager with new content.

Method Detail

isFileOpen

boolean isFileOpen(Path filePath)

Checks whether the given file is open in workspace.

Parameters:

filePath - Path of the file

Returns:

True if the given file is open

openFile

void openFile(Path filePath,
              String content)

Opens the given file in document manager.

Parameters:

filePath - Path of the file

content - Content of the file

updateFile

void updateFile(Path filePath,
                String updatedContent)

Updates given file in document manager with new content.

Parameters:

filePath - Path of the file

updatedContent - New content of the file

closeFile

void closeFile(Path filePath)

Close the given file in document manager.

Parameters:

filePath - Path of the file

getFileContent

String getFileContent(Path filePath)

Gets uptodate content of the file.

Parameters:

filePath - Path of the file

Returns:

Content of the file

lockFile

Optional<Lock> lockFile(Path filePath)

Acquire a file lock.

Parameters:

filePath - Path of the file

Returns:

lock or null