Package io.jenkins.plugins.prism

Class SourceCodeViewModel

java.lang.Object

io.jenkins.plugins.prism.SourceCodeViewModel

All Implemented Interfaces:

ModelObject

public class SourceCodeViewModel
extends Object
implements ModelObject

Renders a source code file with Prism syntax highlighting in a separate Jenkins view. Optionally, highlights a marker in the source code: either a line, some characters in a line, or a multi-line block.

Author:

Ullrich Hafner

Constructor Summary

Constructors

Constructor	Description
SourceCodeViewModel(Run<?,?> owner, String fileName, Reader sourceCodeReader, Marker marker)	Creates a new source code view model instance.

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()
Run<?,?>	getOwner()	Returns the build as owner of this view.
PrismConfiguration	getPrismConfiguration()
String	getSourceCode()	Returns the colorized source code.

Methods inherited from class java.lang.Object

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

Constructor Details

SourceCodeViewModel

public SourceCodeViewModel(Run<?,?> owner,
 String fileName,
 Reader sourceCodeReader,
 Marker marker)

Creates a new source code view model instance.

Parameters:

owner - the current build as owner of this view

fileName - the file name of the shown content

sourceCodeReader - the source code file to show, provided by a Reader instance

marker - a block of lines (or a part of a line) to mark in the source code view

Method Details

getPrismConfiguration

public PrismConfiguration getPrismConfiguration()

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface ModelObject

getOwner

public Run<?,?> getOwner()

Returns the build as owner of this view.

Returns:

the build

getSourceCode

public String getSourceCode()

Returns the colorized source code.

Returns:

the source code