io.flutter.embedding.engine.FlutterEngineGroupCache Class Reference

Public Member Functions
boolean	contains (@NonNull String engineGroupId)
FlutterEngineGroup	get (@NonNull String engineGroupId)
void	put (@NonNull String engineGroupId, @Nullable FlutterEngineGroup engineGroup)
void	remove (@NonNull String engineGroupId)
void	clear ()

Static Public Member Functions
static FlutterEngineGroupCache	getInstance ()

Package Functions
	FlutterEngineGroupCache ()

Detailed Description

Static singleton cache that holds io.flutter.embedding.engine.FlutterEngineGroup instances identified by Strings.

The ID of a given io.flutter.embedding.engine.FlutterEngineGroup can be whatever String is desired.

io.flutter.embedding.android.FlutterActivity and io.flutter.embedding.android.FlutterFragment use the FlutterEngineGroupCache singleton internally when instructed to use a cached io.flutter.embedding.engine.FlutterEngineGroup based on a given ID. See io.flutter.embedding.android.FlutterActivity.NewEngineInGroupIntentBuilder and io.flutter.embedding.android.FlutterFragment#withNewEngineInGroup(String) for related APIs.

Definition at line 27 of file FlutterEngineGroupCache.java.

Constructor & Destructor Documentation

FlutterEngineGroupCache()

io.flutter.embedding.engine.FlutterEngineGroupCache.FlutterEngineGroupCache ( )

inlinepackage

Definition at line 50 of file FlutterEngineGroupCache.java.

{}

Member Function Documentation

clear()

void io.flutter.embedding.engine.FlutterEngineGroupCache.clear ( )

inline

Removes all io.flutter.embedding.engine.FlutterEngineGroup's that are currently in the cache.

Definition at line 97 of file FlutterEngineGroupCache.java.

                      {
    cachedEngineGroups.clear();
  }

contains()

boolean io.flutter.embedding.engine.FlutterEngineGroupCache.contains ( @NonNull String  engineGroupId )

inline

Returns true if a io.flutter.embedding.engine.FlutterEngineGroup in this cache is associated with the given engineGroupId.

Definition at line 56 of file FlutterEngineGroupCache.java.

                                                         {
    return cachedEngineGroups.containsKey(engineGroupId);
  }

get()

FlutterEngineGroup io.flutter.embedding.engine.FlutterEngineGroupCache.get ( @NonNull String  engineGroupId )

inline

Returns the io.flutter.embedding.engine.FlutterEngineGroup in this cache that is associated with the given engineGroupId, or null is no such io.flutter.embedding.engine.FlutterEngineGroup exists.

Definition at line 66 of file FlutterEngineGroupCache.java.

                                                               {
    return cachedEngineGroups.get(engineGroupId);
  }

getInstance()

static FlutterEngineGroupCache io.flutter.embedding.engine.FlutterEngineGroupCache.getInstance ( )

inlinestatic

Returns the static singleton instance of FlutterEngineGroupCache.

Creates a new instance if one does not yet exist.

Definition at line 36 of file FlutterEngineGroupCache.java.

                                                      {
    if (instance == null) {
      synchronized (FlutterEngineGroupCache.class) {
        if (instance == null) {
          instance = new FlutterEngineGroupCache();
        }
      }
    }
    return instance;
  }

put()

void io.flutter.embedding.engine.FlutterEngineGroupCache.put ( @NonNull String  engineGroupId, @Nullable FlutterEngineGroup  engineGroup  )

inline

Places the given io.flutter.embedding.engine.FlutterEngineGroup in this cache and associates it with the given engineGroupId.

If a io.flutter.embedding.engine.FlutterEngineGroup is null, that io.flutter.embedding.engine.FlutterEngineGroup is removed from this cache.

Definition at line 77 of file FlutterEngineGroupCache.java.

                                                                                           {
    if (engineGroup != null) {
      cachedEngineGroups.put(engineGroupId, engineGroup);
    } else {
      cachedEngineGroups.remove(engineGroupId);
    }
  }

remove()

void io.flutter.embedding.engine.FlutterEngineGroupCache.remove ( @NonNull String  engineGroupId )

inline

Removes any io.flutter.embedding.engine.FlutterEngineGroup that is currently in the cache that is identified by the given engineGroupId.

Definition at line 89 of file FlutterEngineGroupCache.java.

                                                    {
    put(engineGroupId, null);
  }

---

The documentation for this class was generated from the following file:

• shell/platform/android/io/flutter/embedding/engine/FlutterEngineGroupCache.java