Interface BuildLogReader
-
- All Known Subinterfaces:
BuildLog
public interface BuildLogReader
Reader for build log.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description java.lang.String
getCurrentPath()
java.util.List<jetbrains.buildServer.serverSide.buildLog.LogMessage>
getDefaultFilteredMessages()
Returns messages accepted by default filter.java.util.List<jetbrains.buildServer.serverSide.buildLog.LogMessage>
getErrorMessages()
Returns messages accepted byProblemsFilter
.java.util.List<jetbrains.buildServer.serverSide.buildLog.LogMessage>
getFilteredMessages(LogMessageFilter filter)
Returns list of messages accepted by specified filter.java.util.Date
getLastMessageTimestamp()
Returns timestamp of the last logged message.java.util.List<jetbrains.buildServer.serverSide.buildLog.LogMessage>
getMessages()
Deprecated.Since constructing of list of all messages can be memory consuming it is recommended to usegetMessagesIterator()
method instead.java.util.Iterator<jetbrains.buildServer.serverSide.buildLog.LogMessage>
getMessagesIterator()
Returns iterator over all log messages.java.util.Iterator<jetbrains.buildServer.serverSide.buildLog.LogMessage>
getVerboseIterator()
boolean
isClosed()
Returnstrue
if this build log was closed.
-
-
-
Method Detail
-
getMessagesIterator
@NotNull java.util.Iterator<jetbrains.buildServer.serverSide.buildLog.LogMessage> getMessagesIterator()
Returns iterator over all log messages. Build log messages form a tree which is iterated as follows: iterator walks down the tree until it meets a leaf, then it seeks whether parent of the leaf has siblings and iterate over them, moving down to their children if needed and so on. In other words this iterator iterates over all messages in the tree in order of their appearance. The iterator is filtered by default, i.e. it doesn't include internal messages. Each log message has parent, so while iterating down the tree it is possible to go up to the topmost parent. You can obtain level in the tree for each message with help ofLogMessage.getLevel()
method.- Returns:
- filtered iterator by log messages.
- See Also:
LogMessage.isInternal()
-
getVerboseIterator
@NotNull java.util.Iterator<jetbrains.buildServer.serverSide.buildLog.LogMessage> getVerboseIterator()
- Returns:
- message iterator without any filtering, i.e. includes all messages in the build log
- Since:
- 8.x
- See Also:
getMessagesIterator()
-
getMessages
@Deprecated @NotNull java.util.List<jetbrains.buildServer.serverSide.buildLog.LogMessage> getMessages()
Deprecated.Since constructing of list of all messages can be memory consuming it is recommended to usegetMessagesIterator()
method instead.Returns all messages as list in order of their appearance.- Returns:
- all messages as list in order of their appearance.
-
getDefaultFilteredMessages
@NotNull java.util.List<jetbrains.buildServer.serverSide.buildLog.LogMessage> getDefaultFilteredMessages()
Returns messages accepted by default filter. SeeDefaultLogMessageFilter
.- Returns:
- messages accepted by default filter
-
getErrorMessages
@NotNull java.util.List<jetbrains.buildServer.serverSide.buildLog.LogMessage> getErrorMessages()
Returns messages accepted byProblemsFilter
.- Returns:
- messages accepted by
ProblemsFilter
.
-
getFilteredMessages
@NotNull java.util.List<jetbrains.buildServer.serverSide.buildLog.LogMessage> getFilteredMessages(@NotNull LogMessageFilter filter)
Returns list of messages accepted by specified filter.- Parameters:
filter
- filter for messages- Returns:
- messages accepted by filter.
-
isClosed
boolean isClosed()
Returnstrue
if this build log was closed.It's important that if the build log was closed on another node, the current one may not know about it!
-
getLastMessageTimestamp
@Nullable java.util.Date getLastMessageTimestamp()
Returns timestamp of the last logged message.- Returns:
- timestamp or null if there were no messages yet.
- Since:
- 6.0
-
getCurrentPath
@NotNull java.lang.String getCurrentPath()
- Returns:
- current path - concatenation of text from the last message and names of all the parent blocks
- Since:
- 10.0
-
-