Package org.eclipse.pde.core.target
Class TargetBundle
- java.lang.Object
-
- org.eclipse.pde.core.target.TargetBundle
-
public class TargetBundle extends Object
Describes a single bundle in a target definition. Also used to represent content in the target that is missing or invalid.- Since:
- 3.8
-
-
Field Summary
Fields Modifier and Type Field Description protected BundleInfofInfoprotected booleanfIsFragmentprotected StringfSourcePathprotected BundleInfofSourceTargetstatic intSTATUS_FEATURE_DOES_NOT_EXISTStatus code indicating that this target bundle represents a required feature that is missing from a target definitionstatic intSTATUS_INVALID_MANIFESTStatus code indicating that a bundle's manifest could not be read, or did not exist.static intSTATUS_PLUGIN_DOES_NOT_EXISTStatus code indicating that this target bundle represents a required plug-in that is missing from a target definitionstatic intSTATUS_VERSION_DOES_NOT_EXISTStatus code indicating that a required bundle version does not exist (a bundle with the correct symbolic name is present, but the specified version was not found).
-
Constructor Summary
Constructors Modifier Constructor Description protectedTargetBundle()Constructs an empty target bundle with no information.TargetBundle(File bundleLocation)Constructs a target bundle for a local bundle.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BundleInfogetBundleInfo()Returns aBundleInfoobject containing additional information about the bundle this target bundle represents.StringgetSourcePath()Returns bundle relative path to old-style source folders, ornullif not applicable.BundleInfogetSourceTarget()If this bundle is a source bundle this method returns a bundle info representing the executable bundle that this bundle provides source for.IStatusgetStatus()Returns a status object describing any problems with this target bundle.booleanisFragment()Returns whether this bundle is a fragment.booleanisSourceBundle()Returnstrueif this bundle is a source bundle andfalseif this bundle is an executable bundle.StringtoString()
-
-
-
Field Detail
-
STATUS_PLUGIN_DOES_NOT_EXIST
public static final int STATUS_PLUGIN_DOES_NOT_EXIST
Status code indicating that this target bundle represents a required plug-in that is missing from a target definition- See Also:
- Constant Field Values
-
STATUS_FEATURE_DOES_NOT_EXIST
public static final int STATUS_FEATURE_DOES_NOT_EXIST
Status code indicating that this target bundle represents a required feature that is missing from a target definition- See Also:
- Constant Field Values
-
STATUS_VERSION_DOES_NOT_EXIST
public static final int STATUS_VERSION_DOES_NOT_EXIST
Status code indicating that a required bundle version does not exist (a bundle with the correct symbolic name is present, but the specified version was not found).- See Also:
- Constant Field Values
-
STATUS_INVALID_MANIFEST
public static final int STATUS_INVALID_MANIFEST
Status code indicating that a bundle's manifest could not be read, or did not exist.- See Also:
- Constant Field Values
-
fInfo
protected BundleInfo fInfo
-
fIsFragment
protected boolean fIsFragment
-
fSourceTarget
protected BundleInfo fSourceTarget
-
fSourcePath
protected String fSourcePath
-
-
Constructor Detail
-
TargetBundle
public TargetBundle(File bundleLocation) throws CoreException
Constructs a target bundle for a local bundle. The bundle may be a directory or an archive file. The manifest of the bundle will be read to collect the additional information.- Parameters:
bundleLocation- the location of the bundle (directory or archive) to open- Throws:
CoreException- if there is a problem opening the bundle or its manifest
-
TargetBundle
protected TargetBundle()
Constructs an empty target bundle with no information.
-
-
Method Detail
-
getBundleInfo
public BundleInfo getBundleInfo()
Returns aBundleInfoobject containing additional information about the bundle this target bundle represents. It is not guaranteed that the bundle info will have any fields set. The base implementation ofTargetBundlewill fill in the location, symbolic name and version if that information was available in the bundle's manifest.- Returns:
- a bundle info object with information on the bundle this target bundle represents
-
getStatus
public IStatus getStatus()
Returns a status object describing any problems with this target bundle. The base implementation ofTargetBundlewill always return an OK status.- Returns:
- status of this bundle
-
isSourceBundle
public boolean isSourceBundle()
Returnstrueif this bundle is a source bundle andfalseif this bundle is an executable bundle.- Returns:
- whether the resolved bundle is a source bundle
-
getSourceTarget
public BundleInfo getSourceTarget()
If this bundle is a source bundle this method returns a bundle info representing the executable bundle that this bundle provides source for. The returned bundle info may not have a symbolic name and version set if this source bundle is an old style source plug-in.- Returns:
- bundle info representing bundle this bundle provides source for or
null
-
isFragment
public boolean isFragment()
Returns whether this bundle is a fragment.- Returns:
- whether this bundle is a fragment
-
getSourcePath
public String getSourcePath()
Returns bundle relative path to old-style source folders, ornullif not applicable.- Returns:
- bundle relative path to old-style source folders, or
null
-
-