net.openhft.chronicle.core.announcer

Class Announcer

java.lang.Object

net.openhft.chronicle.core.announcer.Announcer

public final class Announcer
extends Object

Provides means for libraries to announce themselves.

Announcements can be turned off by setting the system property and provide other information elements. "chronicle.announcer.disable=true" prior to making any announcements.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOGO

Method Summary

Modifier and Type	Method and Description
static void	announce(@NotNull String groupId, @NotNull String artifactId) Announces the given artifact whereby useful information is printed pertaining to the artifact in particular and the JVM i general.
static void	announce(@NotNull String groupId, @NotNull String artifactId, @NotNull Map<String,String> properties) Announces the given artifact whereby useful information is printed pertaining to the artifact in particular and the JVM in general accompanied by the provided properties.

Methods inherited from class java.lang.Object

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

Field Detail

LOGO

public static final String LOGO

See Also:

Constant Field Values

Method Detail

announce

public static void announce(@NotNull
                            @NotNull String groupId,
                            @NotNull
                            @NotNull String artifactId)

Announces the given artifact whereby useful information is printed pertaining to the artifact in particular and the JVM i general.

A distinct artifact is only announced once per classloader and general JVM information is only printed once per classloader.

Example: net.openhtf:chronicle-queue, net.openhft:chronicle-map and net.openhtf:chronicle-queue (again) is announced. This will produce:

1. info on the JVM
2. info on net.openhtf:chronicle-queue
3. info on net.openhtf:chronicle-map

Parameters:

groupId - name of the group (e.g. net.openhft)

artifactId - name of the library (e.g. chronicle-queue)

announce

public static void announce(@NotNull
                            @NotNull String groupId,
                            @NotNull
                            @NotNull String artifactId,
                            @NotNull
                            @NotNull Map<String,String> properties)

Announces the given artifact whereby useful information is printed pertaining to the artifact in particular and the JVM in general accompanied by the provided properties.

The artifact will be announced on each invocation provided that the given properties is (A) not empty or (B) only contains a key "logo", for which only one announcement per class loader is made.

Parameters:

groupId - name of the group (e.g. net.openhft)

artifactId - name of the library (e.g. chronicle-queue)

properties - to print

See Also:

LOGO