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