MaskedKeyValuePairConverter (Logback-Parent 1.5.34 API)

java.lang.Object
- ch.qos.logback.core.pattern.Converter<E>
- - ch.qos.logback.core.pattern.FormattingConverter<E>
  - - ch.qos.logback.core.pattern.DynamicConverter<ILoggingEvent>
    - - ch.qos.logback.classic.pattern.ClassicConverter
      - ch.qos.logback.classic.pattern.MaskedKeyValuePairConverter

All Implemented Interfaces:

ContextAware, LifeCycle
```
public class MaskedKeyValuePairConverter
extends ClassicConverter
```
Similar to KeyValuePairConverter with the added ability to mask the values of specified keys.
Assuming the specified key is k2, and the kvp list of an event contains {k1, v1}, {k2, v2}, the String output will be "k1=v1 k2=XXX", without the quotes. Value quotes can be specified as the first option, e.g %maskedKvp{SINGLE, k1}

Since:

1.5.7

Author:

Ceki Gülcü

Field Summary

Fields
Modifier and Type Field Description

static String MASK
- Fields inherited from class ch.qos.logback.core.pattern.DynamicConverter
  started

Constructor Summary

Constructors
Constructor Description

MaskedKeyValuePairConverter()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`convert(ILoggingEvent event)`	The convert method is responsible for extracting data from the event and returning a formatted string representation.
`void`	`start()`	Components that depend on options passed during configuration can override this method in order to make appropriate use of those options.

Methods inherited from class ch.qos.logback.core.pattern.DynamicConverter
addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getFirstOption, getOptionList, isStarted, setContext, setOptionList, stop

Methods inherited from class ch.qos.logback.core.pattern.FormattingConverter
getFormattingInfo, setFormattingInfo, write

Methods inherited from class ch.qos.logback.core.pattern.Converter
getNext, setNext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MASK
```
public static final String MASK
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MaskedKeyValuePairConverter
```
public MaskedKeyValuePairConverter()
```
- Method Detail
  - start
```
public void start()
```
    Description copied from class: DynamicConverter
    
    Components that depend on options passed during configuration can override this method in order to make appropriate use of those options. For simpler components, the trivial implementation found in this abstract class will be sufficient.
    
    Specified by:
    
    start in interface LifeCycle
    
    Overrides:
    
    start in class DynamicConverter<ILoggingEvent>
  - convert
```
public String convert(ILoggingEvent event)
```
    Description copied from class: Converter
    
    The convert method is responsible for extracting data from the event and returning a formatted string representation.
    
    Specified by:
    
    convert in class Converter<ILoggingEvent>
    
    Parameters:
    
    event - the event to convert
    
    Returns:
    
    the formatted string representation