View Javadoc

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