• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (C) 2024 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17/**
18 * A simple key-value store interface.
19 */
20export interface Store {
21  /**
22   * Adds a key-value pair to the store.
23   * @param key The key of the key-value pair.
24   * @param value The value of the key-value pair.
25   */
26  add(key: string, value: string): void;
27
28  /**
29   * Retrieves the value associated with a key.
30   * @param key The key to retrieve the value for.
31   * @return The value associated with the key, or undefined if the key is not found.
32   */
33  get(key: string): string | undefined;
34
35  /**
36   * Clears all key-value pairs from the store that match a given substring.
37   * @param keySubstring The substring to match keys against. Only keys that contain this substring will be cleared.
38   */
39  clear(keySubstring: string): void;
40}
41