OverlayResourceProvider class

A resource provider that allows clients to overlay the file system provided by a base resource provider. These overlays allow both the contents and modification stamps of files to be different than what the base resource provider would report.

This provider does not report watch events when overlays are added, modified or removed.

Implemented types

Constructors

OverlayResourceProvider(ResourceProvider baseProvider)
Initialize a newly created resource provider to represent an overlay on the given baseProvider.

Properties

baseProvider → ResourceProvider
The underlying resource provider used to access files and folders that do not have an overlay.
final
hashCode → int
The hash code for this object.
no setterinherited
pathContext → Context
Get the path context used by this resource provider.
no setteroverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

getFile(String path) → File
Return a File that corresponds to the given path.
override
getFolder(String path) → Folder
Return a Folder that corresponds to the given path.
override
getModificationTimes(List<Source> sources) → Future<List<int>>
Complete with a list of modification times for the given sources.
override
getResource(String path) → Resource
Return the Resource that corresponds to the given path.
override
getStateLocation(String pluginId) → Folder?
Return the folder in which the plugin with the given pluginId can store state that will persist across sessions. The folder returned for a given id will not be returned for a different id, ensuring that plugins do not need to be concerned with file name collisions with other plugins, assuming that the plugin ids are unique. The plugin ids must be valid folder names.
override
hasOverlay(String path) → bool
Return true if there is an overlay associated with the file at the given path.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeOverlay(String path) → bool
Remove any overlay of the file at the given path. The state of the file in the base resource provider will not be affected.
setOverlay(String path, {required String content, required int modificationStamp}) → void
Overlay the content of the file at the given path. The file will appear to have the given content and modificationStamp even if the file is modified in the base resource provider.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited