Use Nullable annotations from Android package

This commit is contained in:
Herbert Reiter
2025-08-30 15:30:18 +02:00
parent 009c1e5131
commit d48f50c15a
9 changed files with 64 additions and 67 deletions
@@ -17,20 +17,20 @@
package net.moasdawiki.app;
import androidx.annotation.NonNull;
import net.moasdawiki.base.Logger;
import net.moasdawiki.base.Settings;
import net.moasdawiki.service.repository.RepositoryService;
import org.jetbrains.annotations.NotNull;
public class AndroidSettings extends Settings {
public AndroidSettings(@NotNull Logger logger, @NotNull RepositoryService repositoryService, @NotNull String configFileName) {
public AndroidSettings(@NonNull Logger logger, @NonNull RepositoryService repositoryService, @NonNull String configFileName) {
super(logger, repositoryService, configFileName);
}
@Override
@NotNull
@NonNull
public String getVersion() {
return BuildConfig.VERSION_NAME;
}
@@ -23,7 +23,7 @@ import android.accounts.AccountAuthenticatorResponse;
import android.content.Context;
import android.os.Bundle;
import org.jetbrains.annotations.Nullable;
import androidx.annotation.Nullable;
/**
* Stub authenticator, required for calendar sync adapter.
@@ -21,7 +21,7 @@ import android.app.Service;
import android.content.Intent;
import android.os.IBinder;
import org.jetbrains.annotations.Nullable;
import androidx.annotation.Nullable;
/**
* Service to bind the CalendarAccountAuthenticator.
@@ -21,8 +21,9 @@ import android.content.ContentProvider;
import android.content.ContentValues;
import android.database.Cursor;
import android.net.Uri;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
/**
* Stub content provider, necessary for sync adapter.
@@ -36,33 +37,33 @@ public class CalendarContentProvider extends ContentProvider {
@Nullable
@Override
public String getType(@NotNull Uri uri) {
public String getType(@NonNull Uri uri) {
// Return no type for MIME type
return null;
}
@Nullable
@Override
public Cursor query(@NotNull Uri uri, @Nullable String[] projection, @Nullable String selection, @Nullable String[] selectionArgs, @Nullable String sortOrder) {
public Cursor query(@NonNull Uri uri, @Nullable String[] projection, @Nullable String selection, @Nullable String[] selectionArgs, @Nullable String sortOrder) {
// query() always returns no results
return null;
}
@Nullable
@Override
public Uri insert(@NotNull Uri uri, @Nullable ContentValues contentValues) {
public Uri insert(@NonNull Uri uri, @Nullable ContentValues contentValues) {
// Provider doesn't support changes from outside
return null;
}
@Override
public int delete(@NotNull Uri uri, @Nullable String s, @Nullable String[] strings) {
public int delete(@NonNull Uri uri, @Nullable String s, @Nullable String[] strings) {
// Provider doesn't support changes from outside
return 0;
}
@Override
public int update(@NotNull Uri uri, @Nullable ContentValues contentValues, @Nullable String s, @Nullable String[] strings) {
public int update(@NonNull Uri uri, @Nullable ContentValues contentValues, @Nullable String s, @Nullable String[] strings) {
// Provider doesn't support changes from outside
return 0;
}
@@ -36,6 +36,9 @@ import android.os.Bundle;
import android.os.Handler;
import android.os.Looper;
import android.provider.CalendarContract;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.core.app.ActivityCompat;
import androidx.preference.PreferenceManager;
@@ -45,9 +48,6 @@ import android.widget.Toast;
import net.moasdawiki.service.transform.TerminTransformer;
import net.moasdawiki.util.PathUtils;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collections;
@@ -123,7 +123,7 @@ public class CalendarSyncAdapter extends AbstractThreadedSyncAdapter {
/**
* Imports all events on Wiki pages to the Android calendar.
*/
@NotNull
@NonNull
private List<TerminTransformer.Event> getWikiEvents() {
Log.d(TAG, "Reading Wiki events");
WikiEngineApplication app = (WikiEngineApplication) getContext();
@@ -140,7 +140,7 @@ public class CalendarSyncAdapter extends AbstractThreadedSyncAdapter {
/**
* Fills empty day, month, and year fields in all events.
*/
private void fillEmptyDateFields(@NotNull List<TerminTransformer.Event> events) {
private void fillEmptyDateFields(@NonNull List<TerminTransformer.Event> events) {
TimeZone utc = TimeZone.getTimeZone("UTC");
Calendar calendar = Calendar.getInstance(utc);
for (TerminTransformer.Event event : events) {
@@ -159,8 +159,8 @@ public class CalendarSyncAdapter extends AbstractThreadedSyncAdapter {
/**
* Reduces the number of events if more than MAX_EVENT_COUNT, only keep events in the near future.
*/
@NotNull
private List<TerminTransformer.Event> filterEvents(@NotNull List<TerminTransformer.Event> rawEvents) {
@NonNull
private List<TerminTransformer.Event> filterEvents(@NonNull List<TerminTransformer.Event> rawEvents) {
if (rawEvents.size() <= MAX_EVENT_COUNT) {
return rawEvents;
}
@@ -196,8 +196,8 @@ public class CalendarSyncAdapter extends AbstractThreadedSyncAdapter {
return result;
}
@NotNull
private Uri buildUri(@NotNull Uri uri) {
@NonNull
private Uri buildUri(@NonNull Uri uri) {
return uri.buildUpon()
.appendQueryParameter(android.provider.CalendarContract.CALLER_IS_SYNCADAPTER, "true")
.appendQueryParameter(CalendarContract.Calendars.ACCOUNT_NAME, ACCOUNT_NAME)
@@ -251,7 +251,7 @@ public class CalendarSyncAdapter extends AbstractThreadedSyncAdapter {
/**
* Clears the calendar. This is necessary if e.g. a birthday has been changed or removed.
*/
private void deleteAllEvents(@NotNull String calendarId) {
private void deleteAllEvents(@NonNull String calendarId) {
Log.d(TAG, "Delete all events from calendar");
Uri eventUri = buildUri(EVENT_URI);
try (Cursor cursor = contentResolver.query(eventUri,
@@ -273,7 +273,7 @@ public class CalendarSyncAdapter extends AbstractThreadedSyncAdapter {
* Adds up to 100 events from the event list.
* The first occurrence is in the current year, the events are repeated every year.
*/
private void addEvents(@NotNull String calendarId, @NotNull List<TerminTransformer.Event> events) {
private void addEvents(@NonNull String calendarId, @NonNull List<TerminTransformer.Event> events) {
Log.d(TAG, "Create calendar events");
for (TerminTransformer.Event event : events) {
String title = event.description;
@@ -293,7 +293,7 @@ public class CalendarSyncAdapter extends AbstractThreadedSyncAdapter {
* Adds a single event to the calendar.
*/
@Nullable
private String addEvent(@NotNull String calendarId, int day, int month, int year, @NotNull String title, @NotNull String description) {
private String addEvent(@NonNull String calendarId, int day, int month, int year, @NonNull String title, @NonNull String description) {
Log.d(TAG, "Create calendar event: day=" + day + ", month=" + month + ", year=" + year
+ ", title=" + title + ", description=" + description);
ContentValues cv = new ContentValues();
@@ -324,7 +324,7 @@ public class CalendarSyncAdapter extends AbstractThreadedSyncAdapter {
/**
* Add a reminder to the given event.
*/
private void addReminder(@NotNull String eventId) {
private void addReminder(@NonNull String eventId) {
Log.d(TAG, "Add reminder to eventId=" + eventId);
ContentValues cv = new ContentValues();
cv.put(CalendarContract.Reminders.EVENT_ID, eventId);
@@ -338,7 +338,7 @@ public class CalendarSyncAdapter extends AbstractThreadedSyncAdapter {
/**
* Initiates the calendar sync.
*/
public static void requestCalendarSync(@NotNull Activity activity) {
public static void requestCalendarSync(@NonNull Activity activity) {
Log.d(TAG, "Requesting calendar synchronization");
Context context = activity.getApplicationContext();
@@ -21,7 +21,7 @@ import android.app.Service;
import android.content.Intent;
import android.os.IBinder;
import org.jetbrains.annotations.Nullable;
import androidx.annotation.Nullable;
public class CalendarSyncAdapterService extends Service {
@@ -46,6 +46,7 @@ import android.widget.TextView;
import android.widget.Toast;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.appcompat.app.AppCompatActivity;
import androidx.appcompat.view.menu.MenuBuilder;
import androidx.preference.PreferenceManager;
@@ -59,9 +60,6 @@ import net.moasdawiki.service.HttpResponse;
import net.moasdawiki.service.repository.RepositoryService;
import net.moasdawiki.util.EscapeUtils;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
@@ -134,7 +132,7 @@ public class MainActivity extends AppCompatActivity {
* External URLs will be shown in an external browser.
*/
@Override
public boolean shouldOverrideUrlLoading(@NotNull WebView view, @NotNull WebResourceRequest webResourceRequest) {
public boolean shouldOverrideUrlLoading(@NonNull WebView view, @NonNull WebResourceRequest webResourceRequest) {
Uri uri = webResourceRequest.getUrl();
String host = uri.getHost();
if ("localhost".equals(host)) {
@@ -154,7 +152,7 @@ public class MainActivity extends AppCompatActivity {
*/
@Override
@Nullable
public WebResourceResponse shouldInterceptRequest (@NotNull WebView view, @NotNull WebResourceRequest request) {
public WebResourceResponse shouldInterceptRequest (@NonNull WebView view, @NonNull WebResourceRequest request) {
try {
// determine URL path
Uri uri = request.getUrl();
@@ -204,8 +202,8 @@ public class MainActivity extends AppCompatActivity {
webSettings.setJavaScriptEnabled(true);
}
@NotNull
private Map<String, String> convertParameters(@NotNull Uri uri) {
@NonNull
private Map<String, String> convertParameters(@NonNull Uri uri) {
Map<String, String> result = new HashMap<>();
for (String name : uri.getQueryParameterNames()) {
String value = uri.getQueryParameter(name);
@@ -216,7 +214,7 @@ public class MainActivity extends AppCompatActivity {
@SuppressLint("RestrictedApi")
@Override
public boolean onCreateOptionsMenu(@NotNull Menu menu) {
public boolean onCreateOptionsMenu(@NonNull Menu menu) {
// Inflate the menu; this adds items to the action bar if it is present.
getMenuInflater().inflate(R.menu.menu_layout, menu);
if(menu instanceof MenuBuilder){
@@ -232,7 +230,7 @@ public class MainActivity extends AppCompatActivity {
}
@Override
public boolean onOptionsItemSelected(@NotNull MenuItem item) {
public boolean onOptionsItemSelected(@NonNull MenuItem item) {
// Handle action bar item clicks here. The action bar will
// automatically handle clicks on the Home/Up button, so long
// as you specify a parent activity in AndroidManifest.xml.
@@ -387,17 +385,17 @@ public class MainActivity extends AppCompatActivity {
/**
* Open a URL in the embedded browser.
*/
private void loadUrl(@NotNull String url) {
private void loadUrl(@NonNull String url) {
Log.d(TAG, "Open URL " + url);
webview.loadUrl(url);
}
@NotNull
private String getWikiserverSearchUrl(@NotNull String query) {
@NonNull
private String getWikiserverSearchUrl(@NonNull String query) {
return SERVER_BASE_URL + "search/?text=" + EscapeUtils.encodeUrlParameter(query);
}
@NotNull
@NonNull
private String getWikiserverHelpUrl() {
return SERVER_BASE_URL + "view/wiki/";
}
@@ -20,10 +20,9 @@ package net.moasdawiki.app;
import android.os.Bundle;
import androidx.annotation.Nullable;
import androidx.appcompat.app.AppCompatActivity;
import org.jetbrains.annotations.Nullable;
/**
* Settings dialog
*/
@@ -23,6 +23,8 @@ import android.os.Build;
import android.util.Base64;
import android.util.Log;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.preference.PreferenceManager;
import net.moasdawiki.base.Logger;
@@ -35,9 +37,6 @@ import net.moasdawiki.util.DateUtils;
import net.moasdawiki.util.xml.XmlGenerator;
import net.moasdawiki.util.xml.XmlParser;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
@@ -67,19 +66,19 @@ public class SynchronizeWikiClient {
private static final int CONNECTION_READ_TIMEOUT = 120_000; // 2 minutes
private static final int CONNECTION_RETRIES = 3;
@NotNull
@NonNull
private final Context mContext;
@NotNull
@NonNull
private final Logger logger;
@NotNull
@NonNull
private final Settings settings;
@NotNull
@NonNull
private final RepositoryService repositoryService;
@NotNull
@NonNull
private final SecureRandom random;
public SynchronizeWikiClient(@NotNull Context mContext, @NotNull Logger logger, @NotNull Settings settings,
@NotNull RepositoryService repositoryService) {
public SynchronizeWikiClient(@NonNull Context mContext, @NonNull Logger logger, @NonNull Settings settings,
@NonNull RepositoryService repositoryService) {
this.mContext = mContext;
this.logger = logger;
this.settings = settings;
@@ -133,7 +132,7 @@ public class SynchronizeWikiClient {
/**
* Connects with the MoasdaWiki server and creates a new session.
*/
private void createSession(@NotNull String serverHostPort) throws ServiceException {
private void createSession(@NonNull String serverHostPort) throws ServiceException {
// send request
CreateSessionXml createSessionXml = new CreateSessionXml();
createSessionXml.version = PROTOCOL_VERSION;
@@ -170,7 +169,7 @@ public class SynchronizeWikiClient {
editor.apply();
}
@NotNull
@NonNull
private String generateSessionId() {
return new BigInteger(130, random).toString(32);
}
@@ -178,8 +177,8 @@ public class SynchronizeWikiClient {
/**
* Check if our MoasdaWiki server session is valid and authorized.
*/
@NotNull
private SessionStatus checkSession(@NotNull String serverHostPort) throws ServiceException {
@NonNull
private SessionStatus checkSession(@NonNull String serverHostPort) throws ServiceException {
SharedPreferences preferences = PreferenceManager.getDefaultSharedPreferences(mContext);
String serverSessionId = preferences.getString(Constants.PREFERENCES_SYNC_SERVER_SESSION_ID, null);
String clientSessionId = preferences.getString(Constants.PREFERENCES_SYNC_CLIENT_SESSION_ID, null);
@@ -352,7 +351,7 @@ public class SynchronizeWikiClient {
}
}
private void downloadFileFromServer(@NotNull String serverHostPort, @NotNull String serverSessionId, @NotNull String filePath) throws ServiceException {
private void downloadFileFromServer(@NonNull String serverHostPort, @NonNull String serverSessionId, @NonNull String filePath) throws ServiceException {
// Anfrage schicken
ReadFileXml readFileXml = new ReadFileXml();
readFileXml.version = PROTOCOL_VERSION;
@@ -428,7 +427,7 @@ public class SynchronizeWikiClient {
return null;
}
@NotNull
@NonNull
private String getDeviceName() {
String manufacturer = Build.MANUFACTURER;
String model = Build.MODEL;
@@ -449,8 +448,8 @@ public class SynchronizeWikiClient {
/**
* Sends an XML request and reads the XML response.
*/
@NotNull
private String sendXmlRequest(@NotNull String serverHostPort, @NotNull String urlPath, @NotNull String requestXml) throws ServiceException {
@NonNull
private String sendXmlRequest(@NonNull String serverHostPort, @NonNull String urlPath, @NonNull String requestXml) throws ServiceException {
try {
String url = "http://" + serverHostPort + urlPath;
Log.d(TAG, "Request to " + url + ": " + truncateLogText(requestXml, 200));
@@ -468,7 +467,7 @@ public class SynchronizeWikiClient {
}
}
private byte[] sendBinaryRequestWithRetries(@NotNull URL url, byte[] requestBytes) throws ServiceException {
private byte[] sendBinaryRequestWithRetries(@NonNull URL url, byte[] requestBytes) throws ServiceException {
for (int i = 1; i <= CONNECTION_RETRIES; i++) {
try {
return sendBinaryRequest(url, requestBytes);
@@ -480,7 +479,7 @@ public class SynchronizeWikiClient {
throw new ServiceException("Error sending request to MoasdaWiki server for " + CONNECTION_RETRIES + " times, failed");
}
private byte[] sendBinaryRequest(@NotNull URL url, byte[] requestBytes) throws IOException {
private byte[] sendBinaryRequest(@NonNull URL url, byte[] requestBytes) throws IOException {
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("POST");
conn.setRequestProperty("Content-Type", "text/xml");
@@ -516,8 +515,8 @@ public class SynchronizeWikiClient {
/**
* Wandelt eine JAXB-Bean in einen XML-Strom um.
*/
@NotNull
private String generateXml(@NotNull AbstractSyncXml xmlBean) throws ServiceException {
@NonNull
private String generateXml(@NonNull AbstractSyncXml xmlBean) throws ServiceException {
XmlGenerator xmlGenerator = new XmlGenerator();
return xmlGenerator.generate(xmlBean);
}
@@ -525,8 +524,8 @@ public class SynchronizeWikiClient {
/**
* Wandelt einen XML-Strom in eine JAXB-Bean um.
*/
@NotNull
private <T extends AbstractSyncXml> T parseXml(@NotNull String xml, @NotNull Class<T> xmlBeanType) throws ServiceException {
@NonNull
private <T extends AbstractSyncXml> T parseXml(@NonNull String xml, @NonNull Class<T> xmlBeanType) throws ServiceException {
try {
XmlParser xmlParser = new XmlParser(logger);
return xmlParser.parse(xml, xmlBeanType);