[docs] EnterIdle -> BecomeIdle

This commit is contained in:
Chris Loer
2018-12-09 13:30:18 +02:00
committed by Chris Loer
parent 70c2d5a4ca
commit 662a495561
14 changed files with 51 additions and 49 deletions

View File

@@ -39,7 +39,7 @@ public:
virtual void onDidFinishRenderingMap(RenderMode) {}
virtual void onDidFinishLoadingStyle() {}
virtual void onSourceChanged(style::Source&) {}
virtual void onDidEnterIdle() {}
virtual void onDidBecomeIdle() {}
};
} // namespace mbgl

View File

@@ -26,7 +26,7 @@ class MapChangeReceiver implements NativeMapView.StateCallback {
= new CopyOnWriteArrayList<>();
private final List<MapView.OnDidFinishRenderingMapListener> onDidFinishRenderingMapListenerList
= new CopyOnWriteArrayList<>();
private final List<MapView.OnDidEnterIdleListener> onDidEnterIdleListenerList
private final List<MapView.OnDidBecomeIdleListener> onDidBecomeIdleListenerList
= new CopyOnWriteArrayList<>();
private final List<MapView.OnDidFinishLoadingStyleListener> onDidFinishLoadingStyleListenerList
= new CopyOnWriteArrayList<>();
@@ -173,15 +173,15 @@ class MapChangeReceiver implements NativeMapView.StateCallback {
}
@Override
public void onDidEnterIdle() {
public void onDidBecomeIdle() {
try {
if (!onDidEnterIdleListenerList.isEmpty()) {
for (MapView.OnDidEnterIdleListener listener : onDidEnterIdleListenerList) {
listener.onDidEnterIdle();
if (!onDidBecomeIdleListenerList.isEmpty()) {
for (MapView.OnDidBecomeIdleListener listener : onDidBecomeIdleListenerList) {
listener.onDidBecomeIdle();
}
}
} catch (Throwable err) {
Logger.e(TAG, "Exception in onDidEnterIdle", err);
Logger.e(TAG, "Exception in onDidBecomeIdle", err);
throw err;
}
}
@@ -294,12 +294,12 @@ class MapChangeReceiver implements NativeMapView.StateCallback {
onDidFinishRenderingMapListenerList.remove(listener);
}
void addOnDidEnterIdleListener(MapView.OnDidEnterIdleListener listener) {
onDidEnterIdleListenerList.add(listener);
void addOnDidBecomeIdleListener(MapView.OnDidBecomeIdleListener listener) {
onDidBecomeIdleListenerList.add(listener);
}
void removeOnDidEnterIdleListener(MapView.OnDidEnterIdleListener listener) {
onDidEnterIdleListenerList.remove(listener);
void removeOnDidBecomeIdleListener(MapView.OnDidBecomeIdleListener listener) {
onDidBecomeIdleListenerList.remove(listener);
}
void addOnDidFinishLoadingStyleListener(MapView.OnDidFinishLoadingStyleListener listener) {
@@ -329,7 +329,7 @@ class MapChangeReceiver implements NativeMapView.StateCallback {
onDidFinishRenderingFrameList.clear();
onWillStartRenderingMapListenerList.clear();
onDidFinishRenderingMapListenerList.clear();
onDidEnterIdleListenerList.clear();
onDidBecomeIdleListenerList.clear();
onDidFinishLoadingStyleListenerList.clear();
onSourceChangedListenerList.clear();
}

View File

@@ -702,8 +702,8 @@ public class MapView extends FrameLayout implements NativeMapView.ViewCallback {
*
* @param listener The callback that's invoked when the map has entered the idle state.
*/
public void addOnDidEnterIdleListener(OnDidEnterIdleListener listener) {
mapChangeReceiver.addOnDidEnterIdleListener(listener);
public void addOnDidBecomeIdleListener(OnDidBecomeIdleListener listener) {
mapChangeReceiver.addOnDidBecomeIdleListener(listener);
}
/**
@@ -711,8 +711,8 @@ public class MapView extends FrameLayout implements NativeMapView.ViewCallback {
*
* @param listener The callback that's invoked when the map has entered the idle state.
*/
public void removeOnDidEnterIdleListener(OnDidEnterIdleListener listener) {
mapChangeReceiver.removeOnDidEnterIdleListener(listener);
public void removeOnDidBecomeIdleListener(OnDidBecomeIdleListener listener) {
mapChangeReceiver.removeOnDidBecomeIdleListener(listener);
}
/**
@@ -893,14 +893,14 @@ public class MapView extends FrameLayout implements NativeMapView.ViewCallback {
/**
* Interface definition for a callback to be invoked when the map has entered the idle state.
* <p>
* {@link MapView#addOnDidEnterIdleListener(OnDidEnterIdleListener)}
* {@link MapView#addOnDidBecomeIdleListener(OnDidBecomeIdleListener)}
* </p>
*/
public interface OnDidEnterIdleListener {
public interface OnDidBecomeIdleListener {
/**
* Called when the map has entered the idle state.
*/
void onDidEnterIdle();
void onDidBecomeIdle();
}
/**

View File

@@ -1010,8 +1010,8 @@ final class NativeMapView {
}
@Keep
private void onDidEnterIdle() {
stateCallback.onDidEnterIdle();
private void onDidBecomeIdle() {
stateCallback.onDidBecomeIdle();
}
@Keep
@@ -1477,7 +1477,7 @@ final class NativeMapView {
void onDidFinishRenderingMap(boolean fully);
void onDidEnterIdle();
void onDidBecomeIdle();
void onSourceChanged(String sourceId);
}

View File

@@ -56,7 +56,7 @@ public class MapChangeReceiverTest {
private MapView.OnDidFinishRenderingMapListener onDidFinishRenderingMapListener;
@Mock
private MapView.OnDidEnterIdleListener onDidEnterIdleListener;
private MapView.OnDidBecomeIdleListener onDidBecomeIdleListener;
@Mock
private MapView.OnDidFinishLoadingStyleListener onDidFinishLoadingStyleListener;
@@ -495,29 +495,29 @@ public class MapChangeReceiverTest {
}
@Test
public void testOnDidEnterIdleListener() {
mapChangeEventManager.addOnDidEnterIdleListener(onDidEnterIdleListener);
mapChangeEventManager.onDidEnterIdle();
verify(onDidEnterIdleListener).onDidEnterIdle();
mapChangeEventManager.removeOnDidEnterIdleListener(onDidEnterIdleListener);
mapChangeEventManager.onDidEnterIdle();
verify(onDidEnterIdleListener).onDidEnterIdle();
public void testOnDidBecomeIdleListener() {
mapChangeEventManager.addOnDidBecomeIdleListener(onDidBecomeIdleListener);
mapChangeEventManager.onDidBecomeIdle();
verify(onDidBecomeIdleListener).onDidBecomeIdle();
mapChangeEventManager.removeOnDidBecomeIdleListener(onDidBecomeIdleListener);
mapChangeEventManager.onDidBecomeIdle();
verify(onDidBecomeIdleListener).onDidBecomeIdle();
mapChangeEventManager.addOnDidEnterIdleListener(onDidEnterIdleListener);
mapChangeEventManager.addOnDidBecomeIdleListener(onDidBecomeIdleListener);
Logger.setLoggerDefinition(loggerDefinition);
Exception exc = new RuntimeException();
doThrow(exc).when(onDidEnterIdleListener).onDidEnterIdle();
doThrow(exc).when(onDidBecomeIdleListener).onDidBecomeIdle();
try {
mapChangeEventManager.onDidEnterIdle();
mapChangeEventManager.onDidBecomeIdle();
Assert.fail("The exception should've been re-thrown.");
} catch (RuntimeException throwable) {
verify(loggerDefinition).e(anyString(), anyString(), eq(exc));
}
Error err = new ExecutionError("", new Error());
doThrow(err).when(onDidEnterIdleListener).onDidEnterIdle();
doThrow(err).when(onDidBecomeIdleListener).onDidBecomeIdle();
try {
mapChangeEventManager.onDidEnterIdle();
mapChangeEventManager.onDidBecomeIdle();
Assert.fail("The exception should've been re-thrown.");
} catch (ExecutionError throwable) {
verify(loggerDefinition).e(anyString(), anyString(), eq(err));

View File

@@ -32,7 +32,7 @@ public class MapChangeActivity extends AppCompatActivity {
mapView.addOnDidFinishLoadingStyleListener(() -> Timber.v("OnDidFinishLoadingStyle"));
mapView.addOnDidFinishRenderingFrameListener(fully -> Timber.v("OnDidFinishRenderingFrame: fully: %s", fully));
mapView.addOnDidFinishRenderingMapListener(fully -> Timber.v("OnDidFinishRenderingMap: fully: %s", fully));
mapView.addOnDidEnterIdleListener(() -> Timber.v("OnDidEnterIdle"));
mapView.addOnDidBecomeIdleListener(() -> Timber.v("OnDidBecomeIdle"));
mapView.addOnSourceChangedListener(sourceId -> Timber.v("OnSourceChangedListener: source with id: %s", sourceId));
mapView.addOnWillStartLoadingMapListener(() -> Timber.v("OnWillStartLoadingMap"));
mapView.addOnWillStartRenderingFrameListener(() -> Timber.v("OnWillStartRenderingFrame"));

View File

@@ -186,13 +186,13 @@ void NativeMapView::onDidFinishRenderingMap(MapObserver::RenderMode mode) {
javaPeer.get(*_env).Call(*_env, onDidFinishRenderingMap, (jboolean) (mode != MapObserver::RenderMode::Partial));
}
void NativeMapView::onDidEnterIdle() {
void NativeMapView::onDidBecomeIdle() {
assert(vm != nullptr);
android::UniqueEnv _env = android::AttachEnv();
static auto& javaClass = jni::Class<NativeMapView>::Singleton(*_env);
static auto onDidEnterIdle = javaClass.GetMethod<void ()>(*_env, "onDidEnterIdle");
javaPeer.get(*_env).Call(*_env, onDidEnterIdle);
static auto onDidBecomeIdle = javaClass.GetMethod<void ()>(*_env, "onDidBecomeIdle");
javaPeer.get(*_env).Call(*_env, onDidBecomeIdle);
}
void NativeMapView::onDidFinishLoadingStyle() {

View File

@@ -67,7 +67,7 @@ public:
void onDidFinishRenderingFrame(MapObserver::RenderMode) override;
void onWillStartRenderingMap() override;
void onDidFinishRenderingMap(MapObserver::RenderMode) override;
void onDidEnterIdle() override;
void onDidBecomeIdle() override;
void onDidFinishLoadingStyle() override;
void onSourceChanged(mbgl::style::Source&) override;

View File

@@ -250,7 +250,7 @@ NS_ASSUME_NONNULL_BEGIN
@param mapView The map view that has just entered the idle state.
*/
- (void)mapViewDidEnterIdle:(MGLMapView *)mapView;
- (void)mapViewDidBecomeIdle:(MGLMapView *)mapView;
/**
Tells the delegate that the map has just finished loading a style.

View File

@@ -52,6 +52,8 @@ extension MGLMapViewDelegateIntegrationTests: MGLMapViewDelegate {
func mapView(_ mapView: MGLMapView, didUpdate userLocation: MGLUserLocation?) {}
func mapViewDidFinishRenderingMap(_ mapView: MGLMapView, fullyRendered: Bool) {}
func mapViewDidBecomeIdle(_ mapView: MGLMapView) {}
func mapView(_ mapView: MGLMapView, didFailToLocateUserWithError error: Error) {}

View File

@@ -934,13 +934,13 @@ public:
}
}
- (void)mapViewDidEnterIdle {
- (void)mapViewDidBecomeIdle {
if (!_mbglMap) {
return;
}
if ([self.delegate respondsToSelector:@selector(mapViewDidEnterIdle)]) {
[self.delegate mapViewDidEnterIdle:self];
if ([self.delegate respondsToSelector:@selector(mapViewDidBecomeIdle)]) {
[self.delegate mapViewDidBecomeIdle:self];
}
}
@@ -3061,8 +3061,8 @@ public:
[nativeView mapViewDidFinishRenderingMapFullyRendered:fullyRendered];
}
void onDidEnterIdle() override {
[nativeView mapViewDidEnterIdle];
void onDidBecomeIdle() override {
[nativeView mapViewDidBecomeIdle];
}
void onDidFinishLoadingStyle() override {

View File

@@ -162,7 +162,7 @@ NS_ASSUME_NONNULL_BEGIN
@param mapView The map view that has just entered the idle state.
*/
- (void)mapViewDidEnterIdle:(MGLMapView *)mapView;
- (void)mapViewDidBecomeIdle:(MGLMapView *)mapView;
/**
Tells the delegate that the map has just finished loading a style.

View File

@@ -25,7 +25,7 @@ extension MGLMapViewDelegateIntegrationTests: MGLMapViewDelegate {
func mapViewDidFinishRenderingMap(_ mapView: MGLMapView, fullyRendered: Bool) {}
func mapViewDidEnterIdle(_ mapView: MGLMapView) {}
func mapViewDidBecomeIdle(_ mapView: MGLMapView) {}
func mapViewDidFailLoadingMap(_ mapView: MGLMapView, withError error: Error) {}

View File

@@ -210,7 +210,7 @@ void Map::Impl::onDidFinishRenderingFrame(RenderMode renderMode, bool needsRepai
if (needsRepaint || transform.inTransition()) {
onUpdate();
} else if (rendererFullyLoaded) {
observer.onDidEnterIdle();
observer.onDidBecomeIdle();
}
} else if (stillImageRequest && rendererFullyLoaded) {
auto request = std::move(stillImageRequest);