com.aptana.ide.core.io
Class VirtualManagerBase

java.lang.Object
  com.aptana.ide.core.io.VirtualManagerBase

All Implemented Interfaces:

IVirtualFileManager, ISerializableSyncItem, java.lang.Comparable, java.util.EventListener, org.eclipse.jface.util.IPropertyChangeListener

Direct Known Subclasses:

FtpVirtualFileManager, LocalFileManager

public abstract class VirtualManagerBase
extends java.lang.Object
implements IVirtualFileManager, org.eclipse.jface.util.IPropertyChangeListener

Author:

Kevin Lindsey

Field Summary

Fields inherited from interface com.aptana.ide.core.io.sync.ISerializableSyncItem

DELIMITER, FILE_DELIMITER, OBJ_DELIMITER, SECTION_DELIMITER, TYPE_DELIMITER

Constructor Summary

VirtualManagerBase(ProtocolManager protocolManager)
VirtualManagerBase

Method Summary

void	addCloakedFile(IVirtualFile file) Sets a file as cloaked
void	addCloakExpression(java.lang.String fileExpression) Sets an expression to cloak all files that match the expression
void	addFileTransferListener(FileTransferListener listener) Add a listener for file transfer log events.
int	compareTo(java.lang.Object o)
protected IVirtualFile[]	deserializeCloakedFiles(java.lang.String items) Serialize a list of files
protected void	fireFileTransferEvent(java.lang.String logInfo) An event that contains transfer logging info as files are transfered.
protected boolean	fireGetFilesEvent(java.lang.String path) fireGetFilesEvent
java.lang.String[]	getCloakedFileExpressions() getCloakedFileExpressions
IVirtualFile[]	getCloakedFiles() getCloakedFiles
java.lang.String	getDescriptiveLabel() Returns a descriptive label for use when presenting this file manager
IVirtualFileManagerEventHandler	getEventHandler() getEventHandler
IVirtualFile[]	getFiles(IVirtualFile file) getFiles
static java.lang.String	getFileTypeCloakExpression(IVirtualFile element) Returns the expression used to cloak items of this type
long	getId() getId
java.lang.String	getNickName() Retrieve the name to use when displaying this file manager.
protected abstract org.eclipse.jface.preference.IPreferenceStore	getPreferenceStore() Returns the local preference store
ProtocolManager	getProtocolManager() getProtocolManager
long	getTimeOffset() getTimeOffset
boolean	isAutoCalculateServerTimeOffset() Do we auto-calculate the server time offset
boolean	isFileCloaked(IVirtualFile file) is a file cloaked?
boolean	isHidden() isHidden
boolean	isTransient() isTransient
boolean	isValid() Is the current file manager valid (meaning that the base path is valid)
void	propertyChange(org.eclipse.jface.util.PropertyChangeEvent event)
void	removeAllCloakExpressions() Removes all cloaked expressions
void	removeCloakedFile(IVirtualFile file) Remove a file as cloaked
void	removeCloakExpression(java.lang.String fileExpression) Removes an expression to cloak all files that match the expression
void	removeFileTransferListener(FileTransferListener listener) Remove a listener for file transfer log events.
void	resetTimeOffsetCache() Resets the time offset cache
protected java.lang.String	serializeCloakedFiles(IVirtualFile[] files) De-serialize a list of files
void	setAutoCalculateServerTimeOffset(boolean calculateOffset) Set if we auto-calculate the server time offset
void	setCloakedFiles(IVirtualFile[] files) setCloakedFiles
void	setEventHandler(IVirtualFileManagerEventHandler eventHandler) setEventHandler
void	setHidden(boolean hidden) setHidden
void	setId(long id) setId
void	setNickName(java.lang.String nickName) setNickName
void	setTimeOffset(long timeOffset) Sets the time offset
void	setTransient(boolean transient1) setTransient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aptana.ide.core.io.IVirtualFileManager

connect, containsFile, createLocalDirectory, createVirtualDirectory, createVirtualFile, deleteFile, disconnect, getBaseFile, getBasePath, getDisabledImage, getFiles, getFileSeparator, getFileTimeString, getGroup, getHashString, getImage, getOwner, getStream, hasFiles, isConnected, moveFile, putStream, putToLocalFile, refresh, renameFile, resolveBasePath, setBasePath, setDisabledImage, setGroup, setImage, setOwner

Methods inherited from interface com.aptana.ide.core.io.sync.ISerializableSyncItem

fromSerializableString, getType, toSerializableString

Constructor Detail

VirtualManagerBase

public VirtualManagerBase(ProtocolManager protocolManager)

VirtualManagerBase

Parameters:

protocolManager -

Method Detail

getEventHandler

public IVirtualFileManagerEventHandler getEventHandler()

getEventHandler

Specified by:

getEventHandler in interface IVirtualFileManager

Returns:

ISyncEventHandler

setEventHandler

public void setEventHandler(IVirtualFileManagerEventHandler eventHandler)

setEventHandler

Specified by:

setEventHandler in interface IVirtualFileManager

Parameters:

eventHandler -

fireGetFilesEvent

protected boolean fireGetFilesEvent(java.lang.String path)

fireGetFilesEvent

Parameters:

path -

Returns:

Returns true if the file listing should continue; otherwise, it is aborted.

getFiles

public IVirtualFile[] getFiles(IVirtualFile file)
                        throws ConnectionException,
                               java.io.IOException

Description copied from interface: IVirtualFileManager

getFiles

Specified by:

getFiles in interface IVirtualFileManager

Returns:

IVirtualFile[]

Throws:

java.io.IOException

ConnectionException

See Also:

IVirtualFileManager.getFiles(com.aptana.ide.core.io.IVirtualFile)

getNickName

public java.lang.String getNickName()

Description copied from interface: IVirtualFileManager

Retrieve the name to use when displaying this file manager. For example "www.myCoolWebSite.com"

Specified by:

getNickName in interface IVirtualFileManager

Returns:

Returns this file manager's name

See Also:

IVirtualFileManager.getNickName()

setNickName

public void setNickName(java.lang.String nickName)

Description copied from interface: IVirtualFileManager

setNickName

Specified by:

setNickName in interface IVirtualFileManager

See Also:

IVirtualFileManager.setNickName(java.lang.String)

getProtocolManager

public ProtocolManager getProtocolManager()

Description copied from interface: IVirtualFileManager

getProtocolManager

Specified by:

getProtocolManager in interface IVirtualFileManager

Returns:

Returns the protocol manager for this file manager

See Also:

IVirtualFileManager.getProtocolManager()

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

See Also:

Comparable.compareTo(java.lang.Object)

getId

public long getId()

Description copied from interface: IVirtualFileManager

getId

Specified by:

getId in interface IVirtualFileManager

Returns:

long

See Also:

IVirtualFileManager.getId()

setId

public void setId(long id)

Description copied from interface: IVirtualFileManager

setId

Specified by:

setId in interface IVirtualFileManager

See Also:

IVirtualFileManager.setId(long)

isHidden

public boolean isHidden()

Description copied from interface: IVirtualFileManager

isHidden

Specified by:

isHidden in interface IVirtualFileManager

Returns:

boolean

See Also:

IVirtualFileManager.isHidden()

setHidden

public void setHidden(boolean hidden)

Description copied from interface: IVirtualFileManager

setHidden

Specified by:

setHidden in interface IVirtualFileManager

See Also:

IVirtualFileManager.setHidden(boolean)

isTransient

public boolean isTransient()

Description copied from interface: IVirtualFileManager

isTransient

Specified by:

isTransient in interface IVirtualFileManager

Returns:

boolean

See Also:

IVirtualFileManager.isTransient()

setTransient

public void setTransient(boolean transient1)

Description copied from interface: IVirtualFileManager

setTransient

Specified by:

setTransient in interface IVirtualFileManager

See Also:

IVirtualFileManager.setTransient(boolean)

getDescriptiveLabel

public java.lang.String getDescriptiveLabel()

Description copied from interface: IVirtualFileManager

Returns a descriptive label for use when presenting this file manager

Specified by:

getDescriptiveLabel in interface IVirtualFileManager

Returns:

a string used by various views. Often includes the path.

See Also:

IVirtualFileManager.getDescriptiveLabel()

addFileTransferListener

public void addFileTransferListener(FileTransferListener listener)

Add a listener for file transfer log events.

Parameters:

listener -

removeFileTransferListener

public void removeFileTransferListener(FileTransferListener listener)

Remove a listener for file transfer log events.

Parameters:

listener -

fireFileTransferEvent

protected void fireFileTransferEvent(java.lang.String logInfo)

An event that contains transfer logging info as files are transfered.

Parameters:

logInfo -

setTimeOffset

public void setTimeOffset(long timeOffset)

Sets the time offset

Specified by:

setTimeOffset in interface IVirtualFileManager

Parameters:

timeOffset -

setAutoCalculateServerTimeOffset

public void setAutoCalculateServerTimeOffset(boolean calculateOffset)

Set if we auto-calculate the server time offset

Specified by:

setAutoCalculateServerTimeOffset in interface IVirtualFileManager

Parameters:

calculateOffset -

isAutoCalculateServerTimeOffset

public boolean isAutoCalculateServerTimeOffset()

Do we auto-calculate the server time offset

Specified by:

isAutoCalculateServerTimeOffset in interface IVirtualFileManager

Returns:

boolean

resetTimeOffsetCache

public void resetTimeOffsetCache()

Resets the time offset cache

Specified by:

resetTimeOffsetCache in interface IVirtualFileManager

getTimeOffset

public long getTimeOffset()
                   throws ConnectionException

getTimeOffset

Specified by:

getTimeOffset in interface IVirtualFileManager

Returns:

long

Throws:

ConnectionException

getCloakedFiles

public IVirtualFile[] getCloakedFiles()

getCloakedFiles

Specified by:

getCloakedFiles in interface IVirtualFileManager

Returns:

IVirtualFile[]

getCloakedFileExpressions

public java.lang.String[] getCloakedFileExpressions()

getCloakedFileExpressions

Specified by:

getCloakedFileExpressions in interface IVirtualFileManager

Returns:

String[]

setCloakedFiles

public void setCloakedFiles(IVirtualFile[] files)

setCloakedFiles

Specified by:

setCloakedFiles in interface IVirtualFileManager

Parameters:

files -

addCloakedFile

public void addCloakedFile(IVirtualFile file)

Sets a file as cloaked

Specified by:

addCloakedFile in interface IVirtualFileManager

Parameters:

file -

removeCloakedFile

public void removeCloakedFile(IVirtualFile file)

Remove a file as cloaked

Specified by:

removeCloakedFile in interface IVirtualFileManager

Parameters:

file -

addCloakExpression

public void addCloakExpression(java.lang.String fileExpression)

Sets an expression to cloak all files that match the expression

Specified by:

addCloakExpression in interface IVirtualFileManager

Parameters:

fileExpression -

removeCloakExpression

public void removeCloakExpression(java.lang.String fileExpression)

Removes an expression to cloak all files that match the expression

Specified by:

removeCloakExpression in interface IVirtualFileManager

Parameters:

fileExpression -

removeAllCloakExpressions

public void removeAllCloakExpressions()

Removes all cloaked expressions

isFileCloaked

public boolean isFileCloaked(IVirtualFile file)

is a file cloaked?

Specified by:

isFileCloaked in interface IVirtualFileManager

Parameters:

file -

Returns:

boolean

deserializeCloakedFiles

protected IVirtualFile[] deserializeCloakedFiles(java.lang.String items)

Serialize a list of files

Parameters:

items -

Returns:

IVirtualFile[]

serializeCloakedFiles

protected java.lang.String serializeCloakedFiles(IVirtualFile[] files)

De-serialize a list of files

Parameters:

files -

Returns:

String

propertyChange

public void propertyChange(org.eclipse.jface.util.PropertyChangeEvent event)

Specified by:

propertyChange in interface org.eclipse.jface.util.IPropertyChangeListener

See Also:

IPropertyChangeListener.propertyChange(org.eclipse.jface.util.PropertyChangeEvent)

getPreferenceStore

protected abstract org.eclipse.jface.preference.IPreferenceStore getPreferenceStore()

Returns the local preference store

Returns:

IPreferenceStore

getFileTypeCloakExpression

public static java.lang.String getFileTypeCloakExpression(IVirtualFile element)

Returns the expression used to cloak items of this type

Parameters:

element -

Returns:

Returns the string used to cloak items of this type

isValid

public boolean isValid()

Is the current file manager valid (meaning that the base path is valid)

Specified by:

isValid in interface IVirtualFileManager

Returns:

boolean