View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  
20  package org.apache.myfaces.tobago.internal.util;
21  
22  import org.slf4j.Logger;
23  import org.slf4j.LoggerFactory;
24  
25  
26  public final class Deprecation {
27  
28    // to prevent instantiation
29    private Deprecation() {
30    }
31  
32    /**
33     * This Logger object should help to detect the usage of deprecated code.
34     * The main reason for this class is the lack of a "deprecated concept"
35     * for tag libraries. Thought the designer of a Tobago page cannot see
36     * in his IDE that a tag or attribute is deprecated.
37     * <p>
38     * The Tobago Java code will log into this Logger object, with
39     * <dl>
40     *   <dt><code>error</code></dt>
41     *   <dd>when the code is deprecated with a loss of function, or</dd>
42     *   <dt><code>warn</code></dt>
43     *   <dd>when the code is deprecated, but still works.</dd>
44     * </dl>
45     * <p>
46     * This Logger category can be switched off, in production environment without
47     * affecting the normal logging category.
48     */
49    public static final Logger LOG = LoggerFactory.getLogger(Deprecation.class);
50  
51  }