com.atlassian.bamboo.logger
Interface ErrorDetails

All Known Implementing Classes:
DecoratedErrorDetailsImpl, ElasticErrorDetailsImpl, ErrorDetailsImpl

public interface ErrorDetails


Method Summary
 Set<Long> getAgentIds()
           
 String getBuildKey()
          Deprecated. since 5.5, use getEntityKey()
 Integer getBuildNumber()
          Deprecated. since 5.5, use getResultNumber()
 String getBuildResultKey()
          Deprecated. since 5.5, use getResultKey()
 String getContext()
          Top level message related to error
 Key getEntityKey()
          Get entity key associated with this error
 int getErrorNumber()
           
 Date getFirstOccurred()
           
 Date getLastOccurred()
           
 int getNumberOfOccurrences()
           
 ResultKey getResultKey()
          Get result key associated with this error
 Integer getResultNumber()
           
 ThrowableDetails getThrowableDetails()
          Contains the details of any Throwable which may have been thrown in the error
 boolean isBuildSpecific()
          Is this error specific to one plan (true) or for all/any plans (false) e.g.
 boolean isForAllBuilds()
          Deprecated. since 5.5, use isBuildSpecific()
 

Method Detail

getBuildKey

@Nullable
@Deprecated
String getBuildKey()
Deprecated. since 5.5, use getEntityKey()

Full key for the build plan (e.g BAMBOO-TRUNK)

Returns:
build key

getEntityKey

@Nullable
Key getEntityKey()
Get entity key associated with this error

Returns:
entity key

getBuildNumber

@Nullable
@Deprecated
Integer getBuildNumber()
Deprecated. since 5.5, use getResultNumber()


getResultNumber

@Nullable
Integer getResultNumber()
Returns:
associated result number or null

getBuildResultKey

@Deprecated
String getBuildResultKey()
Deprecated. since 5.5, use getResultKey()

Full key for the build result (e.g BAMBOO-TRUNK-4)

Returns:
build result key

getResultKey

@Nullable
ResultKey getResultKey()
Get result key associated with this error

Returns:
result key

isForAllBuilds

@Deprecated
boolean isForAllBuilds()
Deprecated. since 5.5, use isBuildSpecific()

Is this error specific to one plan (false) or for all plans (true) e.g. a system error. This method is not particularly useful after the introduction of Elastic Errors. Use the opposite isBuildSpecific() instead.

Returns:
true if error is for all builds

isBuildSpecific

boolean isBuildSpecific()
Is this error specific to one plan (true) or for all/any plans (false) e.g. a system error or elastic error.

Returns:
true if error contains a build key.

getErrorNumber

int getErrorNumber()

getContext

String getContext()
Top level message related to error


getFirstOccurred

@NotNull
Date getFirstOccurred()
Returns:
Date this error was first thrown

getLastOccurred

@NotNull
Date getLastOccurred()
Returns:
Date this error was last thrown (if it only occurred once it will be the same as getFirstOccurred())

getNumberOfOccurrences

int getNumberOfOccurrences()
Returns:
Number of times this error has occurred

getThrowableDetails

@Nullable
ThrowableDetails getThrowableDetails()
Contains the details of any Throwable which may have been thrown in the error

Returns:
details of any Throwable for this error

getAgentIds

Set<Long> getAgentIds()


Copyright © 2015 Atlassian Software Systems Pty Ltd. All rights reserved.