com.atlassian.bamboo.build.logger

Class BuildLogUtils

java.lang.Object

com.atlassian.bamboo.build.logger.BuildLogUtils

public class BuildLogUtils
extends Object

Provides text parsing utilities for writing and reading build log files.

Method Summary

Modifier and Type	Method and Description
static LogEntry	convertToLogEntry(String fileEntry) Converts a line from a file back into a LogEntry object
static String	convertToLogFileEntry(LogEntry logEntry) Convert the specified LogEntry object into a string to be written to a log file
static Class<? extends LogEntry>	getLogEntryType(String logLine) Return the specific type of LogEntry for the given log line.
static File	getLogFileDirectory(Key entityKey) Deprecated. since 5.11, use StorageLocationService#getBuildLogsDirectory(Key) instead.
static File	getLogFileDirectory(String entityKey) Deprecated. since 5.11, use StorageLocationService#getBuildLogsDirectory(Key) instead.
static String	getLogFileName(Key entityKey, int resultNumber) Deprecated. since 5.11, use StorageLocationService#getLogFileName(Key, int) instead.
static String	getLogFileName(ResultKey resultKey) Deprecated. since 5.11, use StorageLocationService instead.
static void	sendFileThroughLogger(File file, BuildLogger buildLogger)
static String[]	splitLogEntry(String fileEntry)

Methods inherited from class java.lang.Object

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

Method Detail

convertToLogFileEntry

public static String convertToLogFileEntry(@NotNull
                                           LogEntry logEntry)

Convert the specified LogEntry object into a string to be written to a log file

Parameters:

logEntry - the LogEntry to be written

Returns:

String file entry, should never be empty

getLogEntryType

@NotNull
public static Class<? extends LogEntry> getLogEntryType(@NotNull
                                                                 String logLine)

Return the specific type of LogEntry for the given log line.

convertToLogEntry

@NotNull
public static LogEntry convertToLogEntry(@Nullable
                                                  String fileEntry)

Converts a line from a file back into a LogEntry object

Parameters:

fileEntry - to be converted

Returns:

the resulting LogEntry object

splitLogEntry

@Internal
 @NotNull
public static String[] splitLogEntry(@Nullable
                                                         String fileEntry)

getLogFileDirectory

@Deprecated
public static File getLogFileDirectory(@NotNull
                                                   String entityKey)

Deprecated. since 5.11, use StorageLocationService#getBuildLogsDirectory(Key) instead.

getLogFileDirectory

@Deprecated
public static File getLogFileDirectory(@NotNull
                                                   Key entityKey)

Deprecated. since 5.11, use StorageLocationService#getBuildLogsDirectory(Key) instead.

getLogFileName

@Deprecated
public static String getLogFileName(@NotNull
                                                Key entityKey,
                                                int resultNumber)

Deprecated. since 5.11, use StorageLocationService#getLogFileName(Key, int) instead.

getLogFileName

@Deprecated
public static String getLogFileName(ResultKey resultKey)

Deprecated. since 5.11, use StorageLocationService instead.

sendFileThroughLogger

public static void sendFileThroughLogger(@NotNull
                                         File file,
                                         @NotNull
                                         BuildLogger buildLogger)
                                  throws IOException

Throws:

IOException