HyperlinkNote (Jenkins core 2.401.3 API)

java.lang.Object
- hudson.console.ConsoleNote
- - hudson.console.HyperlinkNote

All Implemented Interfaces:

ExtensionPoint, Describable, Serializable

Direct Known Subclasses:

ModelHyperlinkNote
```
public class HyperlinkNote
extends ConsoleNote
```
Turns a text into a hyperlink by specifying the URL separately.

Since:

1.362

Author:

Kohsuke Kawaguchi

See Also:

ModelHyperlinkNote, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class HyperlinkNote.DescriptorImpl
- Nested classes/interfaces inherited from interface hudson.ExtensionPoint
  ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary
- Fields inherited from class hudson.console.ConsoleNote
  INSECURE, POSTAMBLE, POSTAMBLE_STR, PREAMBLE, PREAMBLE_STR

Constructor Summary

Constructors
Constructor Description

HyperlinkNote(String url, int length)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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.
`static String`	`encodeTo(String url, String text)`
`protected String`	`extraAttributes()`

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
  - HyperlinkNote
```
public HyperlinkNote(String url,
                     int length)
```
- 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
    
    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.
  - extraAttributes
```
protected String extraAttributes()
```
  - encodeTo
```
public static String encodeTo(String url,
                              String text)
```