summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEmmanuel Bourg <ebourg@apache.org>2016-08-03 10:17:09 +0200
committerEmmanuel Bourg <ebourg@apache.org>2016-08-03 10:17:09 +0200
commit3d9b009255ffd897a9bd84ca3977cd3f553da8ef (patch)
tree13a8296e2989ff8da3fc50d335fd48b2dd0c6064 /README.md
parentb2ec1a2d459cfef3ff13133c1f7f5972e3740258 (diff)
Imported Upstream version 6.7.6
Diffstat (limited to 'README.md')
-rwxr-xr-x[-rw-r--r--]README.md14
1 files changed, 9 insertions, 5 deletions
diff --git a/README.md b/README.md
index 3aa5918..2e77718 100644..100755
--- a/README.md
+++ b/README.md
@@ -6,11 +6,14 @@ This module is available on maven central as
<dependency>
<groupId>net.openhft</groupId>
<artifactId>lang</artifactId>
- <version>6.1.1</version>
+ <version><!--replace with the latest version--></version>
</dependency>
The version 6.x signifies that it is build for Java 6+. (It requires Java 6 update 18 or later to build)
+## JavaDoc
+Check out our documentation at [JavaDoc] (http://openhft.github.io/Java-Lang/apidocs/)
+
## Working with off heap objects.
Java-Lang 6.1 adds support for basic off heap data structures. More collections types and more complex data types will be added in future versions.
@@ -26,7 +29,7 @@ Java-Lang 6.1 adds support for basic off heap data structures. More collections
// set data on dt
array.recycle(dt); // recycle the reference (or discard it)
- // create a ring buffer
+ // create a ring writeBuffer
HugeQueue<DataType> queue = HugeCollections.newQueue(DataType.class, 10*1000*1000L);
// give me a reference to an object to populate
DataType dt2 = queue.offer();
@@ -51,11 +54,11 @@ Both classes provide functionality:
* addAndGetInt and getAndAddInt operations
####Example
- ByteBuffer byteBuffer = ByteBuffer.allocate(SIZE).order(ByteOrder.nativeOrder());
+ ByteBuffer byteBuffer = ByteBuffer.allocate(SIZE);
ByteBufferBytes bytes = new ByteBufferBytes(byteBuffer);
- for (long i = 0; i < bytes.capacity(); i++)
+ for (long i = 0; i < bytes.maximumLimit(); i++)
bytes.writeLong(i);
- for (long i = bytes.capacity()-8; i >= 0; i -= 8) {
+ for (long i = bytes.maximumLimit()-8; i >= 0; i -= 8) {
int j = bytes.readLong(i);
assert i == j;
}
@@ -72,3 +75,4 @@ Unzip master.zip, Java-Lang-master folder will be extracted from zip.
Now you have an eclipse project, import project into Eclipse
If your Eclipse configuration is not UTF-8, after importing the project you may see some errors and strange characters in some .java files. To get rid of this problem change character enconding to UTF-8: project->properties->resource->text file encoding->utf8
+