FSInfo (NetBeans VCS API) - NetBeans API Javadoc 4.1.0

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.modules.vcscore.registry
Interface FSInfo

All Superinterfaces:: Serializable

public interface FSInfo
extends Serializable

Information of a registered filesystem.

Field Summary

static String PROP_CONTROL


static String PROP_ICON


static String PROP_ROOT


static String PROP_TYPE


Method Summary

void addPropertyChangeListener(PropertyChangeListener l)


void addVetoableChangeListener(VetoableChangeListener l)


void destroy()
          Destroy this filesystem info.

String getDisplayType()
          Get the type of the filesystem, that can be displayed as an additional information.

FileSystem getExistingFileSystem()
          Get the existing filesystem instance.

FileSystem getFileSystem()
          Get the filesystem instance.

File getFSRoot()
          Get the root of the filesystem.

Image getIcon()
          Get the icon, that can be used to visually present the filesystem.

boolean isControl()
          Get the control state.

void removePropertyChangeListener(PropertyChangeListener l)


void removeVetoableChangeListener(VetoableChangeListener l)


void setControl(boolean value)
          Determine whether filesystem should be under vcs control or not.

Field Detail

PROP_ROOT

public static final String PROP_ROOT

See Also:: Constant Field Values

PROP_TYPE

public static final String PROP_TYPE

See Also:: Constant Field Values

PROP_ICON

public static final String PROP_ICON

See Also:: Constant Field Values

PROP_CONTROL

public static final String PROP_CONTROL

See Also:: Constant Field Values

Method Detail

getFSRoot

public File getFSRoot()

Get the root of the filesystem.

getDisplayType

public String getDisplayType()

Get the type of the filesystem, that can be displayed as an additional information.

getIcon

public Image getIcon()

Get the icon, that can be used to visually present the filesystem.

isControl

public boolean isControl()

Get the control state. True when filesystem is under vcs control.

setControl

public void setControl(boolean value)
                throws IllegalStateException

Determine whether filesystem should be under vcs control or not.

Throws:: IllegalStateException - when the filesystem can not be enabled (e.g. it's module is disabled/not present).

getFileSystem

public FileSystem getFileSystem()

Get the filesystem instance. This method should create the filesystem if necessary. If the filesystem is still in use, return the same instance. When null is returned, this FS info is discarded.

Returns:: The filesystem instance or null, when the filesystem can not be retrieved or is no longer valid (e.g. it's setting was lost).

getExistingFileSystem

public FileSystem getExistingFileSystem()

Get the existing filesystem instance. No instances are created, the existing filesystem instance is retunted, if any, otherwise null.

destroy

public void destroy()

Destroy this filesystem info. This method is called when it's known that the FSInfo is no longer needed and will be discarded. This method should cleanup the filesystem, if necessary.

addVetoableChangeListener

public void addVetoableChangeListener(VetoableChangeListener l)

removeVetoableChangeListener

public void removeVetoableChangeListener(VetoableChangeListener l)

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)