Interface ILaunchTarget

  • All Superinterfaces:
    org.eclipse.core.runtime.IAdaptable
    All Known Subinterfaces:
    ILaunchTargetWorkingCopy
    All Known Implementing Classes:
    LaunchTarget, LaunchTargetWorkingCopy

    public interface ILaunchTarget
    extends org.eclipse.core.runtime.IAdaptable
    A launch target is a thing that a launch will run on. Launch targets are simple objects with the intention that the launch delegates and launches will adapt this object to an object that will assist in performing the launch.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ATTR_ARCH  
      static java.lang.String ATTR_OS  
      static ILaunchTarget NULL_TARGET
      The null target, which is the default when no other target is available.
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String getAttribute​(java.lang.String key, java.lang.String defValue)
      Return a string attribute of this target
      java.util.Map<java.lang.String,​java.lang.String> getAttributes()
      Returns a read-only map of the attributes.
      java.lang.String getId()
      The id for the target.
      default java.lang.String getName()
      Deprecated.
      this will be the same as the id
      java.lang.String getTypeId()
      The type of the target.
      ILaunchTargetWorkingCopy getWorkingCopy()
      Create a working copy of this launch target to allow setting of attributes.
      • Methods inherited from interface org.eclipse.core.runtime.IAdaptable

        getAdapter
    • Field Detail

      • NULL_TARGET

        static final ILaunchTarget NULL_TARGET
        The null target, which is the default when no other target is available.
    • Method Detail

      • getId

        java.lang.String getId()
        The id for the target. It is unique for each type.
        Returns:
        id for the target.
      • getName

        @Deprecated
        default java.lang.String getName()
        Deprecated.
        this will be the same as the id
        The user consumable name of the target.
        Returns:
        name of the target
      • getTypeId

        java.lang.String getTypeId()
        The type of the target.
        Returns:
        type of the target
      • getAttribute

        java.lang.String getAttribute​(java.lang.String key,
                                      java.lang.String defValue)
        Return a string attribute of this target
        Parameters:
        key - key
        defValue - default value
        Returns:
        value of attribute
      • getAttributes

        java.util.Map<java.lang.String,​java.lang.String> getAttributes()
        Returns a read-only map of the attributes.
        Returns:
        the attributes for this target
        Since:
        2.1
      • getWorkingCopy

        ILaunchTargetWorkingCopy getWorkingCopy()
        Create a working copy of this launch target to allow setting of attributes. It also allows changing the id, which results in a new launch target when saved.
        Returns:
        launch target working copy