001/*
002 * (C) Copyright 2015 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Anahide Tchertchian
018 */
019package org.nuxeo.runtime.logging;
020
021import org.apache.commons.lang.StringUtils;
022import org.apache.commons.logging.Log;
023import org.apache.commons.logging.LogFactory;
024import org.nuxeo.runtime.api.Framework;
025
026/**
027 * Logger for deprecation warnings.
028 * <p>
029 * Can be activated only when dev mode is set, and can hold the version from which deprecation starts.
030 *
031 * @since 7.4
032 */
033public class DeprecationLogger {
034
035    private static final Log log = LogFactory.getLog(DeprecationLogger.class);
036
037    public static final void log(String message, String deprecatedVersion) {
038        StringBuilder finalMessage = new StringBuilder();
039        if (!StringUtils.isBlank(deprecatedVersion)) {
040            finalMessage.append("Since version ").append(deprecatedVersion).append(": ");
041        }
042        finalMessage.append(message);
043        log(finalMessage.toString());
044    }
045
046    public static final void log(String message) {
047        if (Framework.isDevModeSet()) {
048            log.warn(message);
049        }
050    }
051
052}