Package com.intellij.openapi.vfs.pointers

Interface VirtualFilePointerContainer

All Known Implementing Classes:

VirtualFilePointerContainerImpl

public interface VirtualFilePointerContainer

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String url)
void	add(VirtualFile file)
void	addAll(VirtualFilePointerContainer that)
void	addJarDirectory(java.lang.String directoryUrl, boolean recursively) Adds directory as a root of jar files.
void	clear()
VirtualFilePointerContainer	clone(Disposable parent)
VirtualFilePointerContainer	clone(Disposable parent, VirtualFilePointerListener listener)
VirtualFilePointer	findByUrl(java.lang.String url)
VirtualFile []	getDirectories()
VirtualFile []	getFiles()
java.util.List<Pair<java.lang.String,java.lang.Boolean>>	getJarDirectories() Returns list of (directory url, isRecursive) which were added via addJarDirectory(String, boolean) }
java.util.List<VirtualFilePointer>	getList()
java.lang.String []	getUrls()
boolean	isEmpty()
void	killAll()
void	moveDown(java.lang.String url)
void	moveUp(java.lang.String url)
void	readExternal(Element rootChild, java.lang.String childElementName, boolean externalizeJarDirectories) For example, to read from the xml below, call readExternal(myRootTag, "childElementName");
void	remove(VirtualFilePointer pointer)
boolean	removeJarDirectory(java.lang.String directoryUrl) Removes directory from the roots of jar files.
int	size()
void	writeExternal(Element element, java.lang.String childElementName, boolean externalizeJarDirectories)

Method Detail

killAll

void killAll()

add

void add(VirtualFile file)

add

void add(java.lang.String url)

remove

void remove(VirtualFilePointer pointer)

getList

java.util.List<VirtualFilePointer> getList()

addAll

void addAll(VirtualFilePointerContainer that)

getUrls

java.lang.String [] getUrls()

isEmpty

boolean isEmpty()

getFiles

VirtualFile [] getFiles()

getDirectories

VirtualFile [] getDirectories()

findByUrl

VirtualFilePointer findByUrl(java.lang.String url)

clear

void clear()

size

int size()

readExternal

void readExternal(Element rootChild,
                  java.lang.String childElementName,
                  boolean externalizeJarDirectories)
           throws InvalidDataException

For example, to read from the xml below, call readExternal(myRootTag, "childElementName");

 <myroot>
   <childElementName url="xxx1"/>
   <childElementName url="xxx2"/>
 </myroot>
 

Throws:

InvalidDataException

writeExternal

void writeExternal(Element element,
                   java.lang.String childElementName,
                   boolean externalizeJarDirectories)

moveUp

void moveUp(java.lang.String url)

moveDown

void moveDown(java.lang.String url)

clone

VirtualFilePointerContainer clone(Disposable parent)

clone

VirtualFilePointerContainer clone(Disposable parent,
                                  VirtualFilePointerListener listener)

addJarDirectory

void addJarDirectory(java.lang.String directoryUrl,
                     boolean recursively)

Adds directory as a root of jar files. After this call the getFiles() will additionally return jar files in this directory (and, if recursively was set, the jar files in all-subdirectories). getUrls() will additionally return the directoryUrl.

removeJarDirectory

boolean removeJarDirectory(java.lang.String directoryUrl)

Removes directory from the roots of jar files. After that the getFiles() and getUrls() etc will not return jar files in this directory anymore.

Returns:

true if removed

getJarDirectories

java.util.List<Pair<java.lang.String,java.lang.Boolean>> getJarDirectories()

Returns list of (directory url, isRecursive) which were added via addJarDirectory(String, boolean) }