Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 0c0bcc30 authored by Felipe Leme's avatar Felipe Leme
Browse files

Annotated Slogf methods with @FormatMethod / @FormatString 

Test: echo 'In PreSubmit we trust!'
Fixes: 410953467
Flag: EXEMPT compile-time refactoring

Change-Id: Id1506ce1f68512df30258742324f9d2b54895e28
parent c3ce2baf

services/Android.bp

+3 −0
Original line number Diff line number Diff line
@@ -162,6 +162,9 @@ filegroup { 
java_library {

    name: "Slogf",

    srcs: ["core/java/com/android/server/utils/Slogf.java"],

    libs: [

        "error_prone_annotations",

    ],

}



soong_config_module_type {

services/core/Android.bp

+1 −0
Original line number Diff line number Diff line
@@ -178,6 +178,7 @@ java_library_static { 
        "android.hardware.vibrator-V3-java",

        "androidx.annotation_annotation",

        "app-compat-annotations",

        "error_prone_annotations",

        "framework-tethering.stubs.module_lib",

        "keepanno-annotations",

        "service-art.stubs.system_server",

services/core/java/com/android/server/broadcastradio/RadioEventLogger.java

+6 −1
Original line number Diff line number Diff line
@@ -16,6 +16,7 @@ 


package com.android.server.broadcastradio;



import android.annotation.Nullable;

import android.text.TextUtils;

import android.util.IndentingPrintWriter;

import android.util.LocalLog;
@@ -23,6 +24,9 @@ import android.util.Log; 


import com.android.server.utils.Slogf;



import com.google.errorprone.annotations.FormatMethod;

import com.google.errorprone.annotations.FormatString;



/**

 * Event logger to log and dump events of broadcast radio service client for HIDL and AIDL

 * broadcast HAL.
@@ -43,7 +47,8 @@ public final class RadioEventLogger { 
     * @param logFormat String format of log message

     * @param args Arguments of log message

     */

    public void logRadioEvent(String logFormat, Object... args) {

    @FormatMethod

    public void logRadioEvent(@FormatString String logFormat, @Nullable Object... args) {

        String log = TextUtils.formatSimple(logFormat, args);

        mEventLogger.log(log);

        if (mDebug) {

services/core/java/com/android/server/utils/Slogf.java

+36 −15
Original line number Diff line number Diff line
@@ -24,6 +24,9 @@ import android.util.TimingsTraceLog; 


import com.android.internal.annotations.GuardedBy;



import com.google.errorprone.annotations.FormatMethod;

import com.google.errorprone.annotations.FormatString;



import java.util.Formatter;

import java.util.Locale;
@@ -123,12 +126,12 @@ public final class Slogf { 
        Slog.wtfQuiet(tag, msg);

    }



    /** Same as {@link Slog#wtfStack(String, String). */

    /** Same as {@link Slog#wtfStack(String, String)}. */

    public static int wtfStack(String tag, String msg) {

        return Slog.wtfStack(tag, msg);

    }



    /** Same as {@link Slog#wtf(String, Throwable). */

    /** Same as {@link Slog#wtf(String, Throwable)}. */

    public static int wtf(String tag, Throwable tr) {

        return Slog.wtf(tag, tr);

    }
@@ -144,67 +147,85 @@ public final class Slogf { 
    }



    /** Logs a {@link Log.VERBOSE} message. */

    public static void v(String tag, String format, @Nullable Object... args) {

    @FormatMethod

    public static void v(String tag, @FormatString String format, @Nullable Object... args) {

        v(tag, getMessage(format, args));

    }



    /** Logs a {@link Log.VERBOSE} message with a throwable. */

    public static void v(String tag, Throwable throwable, String format, @Nullable Object... args) {

    @FormatMethod

    public static void v(String tag, Throwable throwable, @FormatString String format,

            @Nullable Object... args) {

        v(tag, getMessage(format, args), throwable);

    }



    /** Logs a {@link Log.DEBUG} message. */

    public static void d(String tag, String format, @Nullable Object... args) {

    @FormatMethod

    public static void d(String tag, @FormatString String format, @Nullable Object... args) {

        d(tag, getMessage(format, args));

    }



    /** Logs a {@link Log.DEBUG} message with a throwable. */

    public static void d(String tag, Throwable throwable, String format, @Nullable Object... args) {

    @FormatMethod

    public static void d(String tag, Throwable throwable, @FormatString String format,

            @Nullable Object... args) {

        d(tag, getMessage(format, args), throwable);

    }



    /** Logs a {@link Log.INFO} message. */

    public static void i(String tag, String format, @Nullable Object... args) {

    @FormatMethod

    public static void i(String tag, @FormatString String format, @Nullable Object... args) {

        i(tag, getMessage(format, args));

    }



    /** Logs a {@link Log.INFO} message with a throwable. */

    public static void i(String tag, Throwable throwable, String format, @Nullable Object... args) {

    @FormatMethod

    public static void i(String tag, Throwable throwable, @FormatString String format,

            @Nullable Object... args) {

        i(tag, getMessage(format, args), throwable);

    }



    /** Logs a {@link Log.WARN} message. */

    public static void w(String tag, String format, @Nullable Object... args) {

    @FormatMethod

    public static void w(String tag, @FormatString String format, @Nullable Object... args) {

        w(tag, getMessage(format, args));

    }



    /** Logs a {@link Log.WARN} message with a throwable. */

    public static void w(String tag, Throwable throwable, String format, @Nullable Object... args) {

    @FormatMethod

    public static void w(String tag, Throwable throwable, @FormatString String format,

            @Nullable Object... args) {

        w(tag, getMessage(format, args), throwable);

    }



    /** Logs a {@link Log.ERROR} message. */

    public static void e(String tag, String format, @Nullable Object... args) {

    @FormatMethod

    public static void e(String tag, @FormatString String format, @Nullable Object... args) {

        e(tag, getMessage(format, args));

    }



    /** Logs a {@link Log.ERROR} message with a throwable. */

    public static void e(String tag, Throwable throwable, String format, @Nullable Object... args) {

    @FormatMethod

    public static void e(String tag, Throwable throwable, @FormatString String format,

            @Nullable Object... args) {

        e(tag, getMessage(format, args), throwable);

    }



    /** Logs a {@code wtf} message. */

    public static void wtf(String tag, String format, @Nullable Object... args) {

    @FormatMethod

    public static void wtf(String tag, @FormatString String format, @Nullable Object... args) {

        wtf(tag, getMessage(format, args));

    }



    /** Logs a {@code wtf} message with a throwable. */

    public static void wtf(String tag, Throwable throwable, String format,

    @FormatMethod

    public static void wtf(String tag, Throwable throwable, @FormatString String format,

            @Nullable Object... args) {

        wtf(tag, getMessage(format, args), throwable);

    }



    private static String getMessage(String format, @Nullable Object... args) {

    @FormatMethod

    private static String getMessage(@FormatString String format, @Nullable Object... args) {

        synchronized (sMessageBuilder) {

            sFormatter.format(format, args);

            String message = sMessageBuilder.toString();