Правильный способ использования аннотации @NonNull в Android Studio

Question

Я хотел бы использовать аннотацию @NonNull на Android, но я не могу понять, как это сделать. Я предлагаю вам этот пример:

public void doStuff(@NonNull String s){ 
    //do work with s...  
} 

Так что, когда я называю doStuff(null) интегрированная среда даст мне предупреждение. Проблема в том, что я не могу полагаться на эту аннотацию, поскольку, как и вопрос this, они не распространяются очень далеко. Так что я хотел бы поставить нулевую проверку на мой метод, как это:

if(s==null) throw new IllegalAgrumentException(); 

Но IDE, предполагая, что s!=null, предупреждает меня, что s==null всегда ложно. Я хотел бы знать, как лучше всего это сделать.

Я лично считаю, что должно быть аннотация как @ShouldntBeNull что только проверки и предупреждает, что нуль не передается к нему, но не жалуется, когда значение нуля проверяется.

Answer 1

Вы можете использовать подавление комментариев в стиле, чтобы отключить это конкретное предупреждение проверки нуля, например .:

public MyMethod(@NonNull Context pContext) { 
     //noinspection ConstantConditions 
     if (pContext == null) { 
      throw new IllegalArgumentException(); 
     } 
     ... 
    } 

Вам нужны что //noinspection ConstantConditions каждый раз, когда вы делаете это.

Answer 2

Для этого вы можете использовать Objects.requireNonNull. Он будет выполнять проверку внутри (так IDE не будет отображаться предупреждение о вашей функции) и поднять NullPointerException когда параметр null:

public MyMethod(@NonNull Context pContext) { 
    Objects.requireNonNull(pContext); 
    ... 
} 

Если вы хотите, чтобы бросить еще одно исключение или использовать уровень API < 19, то вы можете просто сделать свой собственный вспомогательный класс для реализации той же проверки. например

public class Check { 
    public static <T> T requireNonNull(T obj) { 
     if (obj == null) 
      throw new IllegalArgumentException(); 
     return obj; 
    } 
} 

и использовать его так:

public MyMethod(@NonNull Context pContext) { 
    Check.requireNonNull(pContext); 
    ... 
} 

Answer 3

Google examples сделать это следующим образом

import static com.google.common.base.Preconditions.checkNotNull; 

... 

public void doStuff(@NonNull String sParm){ 
    this.sParm= checkNotNull(s, "sParm cannot be null!"); 
}