From 3321a026e0656b3e5ff770830184a661dee9aa0a Mon Sep 17 00:00:00 2001 From: Artak Kalantarian Date: Thu, 15 Dec 2022 00:34:27 -0800 Subject: [PATCH] JavaDoc error fixes (#596) Co-authored-by: Artak Kalantarian --- .../android/MapboxGLAndroidSDK/build.gradle | 1 + .../mapboxsdk/MapStrictModeException.java | 2 +- .../java/com/mapbox/mapboxsdk/Mapbox.java | 2 ++ .../MapboxConfigurationException.java | 10 ++++--- .../com/mapbox/mapboxsdk/maps/MapView.java | 29 ++++++++++++------- .../java/com/mapbox/mapboxsdk/MapboxTest.java | 4 +-- .../activity/maplayout/DebugModeActivity.kt | 9 +++--- 7 files changed, 34 insertions(+), 23 deletions(-) diff --git a/platform/android/MapboxGLAndroidSDK/build.gradle b/platform/android/MapboxGLAndroidSDK/build.gradle index 9454ee777..e71fc5f10 100644 --- a/platform/android/MapboxGLAndroidSDK/build.gradle +++ b/platform/android/MapboxGLAndroidSDK/build.gradle @@ -13,6 +13,7 @@ dependencies { implementation dependenciesList.supportFragmentV4 implementation dependenciesList.okhttp3 implementation dependenciesList.gmsLocation + implementation dependenciesList.timber testImplementation dependenciesList.junit testImplementation dependenciesList.mockito diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/MapStrictModeException.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/MapStrictModeException.java index 5bfddabf9..acedcbed6 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/MapStrictModeException.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/MapStrictModeException.java @@ -1,6 +1,6 @@ package com.mapbox.mapboxsdk; -class MapStrictModeException extends RuntimeException { +public class MapStrictModeException extends RuntimeException { MapStrictModeException(String message) { super(String.format("Map detected an error that would fail silently otherwise: %s", message)); } diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/Mapbox.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/Mapbox.java index ce009c265..200a1dc69 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/Mapbox.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/Mapbox.java @@ -8,6 +8,7 @@ import androidx.annotation.Keep; import androidx.annotation.NonNull; import androidx.annotation.Nullable; import androidx.annotation.UiThread; +import timber.log.Timber; import com.mapbox.mapboxsdk.constants.MapboxConstants; import com.mapbox.mapboxsdk.exceptions.MapboxConfigurationException; @@ -92,6 +93,7 @@ public final class Mapbox { ThreadUtils.init(context); ThreadUtils.checkThread(TAG); if (INSTANCE == null) { + Timber.plant(new Timber.DebugTree()); Context appContext = context.getApplicationContext(); FileSource.initializeFileDirsPaths(appContext); INSTANCE = new Mapbox(appContext, apiKey); diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/exceptions/MapboxConfigurationException.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/exceptions/MapboxConfigurationException.java index 88fc1b871..f58f57bda 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/exceptions/MapboxConfigurationException.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/exceptions/MapboxConfigurationException.java @@ -1,5 +1,7 @@ package com.mapbox.mapboxsdk.exceptions; +import com.mapbox.mapboxsdk.WellKnownTileServer; + import android.content.Context; import androidx.annotation.NonNull; @@ -8,10 +10,10 @@ import androidx.annotation.NonNull; * A MapboxConfigurationException is thrown by MapboxMap when the SDK hasn't been properly initialised. *

* This occurs either when {@link com.mapbox.mapboxsdk.Mapbox} is not correctly initialised or the provided apiKey - * through {@link com.mapbox.mapboxsdk.Mapbox#getInstance(Context, String)} isn't valid. + * through {@link com.mapbox.mapboxsdk.Mapbox#getInstance(Context, String, WellKnownTileServer)} isn't valid. *

* - * @see com.mapbox.mapboxsdk.Mapbox#getInstance(Context, String) + * @see com.mapbox.mapboxsdk.Mapbox#getInstance(Context, String, WellKnownTileServer) */ public class MapboxConfigurationException extends RuntimeException { @@ -19,8 +21,8 @@ public class MapboxConfigurationException extends RuntimeException { * Creates a Mapbox configuration exception thrown by MapboxMap when the SDK hasn't been properly initialised. */ public MapboxConfigurationException() { - super("\nUsing MapView requires calling Mapbox.getInstance(Context context, String apiKey) before " - + "inflating or creating the view."); + super("\nUsing MapView requires calling Mapbox.getInstance(Context context, String apiKey, " + + "WellKnownTileServer wellKnownTileServer) before inflating or creating the view."); } /** diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapView.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapView.java index 85c736605..fe8804b62 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapView.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapView.java @@ -18,11 +18,13 @@ import androidx.annotation.NonNull; import androidx.annotation.Nullable; import androidx.annotation.UiThread; import androidx.collection.LongSparseArray; +import timber.log.Timber; import com.mapbox.android.gestures.AndroidGesturesManager; import com.mapbox.mapboxsdk.MapStrictMode; import com.mapbox.mapboxsdk.Mapbox; import com.mapbox.mapboxsdk.R; +import com.mapbox.mapboxsdk.WellKnownTileServer; import com.mapbox.mapboxsdk.annotations.Annotation; import com.mapbox.mapboxsdk.constants.MapboxConstants; import com.mapbox.mapboxsdk.exceptions.MapboxConfigurationException; @@ -99,24 +101,28 @@ public class MapView extends FrameLayout implements NativeMapView.ViewCallback { @UiThread public MapView(@NonNull Context context) { super(context); + Timber.d("MapView constructed with context"); initialize(context, MapboxMapOptions.createFromAttributes(context)); } @UiThread public MapView(@NonNull Context context, @Nullable AttributeSet attrs) { super(context, attrs); + Timber.d("MapView constructed with context and attribute set"); initialize(context, MapboxMapOptions.createFromAttributes(context, attrs)); } @UiThread public MapView(@NonNull Context context, @Nullable AttributeSet attrs, int defStyleAttr) { super(context, attrs, defStyleAttr); + Timber.d( "MapView constructed with context, attributeSet and defStyleAttr"); initialize(context, MapboxMapOptions.createFromAttributes(context, attrs)); } @UiThread public MapView(@NonNull Context context, @Nullable MapboxMapOptions options) { super(context); + Timber.d("MapView constructed with context and MapboxMapOptions"); initialize(context, options == null ? MapboxMapOptions.createFromAttributes(context) : options); } @@ -160,18 +166,18 @@ public class MapView extends FrameLayout implements NativeMapView.ViewCallback { Polylines polylines = new PolylineContainer(nativeMapView, annotationsArray); ShapeAnnotations shapeAnnotations = new ShapeAnnotationContainer(nativeMapView, annotationsArray); AnnotationManager annotationManager = new AnnotationManager(this, annotationsArray, iconManager, - annotations, markers, polygons, polylines, shapeAnnotations); + annotations, markers, polygons, polylines, shapeAnnotations); Transform transform = new Transform(this, nativeMapView, cameraDispatcher); // MapboxMap List developerAnimationListeners = new ArrayList<>(); mapboxMap = new MapboxMap(nativeMapView, transform, uiSettings, proj, registerTouchListener, cameraDispatcher, - developerAnimationListeners); + developerAnimationListeners); mapboxMap.injectAnnotationManager(annotationManager); // user input mapGestureDetector = new MapGestureDetector(context, transform, proj, uiSettings, - annotationManager, cameraDispatcher); + annotationManager, cameraDispatcher); mapKeyListener = new MapKeyListener(transform, uiSettings, mapGestureDetector); // LocationComponent @@ -245,7 +251,7 @@ public class MapView extends FrameLayout implements NativeMapView.ViewCallback { } private MapboxMap.OnCompassAnimationListener createCompassAnimationListener(@NonNull final CameraChangeDispatcher - cameraChangeDispatcher) { + cameraChangeDispatcher) { return new MapboxMap.OnCompassAnimationListener() { @Override public void onCompassAnimation() { @@ -289,11 +295,12 @@ public class MapView extends FrameLayout implements NativeMapView.ViewCallback { * You must call this method from the parent's Activity#onCreate(Bundle)} or * Fragment#onViewCreated(View, Bundle). *

- * You must set a valid access token with {@link com.mapbox.mapboxsdk.Mapbox#getInstance(Context, String)} + * You must set a valid access token with + * {@link com.mapbox.mapboxsdk.Mapbox#getInstance(Context, String, WellKnownTileServer)} * before you call this method or an exception will be thrown. * * @param savedInstanceState Pass in the parent's savedInstanceState. - * @see com.mapbox.mapboxsdk.Mapbox#getInstance(Context, String) + * @see com.mapbox.mapboxsdk.Mapbox#getInstance(Context, String, WellKnownTileServer) */ @UiThread public void onCreate(@Nullable Bundle savedInstanceState) { @@ -308,7 +315,7 @@ public class MapView extends FrameLayout implements NativeMapView.ViewCallback { TextureView textureView = new TextureView(getContext()); boolean translucentSurface = options.getTranslucentTextureSurface(); mapRenderer = new TextureViewMapRenderer(getContext(), - textureView, localFontFamily, translucentSurface) { + textureView, localFontFamily, translucentSurface) { @Override protected void onSurfaceCreated(GL10 gl, EGLConfig config) { MapView.this.onSurfaceCreated(); @@ -335,7 +342,7 @@ public class MapView extends FrameLayout implements NativeMapView.ViewCallback { boolean crossSourceCollisions = mapboxMapOptions.getCrossSourceCollisions(); nativeMapView = new NativeMapView( - getContext(), getPixelRatio(), crossSourceCollisions, this, mapChangeReceiver, mapRenderer + getContext(), getPixelRatio(), crossSourceCollisions, this, mapChangeReceiver, mapRenderer ); } @@ -1272,7 +1279,7 @@ public class MapView extends FrameLayout implements NativeMapView.ViewCallback { public void setGesturesManager(AndroidGesturesManager gesturesManager, boolean attachDefaultListeners, boolean setDefaultMutuallyExclusives) { mapGestureDetector.setGesturesManager( - getContext(), gesturesManager, attachDefaultListeners, setDefaultMutuallyExclusives); + getContext(), gesturesManager, attachDefaultListeners, setDefaultMutuallyExclusives); } @Override @@ -1282,8 +1289,8 @@ public class MapView extends FrameLayout implements NativeMapView.ViewCallback { } private class MapCallback implements OnDidFinishLoadingStyleListener, - OnDidFinishRenderingFrameListener, OnDidFinishLoadingMapListener, - OnCameraIsChangingListener, OnCameraDidChangeListener, OnDidFailLoadingMapListener { + OnDidFinishRenderingFrameListener, OnDidFinishLoadingMapListener, + OnCameraIsChangingListener, OnCameraDidChangeListener, OnDidFailLoadingMapListener { private final List onMapReadyCallbackList = new ArrayList<>(); diff --git a/platform/android/MapboxGLAndroidSDK/src/test/java/com/mapbox/mapboxsdk/MapboxTest.java b/platform/android/MapboxGLAndroidSDK/src/test/java/com/mapbox/mapboxsdk/MapboxTest.java index 8a2d2a3a9..edc9a2fd6 100644 --- a/platform/android/MapboxGLAndroidSDK/src/test/java/com/mapbox/mapboxsdk/MapboxTest.java +++ b/platform/android/MapboxGLAndroidSDK/src/test/java/com/mapbox/mapboxsdk/MapboxTest.java @@ -85,8 +85,8 @@ public class MapboxTest { expectedException.expect(MapboxConfigurationException.class); expectedException.expectMessage( - "\nUsing MapView requires calling Mapbox.getInstance(Context context, String apiKey) before " - + "inflating or creating the view." + "\nUsing MapView requires calling Mapbox.getInstance(Context context, String apiKey," + + " WellKnownTileServer wellKnownTileServer) before inflating or creating the view." ); new MapView(context); } diff --git a/platform/android/MapboxGLAndroidSDKTestApp/src/main/java/com/mapbox/mapboxsdk/testapp/activity/maplayout/DebugModeActivity.kt b/platform/android/MapboxGLAndroidSDKTestApp/src/main/java/com/mapbox/mapboxsdk/testapp/activity/maplayout/DebugModeActivity.kt index 8c644627f..3fa496c13 100644 --- a/platform/android/MapboxGLAndroidSDKTestApp/src/main/java/com/mapbox/mapboxsdk/testapp/activity/maplayout/DebugModeActivity.kt +++ b/platform/android/MapboxGLAndroidSDKTestApp/src/main/java/com/mapbox/mapboxsdk/testapp/activity/maplayout/DebugModeActivity.kt @@ -15,7 +15,6 @@ import com.mapbox.mapboxsdk.style.layers.Layer import com.mapbox.mapboxsdk.style.layers.Property import com.mapbox.mapboxsdk.style.layers.PropertyFactory import com.mapbox.mapboxsdk.testapp.R -import com.mapbox.mapboxsdk.testapp.activity.maplayout.DebugModeActivity.LayerListAdapter import timber.log.Timber import java.util.* @@ -216,7 +215,7 @@ open class DebugModeActivity : AppCompatActivity(), OnMapReadyCallback, OnFpsCha mapView!!.onLowMemory() } - private class LayerListAdapter internal constructor(context: Context?, layers: List) : + private class LayerListAdapter(context: Context?, layers: List) : BaseAdapter() { private val layoutInflater: LayoutInflater private val layers: List @@ -232,7 +231,7 @@ open class DebugModeActivity : AppCompatActivity(), OnMapReadyCallback, OnFpsCha return position.toLong() } - override fun getView(position: Int, convertView: View, parent: ViewGroup): View { + override fun getView(position: Int, convertView: View?, parent: ViewGroup): View { val layer = layers[position] var view = convertView if (view == null) { @@ -243,13 +242,13 @@ open class DebugModeActivity : AppCompatActivity(), OnMapReadyCallback, OnFpsCha ) view.tag = holder } - val holder = view.tag as ViewHolder + val holder = view!!.tag as ViewHolder holder.text.text = layer.javaClass.simpleName holder.subText.text = layer.id return view } - private class ViewHolder internal constructor(val text: TextView, val subText: TextView) + private class ViewHolder(val text: TextView, val subText: TextView) init { layoutInflater = LayoutInflater.from(context)