public interface IProfile extends IQueryable<IInstallableUnit>
IProfile
instance, but rather retain the profile id and obtain
the current state of the profile from the profile registry only when required.Modifier and Type | Field and Description |
---|---|
static int |
LOCK_NONE
Constant used to indicate that an installable unit is not locked in anyway.
|
static int |
LOCK_UNINSTALL
Constant used to indicate that an installable unit is locked so that it may
not be uninstalled.
|
static int |
LOCK_UPDATE
Constant used to indicate that an installable unit is locked so that it may
not be updated.
|
static String |
PROP_CACHE
Profile property constant indicating the bundle pool cache location.
|
static String |
PROP_CONFIGURATION_FOLDER
Profile property constant indicating the configuration folder for the profile.
|
static String |
PROP_DESCRIPTION
Profile property constant for a string property indicating a user visible short
textual description of this profile.
|
static String |
PROP_ENVIRONMENTS
Profile property constant indicating the list of environments
(e.g., OS, WS, ...) in which a profile can operate.
|
static String |
PROP_INSTALL_FEATURES
Profile property constant for a boolean property indicating if update features should
be installed in this profile
|
static String |
PROP_INSTALL_FOLDER
Profile property constant indicating the install folder for the profile.
|
static String |
PROP_LAUNCHER_CONFIGURATION
Profile property constant indicating the location of the launcher configuration file for the profile.
|
static String |
PROP_NAME
Profile property constant for a string property indicating a user visible name of this profile.
|
static String |
PROP_NL
Profile property constant indicating the installed language(s) for the profile.
|
static String |
PROP_PROFILE_LOCKED_IU
A property key (value
"org.eclipse.equinox.p2.type.lock" ) for an
integer property indicating how an installable unit is locked in its profile. |
static String |
PROP_PROFILE_ROOT_IU
A property key (value
"org.eclipse.equinox.p2.type.root" ) for a
boolean property indicating whether an installable unit should be considered
a root of the install. |
static String |
PROP_ROAMING
Profile property constant for a boolean property indicating if the profiling
is roaming.
|
static String |
PROP_SHARED_CACHE
Profile property constant indicating a shared read-only bundle pool cache location.
|
static String |
PROP_STATS_PARAMETERS
Profile property constant for additional parameters of the downloading stats(e.g., package=jee&os=linux).
|
static String |
STATE_PROP_HIDDEN
Profile state meta property key.
|
static String |
STATE_PROP_SHARED_INSTALL
Profile state metadata property key used to represent the state of the user profile when running in shared install.
|
static String |
STATE_PROP_TAG
Profile state metadata property key used to associate with a profile state a user readable name.
|
static String |
STATE_SHARED_INSTALL_VALUE_BEFOREFLUSH
Value to represent a user profile before it is being flushed because the base had changed.
|
static String |
STATE_SHARED_INSTALL_VALUE_INITIAL
Value to represent a user profile the first time it is created.
|
static String |
STATE_SHARED_INSTALL_VALUE_NEW
Value to represent the new user profile created once the base profile has been flushed.
|
Modifier and Type | Method and Description |
---|---|
IQueryResult<IInstallableUnit> |
available(IQuery<IInstallableUnit> query,
IProgressMonitor monitor)
Returns the installable units in this profile that match the given query.
|
Map<String,String> |
getInstallableUnitProperties(IInstallableUnit iu)
Returns an unmodifiable map of all profile properties associated with the given
installable unit in this profile.
|
String |
getInstallableUnitProperty(IInstallableUnit iu,
String key)
Returns the profile property associated with the given installable unit.
|
String |
getProfileId()
Returns the id of this profile, unique within a given profile registry
|
Map<String,String> |
getProperties()
Returns an unmodifiable map of all profile properties.
|
String |
getProperty(String key)
Returns the profile property associated with the given key,
or
null if this property is not present |
IProvisioningAgent |
getProvisioningAgent()
Returns the provisioning agent that manages this profile
|
long |
getTimestamp()
Returns a timestamp describing when this profile snapshot was created.
|
query
static final int LOCK_NONE
PROP_PROFILE_LOCKED_IU
,
Constant Field Valuesstatic final int LOCK_UNINSTALL
PROP_PROFILE_LOCKED_IU
,
Constant Field Valuesstatic final int LOCK_UPDATE
PROP_PROFILE_LOCKED_IU
,
Constant Field Valuesstatic final String PROP_PROFILE_LOCKED_IU
"org.eclipse.equinox.p2.type.lock"
) for an
integer property indicating how an installable unit is locked in its profile.
The integer is a bit-mask indicating the different locks defined on the installable
unit. The property should be obtained from a profile using
IProfile#getInstallableUnitProperty(IInstallableUnit, String).LOCK_UNINSTALL
,
LOCK_UPDATE
,
LOCK_NONE
,
Constant Field Valuesstatic final String PROP_PROFILE_ROOT_IU
"org.eclipse.equinox.p2.type.root"
) for a
boolean property indicating whether an installable unit should be considered
a root of the install. Typically this means the unit will appear to the end user
as a top-level installed item. The property should be obtained from a profile using
IProfile#getInstallableUnitProperty(IInstallableUnit, String).LOCK_UNINSTALL
,
LOCK_UPDATE
,
LOCK_NONE
,
Constant Field Valuesstatic final String PROP_INSTALL_FOLDER
static final String PROP_CONFIGURATION_FOLDER
static final String PROP_LAUNCHER_CONFIGURATION
static final String PROP_NL
static final String PROP_DESCRIPTION
null
, and
generally will be for non-top level install contexts.static final String PROP_NAME
null
, and generally will be for non-top level
install contexts.static final String PROP_ENVIRONMENTS
static final String PROP_ROAMING
static final String PROP_CACHE
static final String PROP_SHARED_CACHE
static final String PROP_INSTALL_FEATURES
static final String STATE_PROP_HIDDEN
true
would be a typical value.static final String STATE_PROP_TAG
static final String STATE_PROP_SHARED_INSTALL
STATE_SHARED_INSTALL_VALUE_INITIAL
, STATE_SHARED_INSTALL_VALUE_BEFOREFLUSH
or STATE_SHARED_INSTALL_VALUE_NEW
static final String STATE_SHARED_INSTALL_VALUE_INITIAL
static final String STATE_SHARED_INSTALL_VALUE_BEFOREFLUSH
static final String STATE_SHARED_INSTALL_VALUE_NEW
static final String PROP_STATS_PARAMETERS
IProvisioningAgent getProvisioningAgent()
String getProfileId()
String getProperty(String key)
null
if this property is not presentkey
- The property kidnull
String getInstallableUnitProperty(IInstallableUnit iu, String key)
iu
- the installable unit to return the property forkey
- the property keynull
if no such property is definedMap<String,String> getProperties()
Map<String,String> getInstallableUnitProperties(IInstallableUnit iu)
iu
- the installable unit to return profile properties forlong getTimestamp()
IQueryResult<IInstallableUnit> available(IQuery<IInstallableUnit> query, IProgressMonitor monitor)
query
- monitor
- a progress monitor, or null
if progress
reporting is not desired
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.