jetbrains.buildServer
Class BuildProblemData

java.lang.Object
  extended by jetbrains.buildServer.BuildProblemData

public class BuildProblemData
extends java.lang.Object

Since:
7.1 Represents a problem that causes build failure
Author:
Victory.Bedrosova

Field Summary
static java.lang.String ADDITIONAL_DATA_KEY
           
static java.lang.String INIT_ERROR_PREFIX
           
static int MAX_ATTR_NAME_LENGTH
           
static int MAX_ATTR_VALUE_LENGTH
           
static int MAX_DESCRIPTION_LENGTH
           
static int MAX_IDENTITY_LENGTH
           
static int MAX_TYPE_LENGTH
           
 
Method Summary
static java.lang.String asString(java.lang.String identity, java.lang.String type, java.lang.String description)
           
static BuildProblemData createBuildProblem(java.lang.String identity, java.lang.String type, java.lang.String description)
           
static BuildProblemData createBuildProblem(java.lang.String identity, java.lang.String type, java.lang.String description, java.lang.String additionalData)
          Creates new build problem
 boolean equals(java.lang.Object o)
           
 java.lang.String getAdditionalData()
          Any kind of additional data serialized to a string
 java.lang.String getDescription()
          Human readable build problem description
 java.lang.String getIdentity()
          Build problem identity, that uniquely identifies the particular problem occurrence details If during a build two build problems have the same identity, the second one overrides the first Should be a valid java id
 java.lang.String getType()
          Build problem type, that is the same for all problems of each class, e.g.
 int hashCode()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

MAX_IDENTITY_LENGTH

public static final int MAX_IDENTITY_LENGTH
See Also:
Constant Field Values

MAX_TYPE_LENGTH

public static final int MAX_TYPE_LENGTH
See Also:
Constant Field Values

MAX_DESCRIPTION_LENGTH

public static final int MAX_DESCRIPTION_LENGTH
See Also:
Constant Field Values

MAX_ATTR_NAME_LENGTH

public static final int MAX_ATTR_NAME_LENGTH
See Also:
Constant Field Values

MAX_ATTR_VALUE_LENGTH

public static final int MAX_ATTR_VALUE_LENGTH
See Also:
Constant Field Values

ADDITIONAL_DATA_KEY

public static final java.lang.String ADDITIONAL_DATA_KEY
See Also:
Constant Field Values

INIT_ERROR_PREFIX

public static final java.lang.String INIT_ERROR_PREFIX
See Also:
Constant Field Values
Method Detail

createBuildProblem

public static BuildProblemData createBuildProblem(java.lang.String identity,
                                                  java.lang.String type,
                                                  java.lang.String description,
                                                  java.lang.String additionalData)
Creates new build problem

Parameters:
identity - Build problem identity, that uniquely identifies the particular problem occurrence details If during a build two build problems have the same identity, the second one overrides the first If the same problem occurs in following builds the identity should be the same Should be a valid java id Shouldn't be longer than MAX_IDENTITY_LENGTH characters
type - Build problem type, that is the same for all problems of each class, e.g. BUILD_FAILURE_ON_MESSAGE Shouldn't be longer than MAX_TYPE_LENGTH characters
description - Human readable build problem description Values longer than MAX_DESCRIPTION_LENGTH characters will be truncated
additionalData - Any kind of additional data serialized to a string or null Shouldn't be longer than MAX_ATTR_VALUE_LENGTH characters
Throws:
java.lang.IllegalArgumentException - if any parameter is null or if identity or type have illegal length
Since:
8.0

createBuildProblem

public static BuildProblemData createBuildProblem(java.lang.String identity,
                                                  java.lang.String type,
                                                  java.lang.String description)

getType

public java.lang.String getType()
Build problem type, that is the same for all problems of each class, e.g. BUILD_FAILURE_ON_MESSAGE

Returns:
see above

getIdentity

public java.lang.String getIdentity()
Build problem identity, that uniquely identifies the particular problem occurrence details If during a build two build problems have the same identity, the second one overrides the first Should be a valid java id

Returns:
see above

getDescription

public java.lang.String getDescription()
Human readable build problem description

Returns:
see above

getAdditionalData

public java.lang.String getAdditionalData()
Any kind of additional data serialized to a string

Returns:
see above
Since:
8.0

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

asString

public static java.lang.String asString(java.lang.String identity,
                                        java.lang.String type,
                                        java.lang.String description)

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object