Coverage Summary for Class: KeyValueDataSource (org.ethereum.datasource)
1 /*
2 * This file is part of RskJ
3 * Copyright (C) 2017 RSK Labs Ltd.
4 * (derived from ethereumJ library, Copyright (c) 2016 <ether.camp>)
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Lesser General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 package org.ethereum.datasource;
21
22 import org.ethereum.db.ByteArrayWrapper;
23
24 import javax.annotation.Nullable;
25 import java.util.Map;
26 import java.util.Set;
27
28 public interface KeyValueDataSource extends DataSource {
29 @Nullable
30 byte[] get(byte[] key);
31
32 /**
33 * null puts() are NOT allowed.
34 * @return the same value it received
35 */
36 byte[] put(byte[] key, byte[] value);
37
38 void delete(byte[] key);
39
40 Set<byte[]> keys();
41
42 /**
43 * Note that updateBatch() does not imply the operation is atomic:
44 * if somethings breaks, it's possible that some keys get written and some
45 * others don't.
46 * IMPORTANT: keysToRemove override entriesToUpdate
47 * @param entriesToUpdate
48 * @param keysToRemove
49 */
50 void updateBatch(Map<ByteArrayWrapper, byte[]> entriesToUpdate, Set<ByteArrayWrapper> keysToRemove);
51
52 /**
53 * This makes things go to disk. To enable caching.
54 */
55 void flush();
56 }