org.netbeans.modules.maven.api.output

Class OutputVisitor

java.lang.Object

org.netbeans.modules.maven.api.output.OutputVisitor

public final class OutputVisitor
extends Object

Is collecting line parsing information from all the registered Outputprocessors.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OutputVisitor.Context

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_PRIORITY property for success Action.
static String	ACTION_QUESTION property for success Action.

Constructor Summary

Constructors

Constructor and Description
OutputVisitor() Creates a new instance of OutputVisitor
OutputVisitor(OutputVisitor.Context context) Creates a new instance of OutputVisitor

Method Summary

Modifier and Type	Method and Description
Color	getColor()
Color	getColor(InputOutput io) Get the color.
OutputVisitor.Context	getContext()
String	getLine()
OutputListener	getOutputListener()
Action	getSuccessAction()
boolean	isImportant() at least one of the OutputProcessors added a OutputListener and marked it as important.
boolean	isLineSkipped()
void	resetVisitor() not to be called by the OutputProcessors.
void	setColor(Color color)
void	setLine(String line)
void	setOutputListener(OutputListener listener) add output line highlight and hyperlink via org.openide.windows.OutputListener instance.
void	setOutputListener(OutputListener listener, boolean isImportant) add output line highlight and hyperlink via org.openide.windows.OutputListener instance.
void	setOutputType(IOColors.OutputType outputType) Set output type that will be used in method OutputVisitor.getColor(org.openide.windows.InputOutput).
void	setSuccessAction(Action sAction) add an action that should be performed when the build finishes.
void	skipLine()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ACTION_QUESTION

public static final String ACTION_QUESTION

property for success Action. Holds question text.

See Also:

Constant Field Values

ACTION_PRIORITY

public static final String ACTION_PRIORITY

property for success Action. Priority of the action. From all collected actions one is used (the one with highest priority).

See Also:

Constant Field Values

Constructor Detail

OutputVisitor

public OutputVisitor()

Creates a new instance of OutputVisitor

OutputVisitor

public OutputVisitor(OutputVisitor.Context context)

Creates a new instance of OutputVisitor

Method Detail

resetVisitor

public void resetVisitor()

not to be called by the OutputProcessors.

getOutputListener

public OutputListener getOutputListener()

setOutputListener

public void setOutputListener(OutputListener listener)

add output line highlight and hyperlink via org.openide.windows.OutputListener instance.

setOutputListener

public void setOutputListener(OutputListener listener,
                              boolean isImportant)

add output line highlight and hyperlink via org.openide.windows.OutputListener instance.

Parameters:

isImportant - mark the line as important (useful in Nb 4.1 only)

isImportant

public boolean isImportant()

at least one of the OutputProcessors added a OutputListener and marked it as important.

getSuccessAction

public Action getSuccessAction()

setSuccessAction

public void setSuccessAction(Action sAction)

add an action that should be performed when the build finishes. Only one action will be performed, if more than one success actions are collected during processing, the one with highest value of property ACTION_PRIORITY is performed. Another property used is ACTION_QUESTION which holds text for Yes/No question. If user confirms, it's performed.

getLine

public String getLine()

setLine

public void setLine(String line)

skipLine

public void skipLine()

isLineSkipped

public boolean isLineSkipped()

getColor

public Color getColor(InputOutput io)

Get the color. If the output type was set using OutputVisitor.setOutputType(org.openide.windows.IOColors.OutputType), try to resolve the actual color. If the output type was not set, or the actual color cannot be resolved, return value that was set using OutputVisitor.setColor(java.awt.Color); supported.

Since:

maven/2.78

getColor

public Color getColor()

setColor

public void setColor(Color color)

setOutputType

public void setOutputType(IOColors.OutputType outputType)

Set output type that will be used in method OutputVisitor.getColor(org.openide.windows.InputOutput).

Since:

maven/2.78

getContext

@CheckForNull
public OutputVisitor.Context getContext()