001 package org.apache.myfaces.tobago.util; 002 003 /* 004 * Licensed to the Apache Software Foundation (ASF) under one or more 005 * contributor license agreements. See the NOTICE file distributed with 006 * this work for additional information regarding copyright ownership. 007 * The ASF licenses this file to You under the Apache License, Version 2.0 008 * (the "License"); you may not use this file except in compliance with 009 * the License. You may obtain a copy of the License at 010 * 011 * http://www.apache.org/licenses/LICENSE-2.0 012 * 013 * Unless required by applicable law or agreed to in writing, software 014 * distributed under the License is distributed on an "AS IS" BASIS, 015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 016 * See the License for the specific language governing permissions and 017 * limitations under the License. 018 */ 019 020 import org.apache.commons.logging.Log; 021 import org.apache.commons.logging.LogFactory; 022 023 public final class Deprecation { 024 025 // to prevent instantiation 026 private Deprecation() { 027 } 028 029 /** 030 * This Log object should help to detect the usage of deprecated code. 031 * The main reason for this class is the lack of a "deprecated concept" 032 * for tag libraries. Thought the designer of a Tobago page cannot see 033 * in his IDE that a tag or attribute is deprecated. 034 * <p> 035 * The Tobago Java code will log into this Log object, with 036 * <dl> 037 * <dt><code>error</code></dt> 038 * <dd>when the code is deprecated with a loss of function, or</dd> 039 * <dt><code>warn</code></dt> 040 * <dd>when the code is deprecated, but still works.</dd> 041 * </dl> 042 * <p> 043 * This Log category can be switched off, in production environment without 044 * affecting the normal logging category. 045 */ 046 public static final Log LOG = LogFactory.getLog(Deprecation.class); 047 048 }