hudson.console
Class HudsonExceptionNote

java.lang.Object
  hudson.console.ConsoleNote<Object>
      hudson.console.HudsonExceptionNote

All Implemented Interfaces:

ExtensionPoint, Describable<ConsoleNote<?>>, Serializable

public class HudsonExceptionNote
extends ConsoleNote<Object>

Placed on the beginning of the exception stack trace produced by Hudson, which in turn produces hyperlinked stack trace.

Exceptions in the user code (like junit etc) should be handled differently. This is only for exceptions that occur inside Hudson.

Since:

1.349

Author:

Kohsuke Kawaguchi

See Also:

Serialized Form

Nested Class Summary

static class

HudsonExceptionNote.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.console.ConsoleNote

POSTAMBLE, POSTAMBLE_STR, PREAMBLE, PREAMBLE_STR

Constructor Summary

HudsonExceptionNote()

Method Summary

ConsoleAnnotator

annotate(Object context, MarkupText text, int charPos) When the line of a console output that this annotation is attached is read by someone, a new ConsoleNote is de-serialized and this method is invoked to annotate that line.

Methods inherited from class hudson.console.ConsoleNote

encode, encodeTo, encodeTo, findPreamble, getDescriptor, readFrom, removeNotes, removeNotes, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

HudsonExceptionNote

public HudsonExceptionNote()

Method Detail

annotate

public ConsoleAnnotator annotate(Object context,
                                 MarkupText text,
                                 int charPos)

Description copied from class: ConsoleNote

When the line of a console output that this annotation is attached is read by someone, a new ConsoleNote is de-serialized and this method is invoked to annotate that line.

Specified by:

annotate in class ConsoleNote<Object>

Parameters:

context - The object that owns the console output in question.

text - Represents a line of the console output being annotated.

charPos - The character position in 'text' where this annotation is attached.

Returns:

if non-null value is returned, this annotator will handle the next line. this mechanism can be used to annotate multiple lines starting at the annotated position.