hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-28 01:07:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

virtual_file.md: Cleanup

Browse Source
This commit is contained in:
Karol Lewandowski 2024-11-28 11:57:28 +01:00
parent dd78932007
commit 1391b5debc
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
topics/basics/architectural_overview/virtual_file.md
View File

@ -1,7 +1,7 @@
# Virtual Files
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. --> <!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# Virtual Files
<link-summary>Virtual Files represent local or remote files provided by the Virtual File System.</link-summary> <link-summary>Virtual Files represent local or remote files provided by the Virtual File System.</link-summary>
A [`VirtualFile`](%gh-ic%/platform/core-api/src/com/intellij/openapi/vfs/VirtualFile.java) (VF) is the IntelliJ Platform's representation of a file in a [Virtual File System (VFS)](virtual_file_system.md). A [`VirtualFile`](%gh-ic%/platform/core-api/src/com/intellij/openapi/vfs/VirtualFile.java) (VF) is the IntelliJ Platform's representation of a file in a [Virtual File System (VFS)](virtual_file_system.md).
@ -10,7 +10,7 @@ Most commonly, a virtual file is a file in a local file system.
However, the IntelliJ Platform supports multiple pluggable file system implementations, so virtual files can also represent classes in a JAR file, old revisions of files loaded from a version control repository, and so on. However, the IntelliJ Platform supports multiple pluggable file system implementations, so virtual files can also represent classes in a JAR file, old revisions of files loaded from a version control repository, and so on.
The VFS level deals only with binary content. The VFS level deals only with binary content.
Contents of a `VirtualFile` are treated as a stream of bytes, but concepts like encodings and line separators are handled on higher system levels. Contents of a `VirtualFile` are treated as a stream of bytes, but concepts like encodings and line separators are handled at higher system levels.
## How do I get a virtual file? ## How do I get a virtual file?
@ -52,7 +52,7 @@ If one needs to create a file through VFS, use `VirtualFile.createChildData()` t
## How do I get notified when VFS changes? ## How do I get notified when VFS changes?
> See [Virtual file system events](virtual_file_system.md#virtual-file-system-events) for important details. > See [](virtual_file_system.md#virtual-file-system-events) for important details.
> >
{style="note"} {style="note"}
@ -60,7 +60,8 @@ Implement [`BulkFileListener`](%gh-ic%/platform/core-api/src/com/intellij/openap
For example: For example:
```java ```java
project.getMessageBus().connect().subscribe(VirtualFileManager.VFS_CHANGES, project.getMessageBus().connect().subscribe(
VirtualFileManager.VFS_CHANGES,
new BulkFileListener() { new BulkFileListener() {
@Override @Override
public void after(@NotNull List<? extends VFileEvent> events) { public void after(@NotNull List<? extends VFileEvent> events) {
@ -89,7 +90,7 @@ To hook into operations performed in the local file system (for example, when de
## What are the rules for working with VFS? ## What are the rules for working with VFS?
See [Virtual File System](virtual_file_system.md) for a detailed description of the VFS architecture and usage guidelines. See [](virtual_file_system.md) for a detailed description of the VFS architecture and usage guidelines.
## How can I store additional metadata in files? ## How can I store additional metadata in files?