Android Open Source - mclib Log

• Back to Development/api  ↑

From Project

Back to project page mclib.

License

The source code is released under:

Apache License, Version 2.0 FoundationProjectsPeopleGet InvolvedDownloadSupport ApacheHome ? Licenses Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITION...

Java Source Code

/*
   Copyright 2012 Mikhail Chabanov/*from   ww w.ja  v  a2 s .co  m*/

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
 */
package mc.lib.log;

import java.io.InputStream;

import mc.lib.stream.StreamHelper;

/**
 * Decorator for standard android.util.Log allowing to enable/disable logging in runtime
 * 
 */
public class Log
{
    private static final String LOGTAG = Log.class.getSimpleName();
    private static final String LOG_REQUEST = "logcat -v time -t %d *";

    /**
     * See {@link android.util.Log#VERBOSE}
     */
    public static final int VERBOSE = android.util.Log.VERBOSE;

    /**
     * See {@link android.util.Log#DEBUG}
     */
    public static final int DEBUG = android.util.Log.DEBUG;

    /**
     * See {@link android.util.Log#INFO}
     */
    public static final int INFO = android.util.Log.INFO;

    /**
     * See {@link android.util.Log#WARN}
     */
    public static final int WARN = android.util.Log.WARN;

    /**
     * See {@link android.util.Log#ERROR}
     */
    public static final int ERROR = android.util.Log.ERROR;

    /**
     * See {@link android.util.Log#ASSERT}
     */
    public static final int ASSERT = android.util.Log.ASSERT;

    /**
     * See {@link android.util.Log#v(String, String)}
     */
    public static int v(String tag, String msg)
    {
        if(!enableLogging)
            return RETURN_WHEN_DISABLED;

        return android.util.Log.v(tag, msg);
    }

    /**
     * See {@link android.util.Log#v(String, String, Throwable)}
     */
    public static int v(String tag, String msg, Throwable tr)
    {
        if(!enableLogging)
            return RETURN_WHEN_DISABLED;

        return android.util.Log.v(tag, msg, tr);
    }

    /**
     * See {@link android.util.Log#d(String, String)}
     */
    public static int d(String tag, String msg)
    {
        if(!enableLogging)
            return RETURN_WHEN_DISABLED;

        return android.util.Log.d(tag, msg);
    }

    /**
     * See {@link android.util.Log#d(String, String, Throwable)}
     */
    public static int d(String tag, String msg, Throwable tr)
    {
        if(!enableLogging)
            return RETURN_WHEN_DISABLED;

        return android.util.Log.d(tag, msg, tr);
    }

    /**
     * See {@link android.util.Log#i(String, String)}
     */
    public static int i(String tag, String msg)
    {
        if(!enableLogging)
            return RETURN_WHEN_DISABLED;

        return android.util.Log.i(tag, msg);
    }

    /**
     * See {@link android.util.Log#i(String, String, Throwable)}
     */
    public static int i(String tag, String msg, Throwable tr)
    {
        if(!enableLogging)
            return RETURN_WHEN_DISABLED;

        return android.util.Log.i(tag, msg, tr);
    }

    /**
     * See {@link android.util.Log#w(String, String)}
     */
    public static int w(String tag, String msg)
    {
        if(!enableLogging)
            return RETURN_WHEN_DISABLED;

        return android.util.Log.w(tag, msg);
    }

    /**
     * See {@link android.util.Log#w(String, String, Throwable)}
     */
    public static int w(String tag, String msg, Throwable tr)
    {
        if(!enableLogging)
            return RETURN_WHEN_DISABLED;

        return android.util.Log.w(tag, msg, tr);
    }

    /**
     * See {@link android.util.Log#w(String, Throwable)}
     */
    public static int w(String tag, Throwable tr)
    {
        if(!enableLogging)
            return RETURN_WHEN_DISABLED;

        return android.util.Log.w(tag, tr);
    }

    /**
     * See {@link android.util.Log#e(String, String) }
     */
    public static int e(String tag, String msg)
    {
        if(!enableLogging)
            return RETURN_WHEN_DISABLED;

        return android.util.Log.e(tag, msg);
    }

    /**
     * See {@link android.util.Log#e(String, String, Throwable)}
     */
    public static int e(String tag, String msg, Throwable tr)
    {
        if(!enableLogging)
            return RETURN_WHEN_DISABLED;

        return android.util.Log.e(tag, msg, tr);
    }

    /**
     * See {@link android.util.Log#wtf(String, String)}
     */
    public static int wtf(String tag, String msg)
    {
        if(!enableLogging)
            return RETURN_WHEN_DISABLED;

        return android.util.Log.wtf(tag, msg);
    }

    /**
     * See {@link android.util.Log#wtf(String, Throwable)}
     */
    public static int wtf(String tag, Throwable tr)
    {
        if(!enableLogging)
            return RETURN_WHEN_DISABLED;

        return android.util.Log.wtf(tag, tr);
    }

    /**
     * See {@link android.util.Log#wtf(String, String, Throwable)}
     */
    public static int wtf(String tag, String msg, Throwable tr)
    {
        if(!enableLogging)
            return RETURN_WHEN_DISABLED;

        return android.util.Log.wtf(tag, msg, tr);
    }

    /**
     * See {@link android.util.Log#isLoggable(String, int)}
     */
    public static boolean isLoggable(String tag, int level)
    {
        if(!enableLogging)
            return false;

        return android.util.Log.isLoggable(tag, level);
    }

    /**
     * See {@link android.util.Log#getStackTraceString(Throwable)}
     */
    public static String getStackTraceString(Throwable tr)
    {
        return android.util.Log.getStackTraceString(tr);
    }

    /**
     * See {@link android.util.Log#println(int, String, String)}
     */
    public static int println(int priority, String tag, String msg)
    {
        if(!enableLogging)
            return RETURN_WHEN_DISABLED;

        return android.util.Log.println(priority, tag, msg);
    }

    private static final int RETURN_WHEN_DISABLED = 0;
    private static boolean enableLogging = true;

    /**
     * Enable log messages
     */
    public static void enableLogging()
    {
        enableLogging = true;
    }

    /**
     * Disable all log messages
     */
    public static void disableLogging()
    {
        enableLogging = false;
    }

    /**
     * Get logcat dump
     * 
     * @return last 100 lines logcat write to log file
     */
    public static String getLogReport()
    {
        return getLogReport(100);
    }

    /**
     * Get logcat dump
     * 
     * @param size
     *            number of lines to fetch from log
     * @return last 'size' lines logcat write to log file
     */
    public static String getLogReport(int size)
    {
        String res = "";
        try
        {
            Process p = Runtime.getRuntime().exec(String.format(LOG_REQUEST, size));
            p.waitFor();
            InputStream is = p.getInputStream();
            res = StreamHelper.readStream(is);
            StreamHelper.close(is);
        }
        catch(Exception e)
        {
            e(LOGTAG, "Error on getting log report", e);
        }
        return res;
    }
}

Java Source Code List

• Back to Development/api  ↑