Skip to content

Latest commit

 

History

History
101 lines (65 loc) · 3.25 KB

README.md

File metadata and controls

101 lines (65 loc) · 3.25 KB
Raw

Bit-lib4j Bit-lib4j CI Coverage Status Maven Central

Bit-Lib4j is an useful library to handle bytes or bits in Java.
With this library you can read/write data in a byte array with a custom size for Java primitive types.

Simple API

It is very easy to get started with bit-lib4j:

  • Read data from byte array
	byte[] array = new byte[]{0x12,0x25}
	BitUtils bit = new BitUtils(array);
	int res = bit.getNextInteger(4);        // read the first 4 bits to an integer
  • Create byte array with bit
	BitUtils bit = new BitUtils(8);
	bit.setNextInteger(3,3);        // set an integer on 3 bits
	bit.setNextInteger(1,5);        // set one value on 5 bits

	// Result
	bit.getData();                  // return Ox61  (0110 0001b)
  • Read/write signed values
	BitUtils bit = new BitUtils(4);
	bit.setNextInteger(-2 , 4);	    // set an integer (-2) on 4 bits

	// Result
	bit.getNextIntegerSigned(4);    // return -2

You can also use getNextSignedLong() to handle long signed values.

Handle bytes more easily

The class ByteUtils provided static methods to convert byte array to String, String to byte array, int to byte array, byte array to binary representation.

More documentation into the wiki

Download

Maven

<dependency>
  <groupId>com.github.devnied</groupId>
  <artifactId>bit-lib4j</artifactId>
  <version>1.5.2</version>
</dependency>

JAR

You can download this library on Maven central or in Github release tab

Dependencies

If you are not using Maven or some other dependency management tool that can understand Maven repositories, the list below is what you need to run bit-lib4j.

Runtime Dependencies

  • slf4j-api 1.7.30

Bugs

Please report bugs and feature requests to the GitHub issue tracker.
Forks and Pull Requests are also welcome.

Author

Millau Julien

Copyright and license

Copyright 2020 Millau Julien.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or 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.

Analytics