com.uber.jenkins.phabricator.lint

Class LintResult

java.lang.Object

com.uber.jenkins.phabricator.lint.LintResult

public class LintResult
extends java.lang.Object

This currently mirrors the API format of Harbormaster lint messages Reference: https://secure.phabricator.com/conduit/method/harbormaster.sendmessage/ name string Short message name, like "Syntax Error". code string Lint message code identifying the type of message, like "ERR123". severity string Severity of the message. path string Path to the file containing the lint message, from the project root. line optional int Line number in the file where the text which triggered the message first appears. The first line of the file is line 1, not line 0. char optional int Byte position on the line where the text which triggered the message starts. The first byte on the line is byte 1, not byte 0. This position is byte-based (not character-based) because not all lintable files have a valid character encoding. description optional string Long explanation of the lint message.

Constructor Summary

Constructors

Constructor and Description
LintResult(java.lang.String name, java.lang.String code, java.lang.String severity, java.lang.String path, java.lang.Integer line, java.lang.Integer charPosition, java.lang.String description)

Method Summary

Modifier and Type	Method and Description
static LintResult	fromJsonObject(net.sf.json.JSONObject json)
net.sf.json.JSONObject	toHarbormaster() Create a Harbormaster-API-compatible representation of the lint result

Methods inherited from class java.lang.Object

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

Constructor Detail

LintResult

public LintResult(java.lang.String name,
                  java.lang.String code,
                  java.lang.String severity,
                  java.lang.String path,
                  java.lang.Integer line,
                  java.lang.Integer charPosition,
                  java.lang.String description)

Method Detail

fromJsonObject

public static LintResult fromJsonObject(net.sf.json.JSONObject json)

toHarbormaster

public net.sf.json.JSONObject toHarbormaster()

Create a Harbormaster-API-compatible representation of the lint result

Returns:

A JSON representation of the lint result