Home

Contribute

Source code


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

/*******************************************************************************
 * Copyright (c) 2012 Google, Inc and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Alex Ruiz (Google) - initial API and implementation
 *******************************************************************************/
package org.eclipse.cdt.codan.core.externaltool;

/**
 * Creates or finds an Eclipse console that uses the name of an external tool as its own.
 *
 * @noimplement This interface is not intended to be implemented by clients.
 * @noextend This interface is not intended to be extended by clients.
 *
 * @author alruiz@google.com (Alex Ruiz)
 *
 * @since 2.1
 */
public interface IConsolePrinterProvider {
	/**
	 * Creates an Eclipse console that uses the name of an external tool as its own.
	 * @param externalToolName the name of the external tool that will be used as the name of the
	 *        console.
	 * @param shouldDisplayOutput indicates whether the user wants to see the output of the external
	 *        tool in the console.
	 * @return the created or found console.
	 */
	public IConsolePrinter createConsole(String externalToolName, boolean shouldDisplayOutput);
}