hudson.plugins.timestamper

Class TimestampNote

java.lang.Object

hudson.console.ConsoleNote<Object>

hudson.plugins.timestamper.TimestampNote

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.console.ConsoleNote<?>>, Serializable

public final class TimestampNote
extends hudson.console.ConsoleNote<Object>

Time-stamp note that was inserted into the console note by the Timestamper plugin prior to version 1.4.

The time-stamps are now stored in a separate file, which allows a more compact format to be used. Having the timestamps in the console log file was also inconvenient when reading the file in a text editor.

It is possible to restore the old behaviour of inserting console notes by setting a system property: getSystemProperty(). This will allow scripts which expect to find the time-stamps within the console log file to continue working. New scripts should rely on the page served by TimestampsAction instead.

Author:

Steven G. Brown

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.console.ConsoleNote

POSTAMBLE, POSTAMBLE_STR, PREAMBLE, PREAMBLE_STR

Constructor Summary

Constructors

Constructor and Description
TimestampNote(long millisSinceEpoch) Create a new TimestampNote.

Method Summary

Methods

Modifier and Type	Method and Description
hudson.console.ConsoleAnnotator<Object>	annotate(Object context, hudson.MarkupText text, int charPos)
static String	getSystemProperty() Get the system property which will cause these console notes to be inserted into the console log file.
Timestamp	getTimestamp(hudson.model.Run<?,?> build) Get the time-stamp recorded by this console note.

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

TimestampNote

public TimestampNote(long millisSinceEpoch)

Create a new TimestampNote.

Parameters:

millisSinceEpoch - milliseconds since the epoch

Method Detail

getSystemProperty

public static String getSystemProperty()

Get the system property which will cause these console notes to be inserted into the console log file.

Returns:

the system property

getTimestamp

public Timestamp getTimestamp(hudson.model.Run<?,?> build)

Get the time-stamp recorded by this console note.

Parameters:

build - the build

Returns:

the time-stamp

annotate

public hudson.console.ConsoleAnnotator<Object> annotate(Object context,
                                               hudson.MarkupText text,
                                               int charPos)

Specified by:

annotate in class hudson.console.ConsoleNote<Object>