src/java/org/apache/log4j/rolling/helper/IdentityTokenConverter.java

/*
 * Copyright 1999,2004 The Apache Software Foundation.
 * 
 * Licensed 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.rolling.helper;

/**
 * IdentityTokenConverter encapsulates the String value with which it was
 * constructed. When asked to {@link #convert} it simply returns that String.
 * 
 * @author Ceki Gulcu
 * @since 1.3
 */
public class IdentityTokenConverter extends TokenConverter {

  final String str; 
  
  public IdentityTokenConverter(String str) {
   super(TokenConverter.IDENTITY);
   this.str = str; 
  }
  
  /**
   * Return the string value encapsulated by this instance.
   * 
   * @return The String this instance encapsulates.
   */
  public String convert() {
    return str;
  }

}