Remote Systems
v6.4.1

com.ibm.etools.systems.core
Class SystemType

java.lang.Object
  extended bycom.ibm.etools.systems.core.SystemType

public class SystemType
extends Object

Represents a registered system type, as registered by the systemtype extension point. * Currently, only two pieces of information per type is recorded:
*

    *
  1. name. eg "Windows" *
  2. image. eg "windows.gif" *


Field Summary
static String copyright
           
 
Constructor Summary
SystemType(String name, ImageDescriptor image, ImageDescriptor connectedImage, boolean enableOffline, String description)
          Constructor * @param name - display name for this system type * @param image - image for this system type, not connected * @param connectedImage - image for this system type, when connected * @param enableOffline - whether to enable offline * @param description - translatable description of the system type
 
Method Summary
 boolean equals(Object o)
          Compare this system type to another one.
 ImageDescriptor getConnectedImage()
          Return the image for connections of this system type, when connected
 String getDefaultUserID()
          Return the default user ID preferences setting for this system type.
 String getDescription()
          Return the translatable description of this system type * @return a description of this system type.
 ImageDescriptor getImage()
          Return the image for connections of this system type, when not connected
 String getName()
          Return the display name for this system type * @return the name shown in the New Connection wizard for this system type.
static String getPreferenceStoreString(SystemType type)
          Helper method to produce a preferences string to save the settable information to disk
static SystemType getSystemType(SystemType[] allTypes, String name)
          Helper method... given a system type name, return its system type object
 int hashCode()
          Hash by name
 boolean isEnabled()
          Return true if this system type is currently enabled, meaning it shows * up in the New Connection wizard.
 boolean isEnableOffline()
          Return true if this system type supports offline mode or not * @return true if this system type supports offline mode
 void setDefaultUserID(String id)
          Set the default user ID for this system type.
 void setEnabled(boolean enabled)
          Specify if this system type is currently enabled, affecting if it shows up in * the New Connection wizard.
 void setEnableOffline(boolean enable)
          Configuration method
 String toString()
          Convert to a string.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Constructor Detail

SystemType

public SystemType(String name,
                  ImageDescriptor image,
                  ImageDescriptor connectedImage,
                  boolean enableOffline,
                  String description)
Constructor * @param name - display name for this system type * @param image - image for this system type, not connected * @param connectedImage - image for this system type, when connected * @param enableOffline - whether to enable offline * @param description - translatable description of the system type

Method Detail

toString

public String toString()
Convert to a string. Same as getName()


getName

public String getName()
Return the display name for this system type * @return the name shown in the New Connection wizard for this system type.


getDescription

public String getDescription()
Return the translatable description of this system type * @return a description of this system type. Might be null.


isEnableOffline

public boolean isEnableOffline()
Return true if this system type supports offline mode or not * @return true if this system type supports offline mode


setEnableOffline

public void setEnableOffline(boolean enable)
Configuration method. * Set whether this system type supports offline mode or not.


isEnabled

public boolean isEnabled()
Return true if this system type is currently enabled, meaning it shows * up in the New Connection wizard. User can affect this via preferences page. * @return true if this type is enabled


setEnabled

public void setEnabled(boolean enabled)
Specify if this system type is currently enabled, affecting if it shows up in * the New Connection wizard. User can affect this via preferences page.


getImage

public ImageDescriptor getImage()
Return the image for connections of this system type, when not connected


getConnectedImage

public ImageDescriptor getConnectedImage()
Return the image for connections of this system type, when connected


getDefaultUserID

public String getDefaultUserID()
Return the default user ID preferences setting for this system type.


setDefaultUserID

public void setDefaultUserID(String id)
Set the default user ID for this system type. This is a preferences value


equals

public boolean equals(Object o)
Compare this system type to another one. Compare by name.


hashCode

public int hashCode()
Hash by name


getSystemType

public static SystemType getSystemType(SystemType[] allTypes,
                                       String name)
Helper method... given a system type name, return its system type object


getPreferenceStoreString

public static String getPreferenceStoreString(SystemType type)
Helper method to produce a preferences string to save the settable information to disk


Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.