org.eclipse.ptp.services.core
Class ServiceProvider

java.lang.Object
  PlatformObject
      org.eclipse.ptp.services.core.ServiceProvider

All Implemented Interfaces:

IServiceProvider, IServiceProviderDescriptor

Direct Known Subclasses:

ServiceProviderWorkingCopy

public abstract class ServiceProvider
extends PlatformObject
implements IServiceProvider, IServiceProviderDescriptor

An abstract base class for service provider implementations. EXPERIMENTAL. This class or interface has been added as part of a work in progress. There is no guarantee that this API will work or that it will remain the same. Please do not use this API without consulting with the RDT team.

Field Summary

protected ServiceModelManager

fManager

Constructor Summary

ServiceProvider()

Method Summary

IServiceProviderWorkingCopy	copy()
boolean	equals(Object obj)
boolean	getBoolean(String key, boolean defaultValue) Returns the boolean value of the given key.
String	getConfigurationString() Returns provider specific information for the current configuration.
IServiceProviderDescriptor	getDescriptor() Get the descriptor for this service provider
String	getId() Get the ID of this service provider, or null if this is a null provider.
int	getInt(String key, int defaultValue) Returns the int value of the given key.
String	getName() Get the name of this service provider, or null if this is a null provider.
Integer	getPriority() Get the priority for the the provider.
Map<String,String>	getProperties() Returns an unmodifiable view of the properties that apply to this service provider.
String	getServiceId() Get the service this service provider is for.
String	getString(String key, String defaultValue) Returns the string value of the given key.
int	hashCode()
protected void	internalSetProperties(Map<String,String> properties)
Set<String>	keySet() Returns a set of all the property keys that apply to this service provider.
void	putBoolean(String key, boolean value) Sets the value of the given key to the given boolean
void	putInt(String key, int value) Sets the value of the given key to the given int
void	putString(String key, String value) Sets the value of the given key to the given string
void	restoreState(IMemento memento) Restores the state of this provider from the given IMemento.
void	saveState(IMemento memento) Saves the state of this provider in the given IMemento.
void	setDescriptor(IServiceProviderDescriptor descriptor) Set the descriptor for this provider.
void	setProperties(Map<String,String> properties) Add the properties in the supplied map to the properties of the service provider.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ptp.services.core.IServiceProvider

isConfigured

Field Detail

fManager

protected ServiceModelManager fManager

Constructor Detail

ServiceProvider

public ServiceProvider()

Method Detail

copy

public IServiceProviderWorkingCopy copy()

Specified by:

copy in interface IServiceProvider

equals

public boolean equals(Object obj)

getBoolean

public boolean getBoolean(String key,
                          boolean defaultValue)

Description copied from interface: IServiceProvider

Returns the boolean value of the given key.

Specified by:

getBoolean in interface IServiceProvider

Parameters:

key - the key

defaultValue - The value to return if key not stored

Returns:

the value or defaultValue if no value was found

getConfigurationString

public String getConfigurationString()

Description copied from interface: IServiceProvider

Returns provider specific information for the current configuration.

Specified by:

getConfigurationString in interface IServiceProvider

Returns:

information on current configuration for this provider

getDescriptor

public IServiceProviderDescriptor getDescriptor()

Description copied from interface: IServiceProvider

Get the descriptor for this service provider

Specified by:

getDescriptor in interface IServiceProvider

Returns:

service provider descriptor

getId

public String getId()

Description copied from interface: IServiceProviderDescriptor

Get the ID of this service provider, or null if this is a null provider.

Specified by:

getId in interface IServiceProviderDescriptor

Returns:

ID of this service provider

getInt

public int getInt(String key,
                  int defaultValue)

Description copied from interface: IServiceProvider

Returns the int value of the given key.

Specified by:

getInt in interface IServiceProvider

Parameters:

key - the key

defaultValue - The value to return if key not stored

Returns:

the value or defaultValue if no value was found

getName

public String getName()

Description copied from interface: IServiceProviderDescriptor

Get the name of this service provider, or null if this is a null provider.

Specified by:

getName in interface IServiceProviderDescriptor

Returns:

name of this service provider

getPriority

public Integer getPriority()

Description copied from interface: IServiceProviderDescriptor

Get the priority for the the provider. Lower values have higher priority.

Specified by:

getPriority in interface IServiceProviderDescriptor

Returns:

priority

getProperties

public Map<String,String> getProperties()

Description copied from interface: IServiceProvider

Returns an unmodifiable view of the properties that apply to this service provider.

Specified by:

getProperties in interface IServiceProvider

Returns:

map containing the properties

getServiceId

public String getServiceId()

Description copied from interface: IServiceProviderDescriptor

Get the service this service provider is for.

Specified by:

getServiceId in interface IServiceProviderDescriptor

Returns:

service

getString

public String getString(String key,
                        String defaultValue)

Description copied from interface: IServiceProvider

Returns the string value of the given key.

Specified by:

getString in interface IServiceProvider

Parameters:

key - the key

defaultValue - The value to return if key not stored

Returns:

the value or defaultValue if no value was found

hashCode

public int hashCode()

keySet

public Set<String> keySet()

Description copied from interface: IServiceProvider

Returns a set of all the property keys that apply to this service provider.

Specified by:

keySet in interface IServiceProvider

putBoolean

public void putBoolean(String key,
                       boolean value)

Description copied from interface: IServiceProvider

Sets the value of the given key to the given boolean

Specified by:

putBoolean in interface IServiceProvider

Parameters:

key - the key

value - the value

putInt

public void putInt(String key,
                   int value)

Description copied from interface: IServiceProvider

Sets the value of the given key to the given int

Specified by:

putInt in interface IServiceProvider

Parameters:

key - the key

value - the value

putString

public void putString(String key,
                      String value)

Description copied from interface: IServiceProvider

Sets the value of the given key to the given string

Specified by:

putString in interface IServiceProvider

Parameters:

key - the key

value - the value

restoreState

public void restoreState(IMemento memento)

Restores the state of this provider from the given IMemento. NOTE: This should only be implemented if a provider wishes to override the default behavior.

Parameters:

memento - for restoring the provider's state.

saveState

public void saveState(IMemento memento)

Saves the state of this provider in the given IMemento. NOTE: This should only be implemented if a provider wishes to override the default behavior.

Parameters:

memento - for saving the provider's state.

setDescriptor

public void setDescriptor(IServiceProviderDescriptor descriptor)

Description copied from interface: IServiceProvider

Set the descriptor for this provider.

Specified by:

setDescriptor in interface IServiceProvider

Parameters:

descriptor - descriptor to set

setProperties

public void setProperties(Map<String,String> properties)

Description copied from interface: IServiceProvider

Add the properties in the supplied map to the properties of the service provider. Will replace any properties of the same name.

Specified by:

setProperties in interface IServiceProvider

Parameters:

properties - map containing the properties to be added.

internalSetProperties

protected void internalSetProperties(Map<String,String> properties)

Since:

2.1