TPTP 4.2.0 Platform Project
Public API Specification

org.eclipse.hyades.automation.client
Class AutomationClient.Factory

java.lang.Object
  extended byorg.eclipse.hyades.automation.client.AutomationClient.Factory
Enclosing class:
AutomationClient

public static final class AutomationClient.Factory
extends java.lang.Object

The automation factory provides the public factory methods for all automation-related elements that provide the ability to substitute the actual concrete class to be used when creating instances. This will be supported by setting the appropriate properties in a configuration file. Downstream products can edit this file and provide an additional classpath and qualified-class to be used for creating concrete elements. All elements in the factory are returned and manipulated through their interfaces. (this part is not implemented in this release)


Method Summary
 AutomationClient createAutomationClient(Service.Executable strategy)
          Creates an automation client using the specified strategy and with one that requires no root specification (such as for in process and same instance sharing strategies or for strategy that can derive the root)
 AutomationClient createAutomationClient(java.lang.String root)
          Creates the automation client given the following root
 AutomationClient createAutomationClient(java.lang.String root, Service.Executable strategy)
          Creates the automation client to use given the root directory of Eclipse and the launching/execution strategy to use
static AutomationClient.Factory getInstance()
          Access the singleton factory
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static final AutomationClient.Factory getInstance()
Access the singleton factory

Returns:
the singleton factory

createAutomationClient

public AutomationClient createAutomationClient(Service.Executable strategy)
Creates an automation client using the specified strategy and with one that requires no root specification (such as for in process and same instance sharing strategies or for strategy that can derive the root)

Parameters:
strategy - the strategy to use for communicating between the automation client and server
Returns:
the automation client to use

createAutomationClient

public AutomationClient createAutomationClient(java.lang.String root)
Creates the automation client given the following root

Parameters:
root - the Eclipse root or home directory
Returns:
the automation client to use

createAutomationClient

public AutomationClient createAutomationClient(java.lang.String root,
                                               Service.Executable strategy)
Creates the automation client to use given the root directory of Eclipse and the launching/execution strategy to use

Parameters:
root - the Eclipse root directory
strategy - the launch/execution strategy to use for this automation client
Returns:
the automation client ready to use

TPTP 4.2.0 Platform Project
Public API Specification