com.netflix.spectator.api

Class ConstantTagFactory

java.lang.Object

com.netflix.spectator.api.ConstantTagFactory

All Implemented Interfaces:

TagFactory

public final class ConstantTagFactory
extends Object
implements TagFactory

TagFactory implementation that always produces the same tag. Useful for providing a default value for a tag.

Constructor Summary

Constructors

Constructor and Description
ConstantTagFactory(String key, String value) Construct a new instance that will always return a Tag with the specified value.
ConstantTagFactory(Tag tag) Construct a new instance that will always return the specified tag.

Method Summary

Modifier and Type	Method and Description
Tag	createTag() Produces a tag based on the runtime context available to the factory.
String	name() Returns the name of the factory, which is used as the key for any Tag produced by the createTag method.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstantTagFactory

public ConstantTagFactory(String key,
                          String value)

Construct a new instance that will always return a Tag with the specified value.

Parameters:

key - the non-null key for the tag

value - the non-null value for the tag

ConstantTagFactory

public ConstantTagFactory(Tag tag)

Construct a new instance that will always return the specified tag.

Parameters:

tag - the non-null Tag instance to return from createTag

Method Detail

name

public String name()

Description copied from interface: TagFactory

Returns the name of the factory, which is used as the key for any Tag produced by the createTag method.

Specified by:

name in interface TagFactory

createTag

public Tag createTag()

Description copied from interface: TagFactory

Produces a tag based on the runtime context available to the factory.

Specified by:

createTag in interface TagFactory

Returns:

the appropriate tag given the available context data, possibly null