-
Notifications
You must be signed in to change notification settings - Fork 0
/
StoreWriter.java
59 lines (53 loc) · 2.2 KB
/
StoreWriter.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/**
* Copyright 2018 The Jarasandha.io project authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http:https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.jarasandha.store.api;
import io.jarasandha.store.api.StoreException.RecordTooBigException;
import io.jarasandha.store.api.StoreException.StoreFullException;
import io.jarasandha.util.io.Persistable;
import io.jarasandha.util.misc.CallerMustRelease;
import io.netty.buffer.ByteBuf;
/**
* Created by ashwin.jayaprakash.
*/
public interface StoreWriter<STORE_ID extends Persistable> extends AutoCloseable {
STORE_ID getStoreId();
boolean isBlocksCompressed();
boolean isIndexCompressed();
/**
* Writes the given record if there is room.
* <p>
* Records are written in blocks.
* <p>
* Records may not be immediately flushed. It could be done:
* <p>
* - On {@link #close()} (if required)
* <p>
* - Or if the current block does not have sufficient room to accommodate the current record.
* <p>
* If block compression is enabled ({@link #isBlocksCompressed()}), then the block is first compressed and then the
* compressed block is written.
*
* @param value The {@link ByteBuf#readerIndex()} will get modified after this call returns!
* @return
* @throws StoreFullException When the store cannot accommodate any further writes. This means, the next step is
* to call {@link #close()}.
* @throws RecordTooBigException When the record does not fit within the limits specified.
* @throws StoreException All other cases and an indication that something went wrong.
*/
LogicalRecordLocation write(@CallerMustRelease ByteBuf value);
@Override
void close();
}