Index
All Classes and Interfaces|All Packages|Serialized Form
B
- build() - Method in class io.jenkins.plugins.prism.Marker.MarkerBuilder
-
Creates an immutable
Marker
instance using the configured properties.
C
- cleanup(Run<?, ?>, String, FilteredLog) - Method in enum class io.jenkins.plugins.prism.SourceCodeRetention
-
Cleanup the stored source code files of previous builds.
- clearRepeatableProperties() - Method in class io.jenkins.plugins.prism.PrismConfiguration
- COY - Enum constant in enum class io.jenkins.plugins.prism.PrismTheme
D
- DARK - Enum constant in enum class io.jenkins.plugins.prism.PrismTheme
- DescriptorImpl() - Constructor for class io.jenkins.plugins.prism.PermittedSourceCodeDirectory.DescriptorImpl
- DescriptorImpl() - Constructor for class io.jenkins.plugins.prism.SourceCodeDirectory.DescriptorImpl
- doCheckPath(AbstractProject<?, ?>, String) - Method in class io.jenkins.plugins.prism.SourceCodeDirectory.DescriptorImpl
-
Performs on-the-fly validation of the source code directory.
- doCheckPath(String) - Method in class io.jenkins.plugins.prism.PermittedSourceCodeDirectory.DescriptorImpl
-
Performs on-the-fly validation on the source code directory.
- doFillThemeItems() - Method in class io.jenkins.plugins.prism.PrismAppearanceConfiguration
-
Returns all available themes.
E
- equals(Object) - Method in class io.jenkins.plugins.prism.SourceCodeDirectory
- EVERY_BUILD - Enum constant in enum class io.jenkins.plugins.prism.SourceCodeRetention
-
Store source code files for all builds, never delete those files automatically.
F
- FieldValidator_Error_DefaultEncoding(Object) - Static method in class io.jenkins.plugins.prism.Messages
-
Key
FieldValidator.Error.DefaultEncoding
:Encoding must be a supported encoding of the Java platform, see: <a rel="noopener noreferrer" href="{0}">java.nio.charset.Charset</a>
. - FilePermissionEnforcer - Class in io.jenkins.plugins.prism
-
Enforces security restrictions for viewing files in Jenkins.
- FilePermissionEnforcer() - Constructor for class io.jenkins.plugins.prism.FilePermissionEnforcer
- fillItems() - Static method in enum class io.jenkins.plugins.prism.SourceCodeRetention
-
Returns all available
SourceCodeRetention
strategies as aListBoxModel
. - FUNKY - Enum constant in enum class io.jenkins.plugins.prism.PrismTheme
G
- getAllDisplayNames() - Static method in enum class io.jenkins.plugins.prism.PrismTheme
-
Returns all available themes in a
ListBoxModel
. - getCategory() - Method in class io.jenkins.plugins.prism.PrismAppearanceConfiguration
- getCategory() - Method in class io.jenkins.plugins.prism.PrismConfiguration
- getColumnEnd() - Method in class io.jenkins.plugins.prism.Marker
- getColumnStart() - Method in class io.jenkins.plugins.prism.Marker
- getDescription() - Method in class io.jenkins.plugins.prism.Marker
- getDisplayName() - Method in class io.jenkins.plugins.prism.PermittedSourceCodeDirectory.DescriptorImpl
- getDisplayName() - Method in enum class io.jenkins.plugins.prism.PrismTheme
- getDisplayName() - Method in class io.jenkins.plugins.prism.SourceCodeDirectory.DescriptorImpl
- getDisplayName() - Method in enum class io.jenkins.plugins.prism.SourceCodeRetention
- getDisplayName() - Method in class io.jenkins.plugins.prism.SourceCodeViewModel
- getFileName() - Method in enum class io.jenkins.plugins.prism.PrismTheme
- getIcon() - Method in class io.jenkins.plugins.prism.Marker
- getInstance() - Static method in class io.jenkins.plugins.prism.PrismAppearanceConfiguration
-
Returns the singleton instance of this
PrismAppearanceConfiguration
. - getInstance() - Static method in class io.jenkins.plugins.prism.PrismConfiguration
-
Returns the singleton instance of this
PrismConfiguration
. - getLineEnd() - Method in class io.jenkins.plugins.prism.Marker
- getLineStart() - Method in class io.jenkins.plugins.prism.Marker
- getOwner() - Method in class io.jenkins.plugins.prism.SourceCodeViewModel
-
Returns the build as owner of this view.
- getPath() - Method in class io.jenkins.plugins.prism.PermittedSourceCodeDirectory
- getPath() - Method in class io.jenkins.plugins.prism.SourceCodeDirectory
- getPermittedSourceDirectories(String, Set<String>, Set<String>, FilteredLog) - Method in class io.jenkins.plugins.prism.SourceDirectoryFilter
-
Filters the specified collection of additional source code directories so that only permitted source directories will be returned.
- getPrismConfiguration() - Method in class io.jenkins.plugins.prism.SourceCodeViewModel
- getSourceCode() - Method in class io.jenkins.plugins.prism.SourceCodeViewModel
-
Returns the colorized source code.
- getSourceDirectories() - Method in class io.jenkins.plugins.prism.PrismConfiguration
-
Returns the list of allowed source code directories.
- getTheme() - Method in class io.jenkins.plugins.prism.PrismAppearanceConfiguration
- getTheme() - Method in class io.jenkins.plugins.prism.PrismConfiguration
-
Deprecated.
- getTitle() - Method in class io.jenkins.plugins.prism.Marker
H
- hashCode() - Method in class io.jenkins.plugins.prism.SourceCodeDirectory
I
- io.jenkins.plugins.prism - package io.jenkins.plugins.prism
- isAllowedSourceDirectory(String) - Method in class io.jenkins.plugins.prism.PrismConfiguration
-
Returns whether the specified director is registered as permitted source code directory.
- isInWorkspace(String, FilePath, String...) - Method in class io.jenkins.plugins.prism.FilePermissionEnforcer
-
Checks whether the specified file is part of Jenkins' workspace or one of the permitted directories.
- isInWorkspace(String, FilePath, Set<String>) - Method in class io.jenkins.plugins.prism.FilePermissionEnforcer
-
Checks whether the specified file is part of Jenkins' workspace or one of the permitted directories.
L
- LAST_BUILD - Enum constant in enum class io.jenkins.plugins.prism.SourceCodeRetention
-
Store source code files of the last build, delete older artifacts.
M
- Marker - Class in io.jenkins.plugins.prism
-
Marks a line, some characters in a line, or a multi-line block in the source code.
- Marker.MarkerBuilder - Class in io.jenkins.plugins.prism
-
Creates
markers
using the builder pattern. - MarkerBuilder() - Constructor for class io.jenkins.plugins.prism.Marker.MarkerBuilder
- Messages - Class in io.jenkins.plugins.prism
-
Generated localization support class.
- Messages() - Constructor for class io.jenkins.plugins.prism.Messages
- MODIFIED - Enum constant in enum class io.jenkins.plugins.prism.SourceCodeRetention
-
Store only changed source code files for all builds, never delete those files automatically.
N
- NEVER - Enum constant in enum class io.jenkins.plugins.prism.SourceCodeRetention
-
Never store source code files.
O
- OKAIDIA - Enum constant in enum class io.jenkins.plugins.prism.PrismTheme
P
- PermittedSourceCodeDirectory - Class in io.jenkins.plugins.prism
-
Approved directory that contains source code files that can be shown in JenkinsĀ“ user interface.
- PermittedSourceCodeDirectory(String) - Constructor for class io.jenkins.plugins.prism.PermittedSourceCodeDirectory
-
Creates a new instance of
PermittedSourceCodeDirectory
. - PermittedSourceCodeDirectory.DescriptorImpl - Class in io.jenkins.plugins.prism
-
Descriptor to validate
PermittedSourceCodeDirectory
. - PRISM - Enum constant in enum class io.jenkins.plugins.prism.PrismTheme
- PrismAppearanceConfiguration - Class in io.jenkins.plugins.prism
-
Global system configuration for Prism.
- PrismAppearanceConfiguration() - Constructor for class io.jenkins.plugins.prism.PrismAppearanceConfiguration
-
Creates the global configuration and loads the initial values from the corresponding XML file.
- PrismConfiguration - Class in io.jenkins.plugins.prism
-
Global system configuration for Prism.
- PrismConfiguration() - Constructor for class io.jenkins.plugins.prism.PrismConfiguration
-
Creates the global configuration of source code directories and loads the initial values from the corresponding XML file.
- PrismTheme - Enum Class in io.jenkins.plugins.prism
-
Defines the active theme to be used when rendering the source code with Prism.
R
- render(DomContent) - Method in class io.jenkins.plugins.prism.Sanitizer
-
Renders the specified HTML code.
- render(String) - Method in class io.jenkins.plugins.prism.Sanitizer
-
Renders the specified HTML code.
S
- Sanitizer - Class in io.jenkins.plugins.prism
-
Sanitizes a piece of unsafe HTML code so that it can be rendered in a UI view.
- Sanitizer() - Constructor for class io.jenkins.plugins.prism.Sanitizer
- setSourceDirectories(List<PermittedSourceCodeDirectory>) - Method in class io.jenkins.plugins.prism.PrismConfiguration
-
Sets the list of source directories to the specified elements.
- setTheme(PrismTheme) - Method in class io.jenkins.plugins.prism.PrismAppearanceConfiguration
-
Sets the active theme to be used when rendering the source code with prism.
- SOLARIZED_LIGHT - Enum constant in enum class io.jenkins.plugins.prism.PrismTheme
- SourceCodeDirectory - Class in io.jenkins.plugins.prism
-
A relative or absolute directory that contains source code files that can be shown in JenkinsĀ“ user interface.
- SourceCodeDirectory(String) - Constructor for class io.jenkins.plugins.prism.SourceCodeDirectory
-
Creates a new instance of
SourceCodeDirectory
. - SourceCodeDirectory.DescriptorImpl - Class in io.jenkins.plugins.prism
-
Descriptor to validate
SourceCodeDirectory
. - SourceCodeRetention - Enum Class in io.jenkins.plugins.prism
-
Defines the retention strategy for source code files.
- SourceCodeRetention_EVERY_BUILD() - Static method in class io.jenkins.plugins.prism.Messages
-
Key
SourceCodeRetention.EVERY_BUILD
:Store source code of every build
. - SourceCodeRetention_LAST_BUILD() - Static method in class io.jenkins.plugins.prism.Messages
-
Key
SourceCodeRetention.LAST_BUILD
:Store source code of last build only
. - SourceCodeRetention_MODIFIED() - Static method in class io.jenkins.plugins.prism.Messages
-
Key
SourceCodeRetention.MODIFIED
:Store source code of modified files only
. - SourceCodeRetention_NEVER() - Static method in class io.jenkins.plugins.prism.Messages
-
Key
SourceCodeRetention.NEVER
:Never store source code
. - SourceCodeViewModel - Class in io.jenkins.plugins.prism
-
Renders a source code file with Prism syntax highlighting in a separate Jenkins view.
- SourceCodeViewModel(Run<?, ?>, String, Reader, Marker) - Constructor for class io.jenkins.plugins.prism.SourceCodeViewModel
-
Creates a new source code view model instance.
- SourceDirectoryFilter - Class in io.jenkins.plugins.prism
-
Filters source code directories that are not approved in Jenkins' global configuration.
- SourceDirectoryFilter() - Constructor for class io.jenkins.plugins.prism.SourceDirectoryFilter
T
- TOMORROW_NIGHT - Enum constant in enum class io.jenkins.plugins.prism.PrismTheme
- TWILIGHT - Enum constant in enum class io.jenkins.plugins.prism.PrismTheme
V
- valueOf(String) - Static method in enum class io.jenkins.plugins.prism.PrismTheme
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.jenkins.plugins.prism.SourceCodeRetention
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.jenkins.plugins.prism.PrismTheme
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.jenkins.plugins.prism.SourceCodeRetention
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- withColumnEnd(int) - Method in class io.jenkins.plugins.prism.Marker.MarkerBuilder
-
Defines the last column of this marker (columns start at 1).
- withColumnStart(int) - Method in class io.jenkins.plugins.prism.Marker.MarkerBuilder
-
Defines the first column of this marker (columns start at 1, 0 indicates the whole line).
- withDescription(String) - Method in class io.jenkins.plugins.prism.Marker.MarkerBuilder
-
Defines the title of the marker.
- withIcon(String) - Method in class io.jenkins.plugins.prism.Marker.MarkerBuilder
-
Defines the icon of the marker.
- withLineEnd(int) - Method in class io.jenkins.plugins.prism.Marker.MarkerBuilder
-
Defines the last line of this marker (lines start at 1).
- withLineStart(int) - Method in class io.jenkins.plugins.prism.Marker.MarkerBuilder
-
Defines the first line of this marker (lines start at 1; 0 indicates the whole file).
- withTitle(String) - Method in class io.jenkins.plugins.prism.Marker.MarkerBuilder
-
Defines the title of the marker.
_
- _FieldValidator_Error_DefaultEncoding(Object) - Static method in class io.jenkins.plugins.prism.Messages
-
Key
FieldValidator.Error.DefaultEncoding
:Encoding must be a supported encoding of the Java platform, see: <a rel="noopener noreferrer" href="{0}">java.nio.charset.Charset</a>
. - _SourceCodeRetention_EVERY_BUILD() - Static method in class io.jenkins.plugins.prism.Messages
-
Key
SourceCodeRetention.EVERY_BUILD
:Store source code of every build
. - _SourceCodeRetention_LAST_BUILD() - Static method in class io.jenkins.plugins.prism.Messages
-
Key
SourceCodeRetention.LAST_BUILD
:Store source code of last build only
. - _SourceCodeRetention_MODIFIED() - Static method in class io.jenkins.plugins.prism.Messages
-
Key
SourceCodeRetention.MODIFIED
:Store source code of modified files only
. - _SourceCodeRetention_NEVER() - Static method in class io.jenkins.plugins.prism.Messages
-
Key
SourceCodeRetention.NEVER
:Never store source code
.
All Classes and Interfaces|All Packages|Serialized Form
PrismAppearanceConfiguration
instead