File tree Expand file tree Collapse file tree 2 files changed +11
-4
lines changed
src/main/java/io/kaitai/struct Expand file tree Collapse file tree 2 files changed +11
-4
lines changed Original file line number Diff line number Diff line change 34
34
35
35
/**
36
36
* An implementation of {@link KaitaiStream} backed by a {@link ByteBuffer}.
37
- * It can be either a {@link MappedByteBuffer} backed by {@link FileChannel},
38
- * or a regular wrapper over a given byte array).
37
+ * Any underlying implementation of ByteBuffer can be used, for example:
38
+ * <ul>
39
+ * <li>ByteBuffer returned as result of {@link ByteBuffer#wrap}, wrapping
40
+ * a byte array into a buffer.</li>
41
+ * <li>{@link MappedByteBuffer} backed by {@link FileChannel}</li>
42
+ * </ul>
39
43
*/
40
44
public class ByteBufferKaitaiStream extends KaitaiStream {
41
45
private FileChannel fc ;
Original file line number Diff line number Diff line change 24
24
package io .kaitai .struct ;
25
25
26
26
/**
27
- * A custom decoder interface. Implementing classes can be called
28
- * from inside a .ksy file using `process: XXX` syntax.
27
+ * Custom decoder interface allows implementation of "byte array in - byte array
28
+ * out" decoders, compatible with Kaitai Struct. Classes implementing this
29
+ * interface can be called rom inside a .ksy file using `process: XXX` syntax.
30
+ * @see <a href="https://doc.kaitai.io/user_guide.html#custom-process">Kaitai
31
+ * Struct documentation on custom processing routines</a>
29
32
*/
30
33
public interface CustomDecoder {
31
34
/**
You can’t perform that action at this time.
0 commit comments