diff options
Diffstat (limited to 'codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/externaltool/IOutputParser.java')
| -rw-r--r-- | codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/externaltool/IOutputParser.java | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/externaltool/IOutputParser.java b/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/externaltool/IOutputParser.java new file mode 100644 index 00000000000..ddd460cb274 --- /dev/null +++ b/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/externaltool/IOutputParser.java @@ -0,0 +1,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(); +} |