org.apache.logging.log4j.core.pattern.MapPatternConverter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of rapidpm-dynamic-cdi Show documentation
Show all versions of rapidpm-dynamic-cdi Show documentation
Dynamic Dependency Injection with different ways to manage the resolver-strategy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache license, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the license for the specific language governing permissions and
* limitations under the license.
*/
package org.apache.logging.log4j.core.pattern;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.message.MapMessage;
/**
* Able to handle the contents of the LogEvent's MapMessage and either
* output the entire contents of the properties in a similar format to the
* java.util.Hashtable.toString(), or to output the value of a specific key
* within the Map.
*/
@Plugin(name = "MapPatternConverter", category = PatternConverter.CATEGORY)
@ConverterKeys({ "K", "map", "MAP" })
public final class MapPatternConverter extends LogEventPatternConverter {
/**
* Name of property to output.
*/
private final String key;
/**
* Private constructor.
*
* @param options options, may be null.
*/
private MapPatternConverter(final String[] options) {
super(options != null && options.length > 0 ? "MAP{" + options[0] + '}' : "MAP", "map");
key = options != null && options.length > 0 ? options[0] : null;
}
/**
* Obtains an instance of PropertiesPatternConverter.
*
* @param options options, may be null or first element contains name of property to format.
* @return instance of PropertiesPatternConverter.
*/
public static MapPatternConverter newInstance(final String[] options) {
return new MapPatternConverter(options);
}
/**
* {@inheritDoc}
*/
@Override
public void format(final LogEvent event, final StringBuilder toAppendTo) {
MapMessage msg;
if (event.getMessage() instanceof MapMessage) {
msg = (MapMessage) event.getMessage();
} else {
return;
}
final Map map = msg.getData();
// if there is no additional options, we output every single
// Key/Value pair for the Map in a similar format to Hashtable.toString()
if (key == null) {
if (map.isEmpty()) {
toAppendTo.append("{}");
return;
}
final StringBuilder sb = new StringBuilder("{");
final Set keys = new TreeSet<>(map.keySet());
for (final String eventKey : keys) {
if (sb.length() > 1) {
sb.append(", ");
}
sb.append(eventKey).append('=').append(map.get(eventKey));
}
sb.append('}');
toAppendTo.append(sb);
} else {
// otherwise they just want a single key output
final String val = map.get(key);
if (val != null) {
toAppendTo.append(val);
}
}
}
}