Package io.jenkins.plugins.analysis.core.restapi

Class ToolApi

java.lang.Object

io.jenkins.plugins.analysis.core.restapi.ToolApi

@ExportedBean
public class ToolApi
extends Object

Remote API model for a static analysis tool that has been invoked in a build. Simple Java Bean that exposes several methods of a tool instance.

Author:

Ullrich Hafner

Constructor Summary

Constructors

Constructor	Description
ToolApi(String id, String name, String latestUrl, int size)	Deprecated. use ToolApi(String, String, String, int, Map) instead.
ToolApi(String id, String name, String latestUrl, int size, Map<edu.hm.hafner.analysis.Severity,Integer> sizePerSeverity)	Creates a new instance of ToolApi.

Method Summary

Modifier and Type	Method	Description
int	getErrorSize()
int	getHighSize()
String	getId()
String	getLatestUrl()
int	getLowSize()
String	getName()
int	getNormalSize()
int	getSize()

Methods inherited from class java.lang.Object

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

Constructor Details

ToolApi

@Deprecated
public ToolApi(String id,
 String name,
 String latestUrl,
 int size)

Deprecated.

use ToolApi(String, String, String, int, Map) instead.

Creates a new instance of ToolApi.

Parameters:

id - unique ID of the tool

name - human-readable name of the tool

latestUrl - the URL to the latest results

size - the number of warnings

ToolApi

public ToolApi(String id,
 String name,
 String latestUrl,
 int size,
 Map<edu.hm.hafner.analysis.Severity,Integer> sizePerSeverity)

Creates a new instance of ToolApi.

Parameters:

id - unique ID of the tool

name - human-readable name of the tool

latestUrl - the URL to the latest results

size - the number of warnings

sizePerSeverity - the number of warnings, grouped by severity

Method Details

getId

@Exported
public String getId()

getName

@Exported
public String getName()

getSize

@Exported
public int getSize()

getLatestUrl

@Exported
public String getLatestUrl()

getErrorSize

@Exported
public int getErrorSize()

getHighSize

@Exported
public int getHighSize()

getNormalSize

@Exported
public int getNormalSize()

getLowSize

@Exported
public int getLowSize()