org.glowroot.agent.plugin.api

Class MessageSupplier

java.lang.Object

org.glowroot.agent.plugin.api.MessageSupplier

public abstract class MessageSupplier
extends Object

A (lazy) supplier of Message instances. Needs to be thread safe since transaction thread creates it, but trace storage (and live viewing) is done in a separate thread.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MessageSupplier()

Method Summary

Modifier and Type	Method and Description
static MessageSupplier	create(String message) Creates a MessageSupplier for the specified message.
static MessageSupplier	create(String template, String... args) Creates a MessageSupplier for the specified template and args.
abstract Message	get() Returns the Message for a TraceEntry.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageSupplier

protected MessageSupplier()

Method Detail

create

public static MessageSupplier create(@Nullable
                                     String message)

Creates a MessageSupplier for the specified message.

create

public static MessageSupplier create(String template,
                                     @Nullable
                                     String... args)

Creates a MessageSupplier for the specified template and args. The template can contain one or more placeholders {} that will be substituted if/when the message text is needed by the specified args.

get

public abstract Message get()

Returns the Message for a TraceEntry. The Message does not need to be thread safe if it is instantiated by the implementation of this method.