001/*
002 * (C) Copyright 2015-2017 Nuxeo (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 *     Kevin Leturc <kleturc@nuxeo.com>
019 */
020package org.nuxeo.runtime.logging;
021
022import org.apache.commons.lang3.StringUtils;
023import org.apache.commons.logging.Log;
024import org.apache.commons.logging.LogFactory;
025import org.nuxeo.runtime.api.Framework;
026
027/**
028 * Logger for deprecation warnings.
029 * <p>
030 * Can be activated only when dev mode is set, and can hold the version from which deprecation starts.
031 *
032 * @since 7.4
033 */
034public class DeprecationLogger {
035
036    private static final Log log = LogFactory.getLog(DeprecationLogger.class);
037
038    public static void log(String message, String deprecatedVersion) {
039        StringBuilder finalMessage = new StringBuilder();
040        if (StringUtils.isNotBlank(deprecatedVersion)) {
041            finalMessage.append("Since version ").append(deprecatedVersion).append(": ");
042        }
043        finalMessage.append(message);
044        log(finalMessage.toString());
045    }
046
047    public static void log(String message) {
048        if (Framework.isDevModeSet()) {
049            log.warn(message);
050        }
051    }
052
053}