org.apache.log4j.pattern.NamePatternConverter Maven / Gradle / Ivy
The newest version!
/*
* 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.log4j.pattern;
/**
*
* Base class for other pattern converters which can return only parts of their name.
*
* @author Ceki Gülcü
* @author Curt Arnold
*
*/
public abstract class NamePatternConverter
extends LoggingEventPatternConverter {
/**
* Abbreviator.
*/
private final NameAbbreviator abbreviator;
/**
* Constructor.
* @param name name of converter.
* @param style style name for associated output.
* @param options options, may be null, first element will be interpreted as an abbreviation pattern.
*/
protected NamePatternConverter(
final String name, final String style, final String[] options) {
super(name, style);
if ((options != null) && (options.length > 0)) {
abbreviator = NameAbbreviator.getAbbreviator(options[0]);
} else {
abbreviator = NameAbbreviator.getDefaultAbbreviator();
}
}
/**
* Abbreviate name in string buffer.
* @param nameStart starting position of name to abbreviate.
* @param buf string buffer containing name.
*/
protected final void abbreviate(final int nameStart, final StringBuffer buf) {
abbreviator.abbreviate(nameStart, buf);
}
}