Package jetbrains.buildServer.messages.serviceMessages

Class MessageTranslator

java.lang.Object

jetbrains.buildServer.messages.serviceMessages.MessageTranslator

All Implemented Interfaces:

ServiceMessageTranslator, ServerExtension, TeamCityExtension

public class MessageTranslator
extends Object
implements ServiceMessageTranslator

Registers translators for the following service messages: ##teamcity[message ...]

Constructor Summary

Constructors

Constructor	Description
MessageTranslator(ServerExtensionHolder server)

Method Summary

Modifier and Type	Method	Description
String	getServiceMessageName()	Returns name of the service message supported by this translator.
static Status	parseStatus(ServiceMessage message)
List<BuildMessage1>	translate(SRunningBuild runningBuild, BuildMessage1 originalMessage, ServiceMessage serviceMessage)	Called to translate service message to a number of usual messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageTranslator

public MessageTranslator(ServerExtensionHolder server)

Method Detail

translate

@NotNull
public List<BuildMessage1> translate(@NotNull
                                     SRunningBuild runningBuild,
                                     @NotNull
                                     BuildMessage1 originalMessage,
                                     @NotNull
                                     ServiceMessage serviceMessage)

Description copied from interface: ServiceMessageTranslator

Called to translate service message to a number of usual messages.

Note: no attempts should be made to use the build log from the running build to log some messages SBuild.getBuildLog(), instead the translator should return all the messages which should be inserted into the build log instead of the processed service message.

Specified by:

translate in interface ServiceMessageTranslator

Parameters:

runningBuild - running build

originalMessage - original message from which service message was created

serviceMessage - service message

Returns:

a list of translated messages

getServiceMessageName

@NotNull
public String getServiceMessageName()

Description copied from interface: ServiceMessageTranslator

Returns name of the service message supported by this translator. Only service messages with such name will be passed to the translator.

Specified by:

getServiceMessageName in interface ServiceMessageTranslator

Returns:

see above.

parseStatus

@Nullable
public static Status parseStatus(@NotNull
                                 ServiceMessage message)
                          throws TranslateMessageException

Throws:

TranslateMessageException