mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Andres Suarez
8bd3edec88
Reviewed By: aaronabramov Differential Revision: D33367752 fbshipit-source-id: 4ce94d184485e5ee0a62cf67ad2d3ba16e285c8f
50 lines
1.6 KiB
Java
50 lines
1.6 KiB
Java
/*
|
|
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
package com.facebook.react.uimanager;
|
|
|
|
import com.facebook.react.bridge.ReadableNativeMap;
|
|
import com.facebook.react.bridge.WritableMap;
|
|
import com.facebook.react.common.mapbuffer.ReadableMapBuffer;
|
|
import javax.annotation.Nullable;
|
|
|
|
/**
|
|
* This is a wrapper that can be used for passing State objects from Fabric C++ core to
|
|
* platform-specific components in Java. State allows you to break out of uni-directional dataflow
|
|
* by calling updateState, which communicates state back to the C++ layer.
|
|
*/
|
|
public interface StateWrapper {
|
|
|
|
/**
|
|
* Get a ReadableMapBuffer object from the C++ layer, which is a K/V map of short keys to values.
|
|
*
|
|
* <p>Unstable API - DO NOT USE.
|
|
*/
|
|
@Nullable
|
|
ReadableMapBuffer getStatDataMapBuffer();
|
|
|
|
/**
|
|
* Get a ReadableNativeMap object from the C++ layer, which is a K/V map of string keys to values.
|
|
*/
|
|
@Nullable
|
|
ReadableNativeMap getStateData();
|
|
|
|
/**
|
|
* Pass a map of values back to the C++ layer. The operation is performed synchronously and cannot
|
|
* fail.
|
|
*/
|
|
void updateState(WritableMap map);
|
|
|
|
/**
|
|
* Mark state as unused and clean up in Java and in native. This should be called as early as
|
|
* possible when you know a StateWrapper will no longer be used. If there's ANY chance of it being
|
|
* used legitimately, don't destroy it! It is expected that all StateWrappers are destroyed
|
|
* immediately upon stopSurface.
|
|
*/
|
|
void destroyState();
|
|
}
|