Package com.intellij.openapi.vfs.impl

Class VirtualFilePointerContainerImpl

java.lang.Object

com.intellij.openapi.util.TraceableDisposable

com.intellij.openapi.vfs.impl.VirtualFilePointerContainerImpl

All Implemented Interfaces:

Disposable, VirtualFilePointerContainer

public class VirtualFilePointerContainerImpl
extends TraceableDisposable
implements VirtualFilePointerContainer, Disposable

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JAR_DIRECTORY_ELEMENT
static java.lang.String	RECURSIVE_ATTR
static java.lang.String	URL_ATTR

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String url)
void	add(VirtualFile file)
void	addAll(java.util.Collection<java.lang.String> urls)
void	addAll(VirtualFilePointerContainer that)
void	addAllJarDirectories(java.util.Collection<java.lang.String> directoryUrls, boolean recursively) optimization: faster than calling addJarDirectory(String, boolean) one by one
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)
void	dispose() Usually not invoked directly, see class javadoc.
boolean	equals(java.lang.Object o)
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 VirtualFilePointerContainer.addJarDirectory(String, boolean) }
java.util.List<VirtualFilePointer>	getList()
java.lang.String []	getUrls()
int	hashCode()
boolean	isEmpty()
void	killAll()
void	moveDown(java.lang.String url)
void	moveUp(java.lang.String url)
void	readExternal(Element rootChild, java.lang.String childName, 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()
java.lang.String	toString()
void	writeExternal(Element element, java.lang.String childElementName, boolean externalizeJarDirectories)

Methods inherited from class com.intellij.openapi.util.TraceableDisposable

getStackTrace, kill, killExceptionally, throwDisposalError, throwObjectNotDisposedError

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

URL_ATTR

public static final java.lang.String URL_ATTR

See Also:

Constant Field Values

JAR_DIRECTORY_ELEMENT

public static final java.lang.String JAR_DIRECTORY_ELEMENT

See Also:

Constant Field Values

RECURSIVE_ATTR

public static final java.lang.String RECURSIVE_ATTR

See Also:

Constant Field Values

Method Detail

readExternal

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

Description copied from interface: VirtualFilePointerContainer

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

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

Specified by:

readExternal in interface VirtualFilePointerContainer

Throws:

InvalidDataException

writeExternal

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

Specified by:

writeExternal in interface VirtualFilePointerContainer

moveUp

public void moveUp(java.lang.String url)

Specified by:

moveUp in interface VirtualFilePointerContainer

moveDown

public void moveDown(java.lang.String url)

Specified by:

moveDown in interface VirtualFilePointerContainer

killAll

public void killAll()

Specified by:

killAll in interface VirtualFilePointerContainer

add

public void add(VirtualFile file)

Specified by:

add in interface VirtualFilePointerContainer

add

public void add(java.lang.String url)

Specified by:

add in interface VirtualFilePointerContainer

remove

public void remove(VirtualFilePointer pointer)

Specified by:

remove in interface VirtualFilePointerContainer

getList

public java.util.List<VirtualFilePointer> getList()

Specified by:

getList in interface VirtualFilePointerContainer

addAll

public void addAll(VirtualFilePointerContainer that)

Specified by:

addAll in interface VirtualFilePointerContainer

addAll

public void addAll(java.util.Collection<java.lang.String> urls)

getUrls

public java.lang.String [] getUrls()

Specified by:

getUrls in interface VirtualFilePointerContainer

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface VirtualFilePointerContainer

getFiles

public VirtualFile [] getFiles()

Specified by:

getFiles in interface VirtualFilePointerContainer

getDirectories

public VirtualFile [] getDirectories()

Specified by:

getDirectories in interface VirtualFilePointerContainer

findByUrl

public VirtualFilePointer findByUrl(java.lang.String url)

Specified by:

findByUrl in interface VirtualFilePointerContainer

clear

public void clear()

Specified by:

clear in interface VirtualFilePointerContainer

size

public int size()

Specified by:

size in interface VirtualFilePointerContainer

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public VirtualFilePointerContainer clone(Disposable parent)

Specified by:

clone in interface VirtualFilePointerContainer

clone

public VirtualFilePointerContainer clone(Disposable parent,
                                         VirtualFilePointerListener listener)

Specified by:

clone in interface VirtualFilePointerContainer

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

addJarDirectory

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

Description copied from interface: VirtualFilePointerContainer

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

Specified by:

addJarDirectory in interface VirtualFilePointerContainer

addAllJarDirectories

public void addAllJarDirectories(java.util.Collection<java.lang.String> directoryUrls,
                                 boolean recursively)

optimization: faster than calling addJarDirectory(String, boolean) one by one

removeJarDirectory

public boolean removeJarDirectory(java.lang.String directoryUrl)

Description copied from interface: VirtualFilePointerContainer

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

Specified by:

removeJarDirectory in interface VirtualFilePointerContainer

Returns:

true if removed

getJarDirectories

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

Description copied from interface: VirtualFilePointerContainer

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

Specified by:

getJarDirectories in interface VirtualFilePointerContainer