Package io.jenkins.plugins.checks.steps
Class PublishChecksStep.StepChecksAnnotation
- java.lang.Object
-
- hudson.model.AbstractDescribableImpl<PublishChecksStep.StepChecksAnnotation>
-
- io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAnnotation
-
- All Implemented Interfaces:
Describable<PublishChecksStep.StepChecksAnnotation>
,Serializable
- Enclosing class:
- PublishChecksStep
public static class PublishChecksStep.StepChecksAnnotation extends AbstractDescribableImpl<PublishChecksStep.StepChecksAnnotation> implements Serializable
A simple wrapper forChecksAnnotation
to allow users add code annotations byPublishChecksStep
.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PublishChecksStep.StepChecksAnnotation.StepChecksAnnotationDescriptor
Descriptor forPublishChecksStep.StepChecksAnnotation
, required for Pipeline Snippet Generator.
-
Constructor Summary
Constructors Constructor Description StepChecksAnnotation(String path, int startLine, int endLine, String message)
Creates an annotation with required parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ChecksAnnotation
getAnnotation()
GetChecksAnnotation
built with user-provided parameters inPublishChecksStep
.ChecksAnnotation.ChecksAnnotationLevel
getAnnotationLevel()
Integer
getEndColumn()
int
getEndLine()
String
getMessage()
String
getPath()
String
getRawDetails()
Integer
getStartColumn()
int
getStartLine()
String
getTitle()
void
setAnnotationLevel(ChecksAnnotation.ChecksAnnotationLevel annotationLevel)
void
setEndColumn(Integer endColumn)
void
setRawDetails(String rawDetails)
void
setStartColumn(Integer startColumn)
void
setTitle(String title)
-
Methods inherited from class hudson.model.AbstractDescribableImpl
getDescriptor
-
-
-
-
Constructor Detail
-
StepChecksAnnotation
@DataBoundConstructor public StepChecksAnnotation(String path, int startLine, int endLine, String message)
Creates an annotation with required parameters.- Parameters:
path
- path of the file to annotatestartLine
- start line of the annotationendLine
- end line of the annotationmessage
- annotation message
-
-
Method Detail
-
setStartColumn
@DataBoundSetter public void setStartColumn(Integer startColumn)
-
setEndColumn
@DataBoundSetter public void setEndColumn(Integer endColumn)
-
setTitle
@DataBoundSetter public void setTitle(String title)
-
setRawDetails
@DataBoundSetter public void setRawDetails(String rawDetails)
-
setAnnotationLevel
@DataBoundSetter public void setAnnotationLevel(ChecksAnnotation.ChecksAnnotationLevel annotationLevel)
-
getPath
public String getPath()
-
getStartLine
public int getStartLine()
-
getEndLine
public int getEndLine()
-
getMessage
public String getMessage()
-
getStartColumn
@CheckForNull public Integer getStartColumn()
-
getEndColumn
@CheckForNull public Integer getEndColumn()
-
getTitle
@CheckForNull public String getTitle()
-
getRawDetails
@CheckForNull public String getRawDetails()
-
getAnnotationLevel
public ChecksAnnotation.ChecksAnnotationLevel getAnnotationLevel()
-
getAnnotation
public ChecksAnnotation getAnnotation()
GetChecksAnnotation
built with user-provided parameters inPublishChecksStep
.- Returns:
- the annotation built with provided parameters
-
-