001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache license, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the license for the specific language governing permissions and 015 * limitations under the license. 016 */ 017package org.apache.logging.log4j.core.pattern; 018 019import org.apache.logging.log4j.core.LogEvent; 020import org.apache.logging.log4j.core.config.Configuration; 021import org.apache.logging.log4j.core.util.OptionConverter; 022 023 024/** 025 * Formats a string literal. 026 */ 027public final class LiteralPatternConverter extends LogEventPatternConverter implements ArrayPatternConverter { 028 029 /** 030 * String literal. 031 */ 032 private final String literal; 033 034 private final Configuration config; 035 036 private final boolean substitute; 037 038 /** 039 * Create a new instance. 040 * 041 * @param config The Configuration. 042 * @param literal string literal. 043 * @param convertBackslashes if {@code true}, backslash characters are treated as escape characters and character 044 * sequences like "\" followed by "t" (backslash+t) are converted to special characters like '\t' (tab). 045 */ 046 public LiteralPatternConverter(final Configuration config, final String literal, final boolean convertBackslashes) { 047 super("Literal", "literal"); 048 this.literal = convertBackslashes ? OptionConverter.convertSpecialChars(literal) : literal; // LOG4J2-829 049 this.config = config; 050 substitute = config != null && literal.contains("${"); 051 } 052 053 /** 054 * {@inheritDoc} 055 */ 056 @Override 057 public void format(final LogEvent event, final StringBuilder toAppendTo) { 058 toAppendTo.append(substitute ? config.getStrSubstitutor().replace(event, literal) : literal); 059 } 060 061 /** 062 * {@inheritDoc} 063 */ 064 @Override 065 public void format(final Object obj, final StringBuilder output) { 066 output.append(substitute ? config.getStrSubstitutor().replace(literal) : literal); 067 } 068 069 /** 070 * {@inheritDoc} 071 */ 072 @Override 073 public void format(final StringBuilder output, final Object... objects) { 074 output.append(substitute ? config.getStrSubstitutor().replace(literal) : literal); 075 } 076 077 public String getLiteral() { 078 return literal; 079 } 080 081 @Override 082 public boolean isVariable() { 083 return false; 084 } 085 086 @Override 087 public String toString() { 088 return "LiteralPatternConverter[literal=" + literal + ", config=" + config + ", substitute=" + substitute + "]"; 089 } 090 091}