Merge pull request orhanobut#166 from svenjacobs/feature/nullable_ann…

…otations

Add Android support @NonNull/@nullable annotations

.travis.yml

@@ -5,9 +5,8 @@ android:
   components:
     - tools
     - platform-tools
-    - build-tools-25.0.2
-    - android-23
-    - android-24
+    - build-tools-27.0.3
+    - android-27
 
 script:
-- ./gradlew check
+- ./gradlew check

build.gradle

@@ -23,32 +23,35 @@ subprojects { project ->
 
   buildscript {
     repositories {
+      google()
       jcenter()
     }
     dependencies {
-      classpath 'com.android.tools.build:gradle:2.3.2'
+      classpath 'com.android.tools.build:gradle:3.0.1'
     }
   }
 
   repositories {
+    google()
     jcenter()
   }
 }
 
 ext {
   minSdkVersion = 8
-  targetSdkVersion = 23
-  compileSdkVersion = 23
-  buildToolsVersion = '25.0.2'
+  targetSdkVersion = 27
+  compileSdkVersion = 27
+  buildToolsVersion = '27.0.3'
   sourceCompatibilityVersion = JavaVersion.VERSION_1_7
   targetCompatibilityVersion = JavaVersion.VERSION_1_7
 }
 
 ext.deps = [
     // Test dependencies
-    junit      : 'junit:junit:4.12',
-    truth      : 'com.google.truth:truth:0.28',
-    robolectric: 'org.robolectric:robolectric:3.3',
-    mockito    : "org.mockito:mockito-core:1.10.19",
-    json       : "org.json:json:20160810"
+    junit             : 'junit:junit:4.12',
+    truth             : 'com.google.truth:truth:0.28',
+    robolectric       : 'org.robolectric:robolectric:3.3',
+    mockito           : "org.mockito:mockito-core:1.10.19",
+    json              : "org.json:json:20160810",
+    supportAnnotations: "com.android.support:support-annotations:27.1.0"
 ]

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,5 @@
-#Thu May 25 13:02:58 CEST 2017
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.6-all.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-3.3-all.zip

gradlew

@@ -1,25 +1,43 @@
-#!/usr/bin/env bash
+#!/usr/bin/env sh
 
 ##############################################################################
 ##
 ##  Gradle start up script for UN*X
 ##
 ##############################################################################
 
-# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS=""
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ] ; do
+    ls=`ls -ld "$PRG"`
+    link=`expr "$ls" : '.*-> \(.*\)$'`
+    if expr "$link" : '/.*' > /dev/null; then
+        PRG="$link"
+    else
+        PRG=`dirname "$PRG"`"/$link"
+    fi
+done
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/" >/dev/null
+APP_HOME="`pwd -P`"
+cd "$SAVED" >/dev/null
 
 APP_NAME="Gradle"
 APP_BASE_NAME=`basename "$0"`
 
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS=""
+
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD="maximum"
 
-warn ( ) {
+warn () {
     echo "$*"
 }
 
-die ( ) {
+die () {
     echo
     echo "$*"
     echo
@@ -30,6 +48,7 @@ die ( ) {
 cygwin=false
 msys=false
 darwin=false
+nonstop=false
 case "`uname`" in
   CYGWIN* )
     cygwin=true
@@ -40,31 +59,11 @@ case "`uname`" in
   MINGW* )
     msys=true
     ;;
+  NONSTOP* )
+    nonstop=true
+    ;;
 esac
 
-# For Cygwin, ensure paths are in UNIX format before anything is touched.
-if $cygwin ; then
-    [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
-fi
-
-# Attempt to set APP_HOME
-# Resolve links: $0 may be a link
-PRG="$0"
-# Need this for relative symlinks.
-while [ -h "$PRG" ] ; do
-    ls=`ls -ld "$PRG"`
-    link=`expr "$ls" : '.*-> \(.*\)$'`
-    if expr "$link" : '/.*' > /dev/null; then
-        PRG="$link"
-    else
-        PRG=`dirname "$PRG"`"/$link"
-    fi
-done
-SAVED="`pwd`"
-cd "`dirname \"$PRG\"`/" >&-
-APP_HOME="`pwd -P`"
-cd "$SAVED" >&-
-
 CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
 
 # Determine the Java command to use to start the JVM.
@@ -90,7 +89,7 @@ location of your Java installation."
 fi
 
 # Increase the maximum file descriptors if we can.
-if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then
+if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
     MAX_FD_LIMIT=`ulimit -H -n`
     if [ $? -eq 0 ] ; then
         if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
@@ -114,6 +113,7 @@ fi
 if $cygwin ; then
     APP_HOME=`cygpath --path --mixed "$APP_HOME"`
     CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+    JAVACMD=`cygpath --unix "$JAVACMD"`
 
     # We build the pattern for arguments to be converted via cygpath
     ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
@@ -154,11 +154,19 @@ if $cygwin ; then
     esac
 fi
 
-# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules
-function splitJvmOpts() {
-    JVM_OPTS=("$@")
+# Escape application args
+save () {
+    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+    echo " "
 }
-eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
-JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
+APP_ARGS=$(save "$@")
+
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+
+# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
+if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
+  cd "$(dirname "$0")"
+fi
 
-exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"
+exec "$JAVACMD" "$@"

gradlew.bat

@@ -8,14 +8,14 @@
 @rem Set local scope for the variables with windows NT shell
 if "%OS%"=="Windows_NT" setlocal
 
-@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-set DEFAULT_JVM_OPTS=
-
 set DIRNAME=%~dp0
 if "%DIRNAME%" == "" set DIRNAME=.
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS=
+
 @rem Find java.exe
 if defined JAVA_HOME goto findJavaFromJavaHome
 
@@ -46,10 +46,9 @@ echo location of your Java installation.
 goto fail
 
 :init
-@rem Get command-line arguments, handling Windowz variants
+@rem Get command-line arguments, handling Windows variants
 
 if not "%OS%" == "Windows_NT" goto win9xME_args
-if "%@eval[2+2]" == "4" goto 4NT_args
 
 :win9xME_args
 @rem Slurp the command line arguments.
@@ -60,11 +59,6 @@ set _SKIP=2
 if "x%~1" == "x" goto execute
 
 set CMD_LINE_ARGS=%*
-goto execute
-
-:4NT_args
-@rem Get arguments from the 4NT Shell from JP Software
-set CMD_LINE_ARGS=%$
 
 :execute
 @rem Setup the command line

logger/build.gradle

@@ -19,11 +19,12 @@ android {
 }
 
 dependencies {
-  testCompile deps.junit
-  testCompile deps.truth
-  testCompile deps.robolectric
-  testCompile deps.mockito
-  testCompile deps.json
+  implementation deps.supportAnnotations
+  testImplementation deps.junit
+  testImplementation deps.truth
+  testImplementation deps.robolectric
+  testImplementation deps.mockito
+  testImplementation deps.json
 }
 
-apply from: rootProject.file('gradle/maven_push.gradle')
+apply from: rootProject.file('gradle/maven_push.gradle')

logger/src/main/java/com/orhanobut/logger/AndroidLogAdapter.java

@@ -1,23 +1,28 @@
 package com.orhanobut.logger;
 
+import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
+
+import static com.orhanobut.logger.Utils.checkNotNull;
+
 public class AndroidLogAdapter implements LogAdapter {
 
-  private final FormatStrategy formatStrategy;
+  @NonNull private final FormatStrategy formatStrategy;
 
   public AndroidLogAdapter() {
     this.formatStrategy = PrettyFormatStrategy.newBuilder().build();
   }
 
-  public AndroidLogAdapter(FormatStrategy formatStrategy) {
-    this.formatStrategy = formatStrategy;
+  public AndroidLogAdapter(@NonNull FormatStrategy formatStrategy) {
+    this.formatStrategy = checkNotNull(formatStrategy);
   }
 
-  @Override public boolean isLoggable(int priority, String tag) {
+  @Override public boolean isLoggable(int priority, @Nullable String tag) {
     return true;
   }
 
-  @Override public void log(int priority, String tag, String message) {
+  @Override public void log(int priority, @Nullable String tag, @NonNull String message) {
     formatStrategy.log(priority, tag, message);
   }
 
-}
+}

logger/src/main/java/com/orhanobut/logger/CsvFormatStrategy.java

@@ -3,12 +3,16 @@
 import android.os.Environment;
 import android.os.Handler;
 import android.os.HandlerThread;
+import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
 
 import java.io.File;
 import java.text.SimpleDateFormat;
 import java.util.Date;
 import java.util.Locale;
 
+import static com.orhanobut.logger.Utils.checkNotNull;
+
 /**
  * CSV formatted file logging for Android.
  * Writes to CSV the following data:
@@ -20,23 +24,27 @@ public class CsvFormatStrategy implements FormatStrategy {
   private static final String NEW_LINE_REPLACEMENT = " <br> ";
   private static final String SEPARATOR = ",";
 
-  private final Date date;
-  private final SimpleDateFormat dateFormat;
-  private final LogStrategy logStrategy;
-  private final String tag;
+  @NonNull private final Date date;
+  @NonNull private final SimpleDateFormat dateFormat;
+  @NonNull private final LogStrategy logStrategy;
+  @Nullable private final String tag;
+
+  private CsvFormatStrategy(@NonNull Builder builder) {
+    checkNotNull(builder);
 
-  private CsvFormatStrategy(Builder builder) {
     date = builder.date;
     dateFormat = builder.dateFormat;
     logStrategy = builder.logStrategy;
     tag = builder.tag;
   }
 
-  public static Builder newBuilder() {
+  @NonNull public static Builder newBuilder() {
     return new Builder();
   }
 
-  @Override public void log(int priority, String onceOnlyTag, String message) {
+  @Override public void log(int priority, @Nullable String onceOnlyTag, @NonNull String message) {
+    checkNotNull(message);
+
     String tag = formatTag(onceOnlyTag);
 
     date.setTime(System.currentTimeMillis());
@@ -72,7 +80,7 @@ public static Builder newBuilder() {
     logStrategy.log(priority, tag, builder.toString());
   }
 
-  private String formatTag(String tag) {
+  @Nullable private String formatTag(@Nullable String tag) {
     if (!Utils.isEmpty(tag) && !Utils.equals(this.tag, tag)) {
       return this.tag + "-" + tag;
     }
@@ -90,27 +98,27 @@ public static final class Builder {
     private Builder() {
     }
 
-    public Builder date(Date val) {
+    @NonNull public Builder date(@Nullable Date val) {
       date = val;
       return this;
     }
 
-    public Builder dateFormat(SimpleDateFormat val) {
+    @NonNull public Builder dateFormat(@Nullable SimpleDateFormat val) {
       dateFormat = val;
       return this;
     }
 
-    public Builder logStrategy(LogStrategy val) {
+    @NonNull public Builder logStrategy(@Nullable LogStrategy val) {
       logStrategy = val;
       return this;
     }
 
-    public Builder tag(String tag) {
+    @NonNull public Builder tag(@Nullable String tag) {
       this.tag = tag;
       return this;
     }
 
-    public CsvFormatStrategy build() {
+    @NonNull public CsvFormatStrategy build() {
       if (date == null) {
         date = new Date();
       }