1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache license, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the license for the specific language governing permissions and
15 * limitations under the license.
16 */
17 package org.apache.logging.log4j.core.pattern;
18
19 import org.apache.logging.log4j.core.LogEvent;
20
21
22 /**
23 *
24 */
25 public class PatternFormatter {
26 private final LogEventPatternConverter converter;
27 private final FormattingInfo field;
28
29 public PatternFormatter(final LogEventPatternConverter converter, final FormattingInfo field) {
30 this.converter = converter;
31 this.field = field;
32 }
33
34 public void format(final LogEvent event, final StringBuilder buf) {
35 final int startField = buf.length();
36 converter.format(event, buf);
37 field.format(startField, buf);
38 }
39
40 public LogEventPatternConverter getConverter() {
41 return converter;
42 }
43
44 public FormattingInfo getFormattingInfo() {
45 return field;
46 }
47
48 /**
49 * Normally pattern formatters are not meant to handle Exceptions although few pattern formatters might.
50 * <p>
51 * By examining the return values for this method, the containing layout will determine whether it handles
52 * throwables or not.
53 * </p>
54 *
55 * @return true if this PatternConverter handles throwables
56 */
57 public boolean handlesThrowable() {
58 return converter.handlesThrowable();
59 }
60
61 /**
62 * Returns a String suitable for debugging.
63 *
64 * @return a String suitable for debugging.
65 */
66 @Override
67 public String toString() {
68 final StringBuilder sb = new StringBuilder();
69 sb.append(super.toString());
70 sb.append("[converter=");
71 sb.append(converter);
72 sb.append(", field=");
73 sb.append(field);
74 sb.append(']');
75 return sb.toString();
76 }
77 }