org.apache.logging.log4j.core.lookup

Class MarkerLookup

java.lang.Object

org.apache.logging.log4j.core.lookup.AbstractLookup

org.apache.logging.log4j.core.lookup.MarkerLookup

All Implemented Interfaces:

StrLookup

@Plugin(name="marker",
        category="Lookup")
public class MarkerLookup
extends AbstractLookup

Looks-up markers.

Since:

2.4

Field Summary

Fields inherited from interface org.apache.logging.log4j.core.lookup.StrLookup

CATEGORY

Constructor Summary

Constructors

Constructor and Description
MarkerLookup()

Method Summary

Modifier and Type	Method and Description
String	lookup(LogEvent event, String key) Looks up a String key to a String value possibly using the current LogEvent.
String	lookup(String key) Calls lookup(null, key) in the super class.

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkerLookup

public MarkerLookup()

Method Detail

lookup

public String lookup(LogEvent event,
                     String key)

Description copied from interface: StrLookup

Looks up a String key to a String value possibly using the current LogEvent.

The internal implementation may use any mechanism to return the value. The simplest implementation is to use a Map. However, virtually any implementation is possible.

For example, it would be possible to implement a lookup that used the key as a primary key, and looked up the value on demand from the database Or, a numeric based implementation could be created that treats the key as an integer, increments the value and return the result as a string - converting 1 to 2, 15 to 16 etc.

This method always returns a String, regardless of the underlying data, by converting it as necessary. For example:

 Map<String, Object> map = new HashMap<String, Object>();
 map.put("number", new Integer(2));
 assertEquals("2", StrLookup.mapLookup(map).lookup("number"));
 

Parameters:

event - The current LogEvent.

key - the key to be looked up, may be null

Returns:

the matching value, null if no match

lookup

public String lookup(String key)

Description copied from class: AbstractLookup

Calls lookup(null, key) in the super class.

Specified by:

lookup in interface StrLookup

Overrides:

lookup in class AbstractLookup

Parameters:

key - the key to be looked up, may be null

Returns:

the matching value, null if no match

See Also:

StrLookup.lookup(LogEvent, String)