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
34

/*******************************************************************************
 * Copyright (c) 2012 Google, Inc.
 * 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  - initial API and implementation
 *******************************************************************************/
package org.eclipse.cdt.codan.core.externaltool;

/**
 * Parses the output of an external tool.
 *
 * @author alruiz@google.com (Alex Ruiz)
 */
public interface IOutputParser {
	/**
	 * Parses one line of output. Implementations are free to create markers from the information
	 * retrieved from the parsed output.
	 * @param line the line to parse.
	 * @return {@code true} if the line was successfully parsed; {@code false} otherwise.
	 * @throws InvocationFailure if the output indicates that the invocation of the external tool
	 *         failed.
	 */
	boolean parse(String line) throws InvocationFailure;

	/**
	 * Resets the value of this parser, usually after the execution of the external tool is
	 * finished.
	 */
	void reset();
}