org.eclipse.update.configuration
Interface IInstallConfiguration
-
All Superinterfaces:
-
IAdaptable
Deprecated. The org.eclipse.update component has been replaced by Equinox p2. This
provisional API was never promoted to stable API, and may be removed from a future release of the platform.
-
public interface IInstallConfiguration
- extends
IAdaptable
Installation configuration.
Represents a specific configuration of a number of sites as a point
in time. Maintains a record of the specific activities that resulted
in this configuration. Current installation configuration is
the configuration the platform was started with.
Note: This class/interface is 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.
-
Since:
- 2.0
isCurrent
boolean isCurrent()
-
Deprecated.
- Indicates if this is the current configuration
-
-
-
Returns:
-
true if this is the current configuration,
false otherwise -
Since:
- 2.0
Note: This method is 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.
getConfiguredSites
IConfiguredSite[] getConfiguredSites()
-
Deprecated.
- Return the sites that are part of this configuration.
-
-
-
Returns:
- an array of configured sites, or an empty array.
-
Since:
- 2.0
Note: This method is 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.
createConfiguredSite
IConfiguredSite createConfiguredSite(
File directory)
throws
CoreException
-
Deprecated.
- Create a new installation site, based on a local file
system directory. Note, the site is not added to the
configuration as a result of this call.
-
-
-
Parameters:
-
directory - file directory
-
Returns:
- new site
-
Throws:
-
CoreException
-
Since:
- 2.0
Note: This method is 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.
createLinkedConfiguredSite
IConfiguredSite createLinkedConfiguredSite(
File directory)
throws
CoreException
-
Deprecated.
- Create a new linked site, based on a local file
system directory. Note, the site is not added to the
configuration as a result of this call.
The linked site is only created if the directory is an
already existing extension site and if it is not already
natively linked to the local site.
-
-
-
Parameters:
-
directory - file directory
-
Returns:
- new linked site
-
Throws:
-
CoreException
-
Since:
- 2.0
Note: This method is 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.
addConfiguredSite
void addConfiguredSite(
IConfiguredSite site)
-
Deprecated.
- Adds the specified site to this configuration.
-
-
-
Parameters:
-
site - new site -
Since:
- 2.0
Note: This method is 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.
removeConfiguredSite
void removeConfiguredSite(
IConfiguredSite site)
-
Deprecated.
- Removes the specified site from this configuration.
-
-
-
Parameters:
-
site - site to remove -
Since:
- 2.0
Note: This method is 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.
addInstallConfigurationChangedListener
void addInstallConfigurationChangedListener(
IInstallConfigurationChangedListener listener)
-
Deprecated.
- Adds a configuration change listener.
-
-
-
Parameters:
-
listener - the listener -
Since:
- 2.0
Note: This method is 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.
removeInstallConfigurationChangedListener
void removeInstallConfigurationChangedListener(
IInstallConfigurationChangedListener listener)
-
Deprecated.
- Removes a configuration change listener.
-
-
-
Parameters:
-
listener - the listener -
Since:
- 2.0
Note: This method is 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.
getActivities
IActivity[] getActivities()
-
Deprecated.
- Return the list of activities that resulted in this configuration.
There is always at least one activity
-
-
-
Returns:
- an array of activities
-
Since:
- 2.0
Note: This method is 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.
getCreationDate
Date getCreationDate()
-
Deprecated.
- Retrun the date the configuration was created.
-
-
-
Returns:
- create date
-
Since:
- 2.0
Note: This method is 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.
getLabel
String getLabel()
-
Deprecated.
- Return the configuration label.
-
-
-
Returns:
- the configuration label. If the configuration label was not
explicitly set, a default label is generated based on the creation
date
-
Since:
- 2.0
Note: This method is 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.
setLabel
void setLabel(
String label)
-
Deprecated.
- Sets the configuration label.
-
-
-
Parameters:
-
label - the label -
Since:
- 2.0
Note: This method is 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.
getTimeline
long getTimeline()
-
Deprecated.
- Returns an integer that represents a time stamp created at the beginning of a new configuration time line.
Time line is started when configuration state is created by a full file system reconciliation. All configurations
subsequently created will have the same time line until the next full reconciliation. Certain operations
(e.g. revert) make sense only between objects that belong to the same time line.
-
-
-
Returns:
- the time stamp of the full system reconciliation
Note: This method is 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.
-
Since:
- 2.0.2
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
