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
20 import org.apache.logging.log4j.util.PerformanceSensitive;
21
22 /**
23 * Abstract base class for other pattern converters which can return only parts of their name.
24 */
25 @PerformanceSensitive("allocation")
26 public abstract class NamePatternConverter extends LogEventPatternConverter {
27 /**
28 * Abbreviator.
29 */
30 private final NameAbbreviator abbreviator;
31
32 /**
33 * Constructor.
34 *
35 * @param name name of converter.
36 * @param style style name for associated output.
37 * @param options options, may be null, first element will be interpreted as an abbreviation pattern.
38 */
39 protected NamePatternConverter(final String name, final String style, final String[] options) {
40 super(name, style);
41
42 if (options != null && options.length > 0) {
43 abbreviator = NameAbbreviator.getAbbreviator(options[0]);
44 } else {
45 abbreviator = NameAbbreviator.getDefaultAbbreviator();
46 }
47 }
48
49 /**
50 * Abbreviate name in string buffer.
51 *
52 * @param original string containing name.
53 * @param destination the StringBuilder to write to
54 * @return The abbreviated name.
55 */
56 protected final void abbreviate(final String original, final StringBuilder destination) {
57 abbreviator.abbreviate(original, destination);
58 }
59 }