-
Notifications
You must be signed in to change notification settings - Fork 507
Expand file tree
/
Copy pathCompressionCodec.java
More file actions
141 lines (120 loc) · 3.44 KB
/
CompressionCodec.java
File metadata and controls
141 lines (120 loc) · 3.44 KB
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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://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 org.apache.orc;
import java.io.Closeable;
import java.io.IOException;
import java.nio.ByteBuffer;
/**
* The API for compression codecs for ORC.
* Closeable.close() returns this codec to the OrcCodecPool.
* @since 1.1.0
*/
public interface CompressionCodec extends Closeable {
enum SpeedModifier {
/* speed/compression tradeoffs */
FASTEST,
FAST,
DEFAULT
}
enum DataKind {
TEXT,
BINARY
}
interface Options {
/**
* Make a copy before making changes.
* @return a new copy
*/
Options copy();
/**
* Set the speed for the compression.
* @param newValue how aggressively to compress
* @return this
*/
Options setSpeed(SpeedModifier newValue);
/**
* Set the kind of data for the compression.
* @param newValue what kind of data this is
* @return this
*/
Options setData(DataKind newValue);
}
/**
* A null implementation of Options that ignores all settings.
* Useful for codecs that don't support any configuration options.
*/
class NullOptions implements Options {
public static final NullOptions INSTANCE = new NullOptions();
@Override
public Options copy() {
return this;
}
@Override
public Options setSpeed(SpeedModifier newValue) {
return this;
}
@Override
public Options setData(DataKind newValue) {
return this;
}
@Override
public boolean equals(Object other) {
return other != null && getClass() == other.getClass();
}
@Override
public int hashCode() {
return 0;
}
}
/**
* Get the default options for this codec.
* @return the default options object
*/
Options getDefaultOptions();
/**
* Compress the in buffer to the out buffer.
* @param in the bytes to compress
* @param out the compressed bytes
* @param overflow put any additional bytes here
* @param options the options to control compression
* @return true if the output is smaller than input
* @throws IOException
*/
boolean compress(ByteBuffer in, ByteBuffer out, ByteBuffer overflow,
Options options) throws IOException;
/**
* Decompress the in buffer to the out buffer.
* @param in the bytes to decompress
* @param out the decompressed bytes
* @throws IOException
*/
void decompress(ByteBuffer in, ByteBuffer out) throws IOException;
/** Resets the codec, preparing it for reuse. */
void reset();
/** Closes the codec, releasing the resources. */
void destroy();
/**
* Get the compression kind.
*/
CompressionKind getKind();
/**
* Return the codec to the pool.
*/
@Override
void close();
}