com.aptana.ide.core.io
Class ProtocolManager

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

All Implemented Interfaces:

java.lang.Comparable

Direct Known Subclasses:

FtpProtocolManager, LocalProtocolManager, ProjectProtocolManager

public abstract class ProtocolManager
extends java.lang.Object
implements java.lang.Comparable

Author:

Kevin Lindsey

Constructor Summary

ProtocolManager()
ProtocolManager

Method Summary

void	addFileManager(IVirtualFileManager fileManager) addFileManager
int	compareTo(java.lang.Object o)
abstract IVirtualFileManager	createFileManager() createFileManager
IVirtualFileManager	createFileManager(boolean addManager) createFileManager
abstract IVirtualFileManagerDialog	createPropertyDialog(org.eclipse.swt.widgets.Shell parent, int style) createPropertyDialog
java.lang.String	getDisplayName() getDisplayName
IVirtualFileManager	getFileManager(java.lang.String absolutePath) getFileManager
java.lang.String	getFileManagerName() getFileManagerName
abstract IVirtualFileManager[]	getFileManagers() getFileManagers
org.eclipse.swt.graphics.Image	getImage() getImage
abstract java.lang.String	getManagedType() getManagedType
static ProtocolManager	getProtocolManagerByName(java.lang.String name) Gets the correct protocol manager based on its hashName.
static ProtocolManager	getProtocolManagerByType(java.lang.String type) getProtocolManagerForType
static ProtocolManager[]	getPrototcolManagers() Gets an array of all known protocol managers.
abstract ProtocolManager	getStaticInstance() Returns an instance of the protocol manager
boolean	isHidden() isHidden
boolean	isRemote() Is remote protocol
void	removeFileManager(IVirtualFileManager fileManager) removeFileManager
void	setDisplayName(java.lang.String displayName) setDisplayName
void	setFileManagerName(java.lang.String fileManagerName) setFileManagerName
void	setHidden(boolean hidden) setHidden
void	setRemote(boolean remote) Sets a protocol as remote

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtocolManager

public ProtocolManager()

ProtocolManager

Method Detail

getDisplayName

public java.lang.String getDisplayName()

getDisplayName

Returns:

Returns the name displayed in the File View

getFileManagerName

public java.lang.String getFileManagerName()

getFileManagerName

Returns:

String

setDisplayName

public void setDisplayName(java.lang.String displayName)

setDisplayName

Parameters:

displayName - display name to set

setFileManagerName

public void setFileManagerName(java.lang.String fileManagerName)

setFileManagerName

Parameters:

fileManagerName - file manager name to set

getFileManagers

public abstract IVirtualFileManager[] getFileManagers()

getFileManagers

Returns:

Returns an array of file managers for this protocol

getManagedType

public abstract java.lang.String getManagedType()

getManagedType

Returns:

String

getFileManager

public IVirtualFileManager getFileManager(java.lang.String absolutePath)

getFileManager

Parameters:

absolutePath - the local path

Returns:

Returns the file manager that matches this base path

getImage

public org.eclipse.swt.graphics.Image getImage()

getImage

Returns:

Image

addFileManager

public void addFileManager(IVirtualFileManager fileManager)

addFileManager

Parameters:

fileManager -

removeFileManager

public void removeFileManager(IVirtualFileManager fileManager)

removeFileManager

Parameters:

fileManager -

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

See Also:

Comparable.compareTo(java.lang.Object)

createFileManager

public abstract IVirtualFileManager createFileManager()

createFileManager

Returns:

IVirtualFileManager

createFileManager

public IVirtualFileManager createFileManager(boolean addManager)

createFileManager

Parameters:

addManager - Add the manager to the protocolManager?

Returns:

IVirtualFileManager

createPropertyDialog

public abstract IVirtualFileManagerDialog createPropertyDialog(org.eclipse.swt.widgets.Shell parent,
                                                               int style)

createPropertyDialog

Parameters:

parent - the shell

style - the SWT property style

Returns:

IVirtualFileManagerDialog

getStaticInstance

public abstract ProtocolManager getStaticInstance()

Returns an instance of the protocol manager

Returns:

ProtocolManager

getProtocolManagerByName

public static ProtocolManager getProtocolManagerByName(java.lang.String name)

Gets the correct protocol manager based on its hashName.

Parameters:

name -

Returns:

ProtocolManager

getProtocolManagerByType

public static ProtocolManager getProtocolManagerByType(java.lang.String type)

getProtocolManagerForType

Parameters:

type -

Returns:

ProtocolManager

getPrototcolManagers

public static ProtocolManager[] getPrototcolManagers()

Gets an array of all known protocol managers.

Returns:

ProtocolManager[]

isHidden

public boolean isHidden()

isHidden

Returns:

boolean

setHidden

public void setHidden(boolean hidden)

setHidden

Parameters:

hidden -

isRemote

public boolean isRemote()

Is remote protocol

Returns:

true if remote protocol, false otherwise

setRemote

public void setRemote(boolean remote)

Sets a protocol as remote

Parameters:

remote - - true if remote