Copyright (c) 2000, 2010 IBM Corporation and others.
This program and the accompanying materials
are made available under the terms of the Eclipse Public License 2.0
which accompanies this distribution, and is available at
https://www.eclipse.org/legal/epl-2.0/
SPDX-License-Identifier: EPL-2.0
Contributors:
    IBM Corporation - initial API and implementation
/*******************************************************************************
 * Copyright (c) 2000, 2010 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.debug.core.model;


import org.eclipse.debug.core.DebugException;
import org.eclipse.debug.core.IBreakpointListener;

A debug target is a debuggable execution context. For example, a debug target
may represent a debuggable process or a virtual machine. A debug target is the root
of the debug element hierarchy. A debug target contains threads. Minimally, a debug
target supports the following:

terminate
suspend/resume
breakpoints
disconnect


Generally, launching a debug session results in the creation of a
debug target. Launching is a client responsibility, as is debug target
creation.

Clients may implement this interface.

See Also:
ITerminate
ISuspendResume
IBreakpointListener
IDisconnect
IMemoryBlockRetrieval
ILaunch/**
 * A debug target is a debuggable execution context. For example, a debug target
 * may represent a debuggable process or a virtual machine. A debug target is the root
 * of the debug element hierarchy. A debug target contains threads. Minimally, a debug
 * target supports the following:
 * <ul>
 * <li>terminate
 * <li>suspend/resume
 * <li>breakpoints
 * <li>disconnect
 * </ul>
 * <p>
 * Generally, launching a debug session results in the creation of a
 * debug target. Launching is a client responsibility, as is debug target
 * creation.
 * <p>
 * Clients may implement this interface.
 * </p>
 * @see ITerminate
 * @see ISuspendResume
 * @see IBreakpointListener
 * @see IDisconnect
 * @see IMemoryBlockRetrieval
 * @see org.eclipse.debug.core.ILaunch
 */
public interface IDebugTarget extends IDebugElement, ITerminate, ISuspendResume, IBreakpointListener, IDisconnect, IMemoryBlockRetrieval {
	
Returns the system process associated with this debug target.
Returns:
the system process associated with this debug target/**
	 * Returns the system process associated with this debug target.
	 *
	 * @return the system process associated with this debug target
	 */
	IProcess getProcess();
	
Returns the threads contained in this debug target. An
empty collection is returned if this debug target contains
no threads.
Throws:
DebugException – if this method fails.  Reasons include:
Failure communicating with the debug target.  The DebugException's
status code contains the underlying exception responsible for
the failure.
Returns:
a collection of threads
Since:
2.0/**
	 * Returns the threads contained in this debug target. An
	 * empty collection is returned if this debug target contains
	 * no threads.
	 *
	 * @return a collection of threads
	 * @exception DebugException if this method fails.  Reasons include:
	 * <ul><li>Failure communicating with the debug target.  The DebugException's
	 * status code contains the underlying exception responsible for
	 * the failure.</li></ul>
	 * @since 2.0
	 */
	IThread[] getThreads() throws DebugException;

	
Returns whether this debug target currently contains any threads.
Throws:
DebugException – if this method fails.  Reasons include:
Failure communicating with the debug target.  The DebugException's
status code contains the underlying exception responsible for
the failure.
Returns:
whether this debug target currently contains any threads
Since:
2.0/**
	 * Returns whether this debug target currently contains any threads.
	 *
	 * @return whether this debug target currently contains any threads
	 * @exception DebugException if this method fails.  Reasons include:
	 * <ul><li>Failure communicating with the debug target.  The DebugException's
	 * status code contains the underlying exception responsible for
	 * the failure.</li></ul>
	 * @since 2.0
	 */
	boolean hasThreads() throws DebugException;

	
Returns the name of this debug target. Name format is debug model
specific, and should be specified by a debug model.
Throws:
DebugException – if this method fails.  Reasons include:
Failure communicating with the debug target.  The DebugException's
status code contains the underlying exception responsible for
the failure.
Returns:
this target's name/**
	 * Returns the name of this debug target. Name format is debug model
	 * specific, and should be specified by a debug model.
	 *
	 * @return this target's name
	 * @exception DebugException if this method fails.  Reasons include:
	 * <ul><li>Failure communicating with the debug target.  The DebugException's
	 * status code contains the underlying exception responsible for
	 * the failure.</li></ul>
	 */
	String getName() throws DebugException;

	
Returns whether this target can install the given breakpoint.
Params:
breakpoint – breakpoint to consider
Returns:
whether this target can install the given breakpoint/**
	 * Returns whether this target can install the given breakpoint.
	 *
	 * @param breakpoint breakpoint to consider
	 * @return whether this target can install the given breakpoint
	 */
	boolean supportsBreakpoint(IBreakpoint breakpoint);
}