TPTP 4.4.0 Platform Project
Public API Specification

org.eclipse.tptp.platform.analysis.core
Class AnalysisCorePlugin

java.lang.Object
  extended byorg.eclipse.core.runtime.Plugin
      extended byorg.eclipse.tptp.platform.analysis.core.AnalysisCorePlugin
All Implemented Interfaces:
org.osgi.framework.BundleActivator

public class AnalysisCorePlugin
extends org.eclipse.core.runtime.Plugin

The main plugin class to be used in the desktop.


Field Summary
 
Fields inherited from class org.eclipse.core.runtime.Plugin
PLUGIN_PREFERENCE_SCOPE, PREFERENCES_DEFAULT_OVERRIDE_BASE_NAME, PREFERENCES_DEFAULT_OVERRIDE_FILE_NAME
 
Constructor Summary
AnalysisCorePlugin()
          The constructor.
 
Method Summary
static java.lang.String encodeForXML(java.lang.String input)
          This utility method accepts a string and returns an equivalent string compliant with XML parsers
static AnalysisCorePlugin getDefault()
           
static java.net.URL getImageUrl(java.lang.String pluginId, java.lang.String filename)
          Obtain a URL for the pecified image
static java.lang.String getPluginId()
          Retrieves the unique identifier of this plug-in.
static java.lang.String replace(java.lang.String input, java.lang.String searchFor, java.lang.String replaceWith)
          This method replaces all instance of the searchFor string within the input string with a repaceWith string.
static java.lang.String replace(java.lang.String input, java.lang.String searchFor, java.lang.String replaceWith, int startPos)
          This method replaces all instance of the searchFor string within the input string with a repaceWith string.
 
Methods inherited from class org.eclipse.core.runtime.Plugin
find, find, getBundle, getDescriptor, getLog, getPluginPreferences, getStateLocation, initializeDefaultPluginPreferences, internalInitializeDefaultPluginPreferences, isDebugging, openStream, openStream, savePluginPreferences, setDebugging, shutdown, start, startup, stop, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AnalysisCorePlugin

public AnalysisCorePlugin()
The constructor.

Method Detail

getDefault

public static AnalysisCorePlugin getDefault()
Returns:
the shared plugin instance

getPluginId

public static java.lang.String getPluginId()
Retrieves the unique identifier of this plug-in.

Returns:
A non-empty string which is unique within the plug-in registry.

getImageUrl

public static java.net.URL getImageUrl(java.lang.String pluginId,
                                       java.lang.String filename)
Obtain a URL for the pecified image

Parameters:
pluginId - The id of the plugin that owns the image resource
filename - The relative file path to the image
Returns:
A URL for the specified image

encodeForXML

public static java.lang.String encodeForXML(java.lang.String input)
This utility method accepts a string and returns an equivalent string compliant with XML parsers

Parameters:
input - The raw input string
Returns:
String The converted string

replace

public static java.lang.String replace(java.lang.String input,
                                       java.lang.String searchFor,
                                       java.lang.String replaceWith,
                                       int startPos)
This method replaces all instance of the searchFor string within the input string with a repaceWith string. It starts at the specified start position within the input string.

Parameters:
input - The input string contain replacement tokens
searchFor - The string token being replaced
replaceWith - The string to replace tokens with
startPos - The starting position within the input string
Returns:
A string with replaced tokens

replace

public static java.lang.String replace(java.lang.String input,
                                       java.lang.String searchFor,
                                       java.lang.String replaceWith)
This method replaces all instance of the searchFor string within the input string with a repaceWith string.

Parameters:
input - The input string contain replacement tokens
searchFor - The string token being replaced
replaceWith - The string to replace tokens with
Returns:
A string with replaced tokens

TPTP 4.4.0 Platform Project
Public API Specification