Skip to content

Commit 49d3ae8

Browse files
committed
small correction of reference
1 parent 39a1cbd commit 49d3ae8

File tree

3 files changed

+12
-6
lines changed

3 files changed

+12
-6
lines changed

.projectKnowledge/JBBP.mmd

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Mind Map generated by NB MindMap plugin
3131

3232

3333
### have strong <br/>embedded DSL with\.\.\.
34-
> fillColor=`#CCCCFF`
34+
> fillColor=`#CCCCFF`,topicLinkUID=`15292664291A`
3535

3636
- TOPIC
3737
<pre>1528DC7A000A</pre>
@@ -89,6 +89,8 @@ Mind Map generated by NB MindMap plugin
8989
### can make text representation<br/>of parsed data
9090
> fillColor=`#FFFFCC`
9191

92+
- TOPIC
93+
<pre>152926734C4A</pre>
9294

9395
## Main parts
9496
> fillColor=`#00FFFF`,leftSide=`true`
@@ -101,6 +103,8 @@ Mind Map generated by NB MindMap plugin
101103
#### JBBPBitInputStream
102104
> fillColor=`#FF99FF`
103105

106+
- FILE
107+
<pre>src/main/java/com/igormaznitsa/jbbp/io/JBBPBitInputStream.java</pre>
104108

105109
#### JBBPBitOutputStream
106110
> fillColor=`#FF99FF`,leftSide=`true`
@@ -125,9 +129,11 @@ Mind Map generated by NB MindMap plugin
125129
#### JBBPOut
126130
> fillColor=`#00CCCC`
127131

132+
- FILE
133+
<pre>src/main/java/com/igormaznitsa/jbbp/io/JBBPOut.java</pre>
128134

129135
### Convert To Text
130-
> fillColor=`#FFFFCC`,leftSide=`true`
136+
> fillColor=`#FFFFCC`,topicLinkUID=`152926734C4A`,leftSide=`true`
131137

132138

133139
#### JBBPTextWriter

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33

44
Introduction
55
=============
6-
Sometime it is very important to parse in Java some binary block data, may be not in very fast way but structures can have complex format and byte and bit orders can be very different. In Python we have [the Struct package](https://docs.python.org/2/library/struct.html) for operations to parse binary blocks but in Java such operations look a bit verbose and take some time to be programmed, so that I decided during my vacation to develop a framework which would decrease verbosity for such operations in Java and will decrease my work in future because I am too lazy to write a lot of code.<br>
6+
It is very often in my projects when I needs to parse some binary data in Java. Java has some embedded features for that (for instance ByteBuffer), but I wanted to work with bits and describe binary structure in some domain specific language. I was very impressed by the [the Python Struct package](https://docs.python.org/2/library/struct.html) package so that I decided to make something like that. So JBBP was born.<br>
77
p.s.<br>
88
For instance I have been very actively using the framework in [the ZX-Poly emulator](https://github.com/raydac/zxpoly) to parse snapshot files and save results.
99
![Use cases](https://github.com/raydac/java-binary-block-parser/blob/master/docs/jbbp_mm.png)
10+
1011
License
1112
========
1213
The Framework is under [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).
1314

14-
1515
Change log
1616
===========
1717
- **1.2.0**
@@ -36,9 +36,9 @@ Change log
3636
- **1.0**
3737
- The Initial version
3838

39-
Java support
39+
Compatibility
4040
=============
41-
The Framework developed to support Java platform since Java SE 1.5+, its inside mapping has been developed in such manner to support work under the Android platform (as of Android 2.0) so that the framework is an Android compatible one. It doesn't use any NIO and usage of the non-standard sun.misc.unsafe class is isolated with reflection.
41+
The Framework supports Java platform since Java SE 1.5+, its inside mapping mechanism developed in such manner to be compatible and with Android platform (as of Android 2.0) so that the framework is also Android compatible one (2.0+). It doesn't use any NIO and usage of the non-standard sun.misc.unsafe class is isolated through reflection mechanism. The Library doesn't have any external dependencies.
4242

4343
How to use with Maven
4444
======================

docs/jbbp_mm.png

1.3 KB
Loading

0 commit comments

Comments
 (0)