| 1 |
// Copyright 2011 The Closure Library Authors. All Rights Reserved. |
| 2 |
// |
| 3 |
// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 |
// you may not use this file except in compliance with the License. |
| 5 |
// You may obtain a copy of the License at |
| 6 |
// |
| 7 |
// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 |
// |
| 9 |
// Unless required by applicable law or agreed to in writing, software |
| 10 |
// distributed under the License is distributed on an "AS-IS" BASIS, |
| 11 |
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 |
// See the License for the specific language governing permissions and |
| 13 |
// limitations under the License. |
| 14 |
|
| 15 |
/** |
| 16 |
* @fileoverview Abstract interface for storing and retrieving data using |
| 17 |
* some persistence mechanism. |
| 18 |
* |
| 19 |
*/ |
| 20 |
|
| 21 |
goog.provide('goog.storage.mechanism.Mechanism'); |
| 22 |
|
| 23 |
|
| 24 |
|
| 25 |
/** |
| 26 |
* Basic interface for all storage mechanisms. |
| 27 |
* |
| 28 |
* @constructor |
| 29 |
* @struct |
| 30 |
*/ |
| 31 |
goog.storage.mechanism.Mechanism = function() {}; |
| 32 |
|
| 33 |
|
| 34 |
/** |
| 35 |
* Set a value for a key. |
| 36 |
* |
| 37 |
* @param {string} key The key to set. |
| 38 |
* @param {string} value The string to save. |
| 39 |
*/ |
| 40 |
goog.storage.mechanism.Mechanism.prototype.set = goog.abstractMethod; |
| 41 |
|
| 42 |
|
| 43 |
/** |
| 44 |
* Get the value stored under a key. |
| 45 |
* |
| 46 |
* @param {string} key The key to get. |
| 47 |
* @return {?string} The corresponding value, null if not found. |
| 48 |
*/ |
| 49 |
goog.storage.mechanism.Mechanism.prototype.get = goog.abstractMethod; |
| 50 |
|
| 51 |
|
| 52 |
/** |
| 53 |
* Remove a key and its value. |
| 54 |
* |
| 55 |
* @param {string} key The key to remove. |
| 56 |
*/ |
| 57 |
goog.storage.mechanism.Mechanism.prototype.remove = goog.abstractMethod; |