Skip to content

Commit c9174b7

Browse files
committed
Update README
1 parent d17e915 commit c9174b7

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,20 @@ A BigArrayList is basically an ArrayList that can handle a much larger amount of
77
3. Removing elements from the list
88
4. Sorting the list
99

10+
## Installation
11+
BigArrayList is available under [maven.minecrafttas.com](https://maven.minecrafttas.com/#/main/com/dselent/bigarraylist).
12+
13+
The basic build.gradle configuration should look like this:
14+
```groovy
15+
repositories {
16+
maven { url = "https://maven.minecrafttas.com/main" }
17+
}
18+
19+
dependencies {
20+
implementation "com.dselent:bigarraylist:1.4"
21+
}
22+
```
23+
1024
## BigArrayList Size
1125

1226
The number of elements a BigArrayList can hold is 2^63-1 elements. This number is currently considered a theoretical limit, since it would take too much time and space to store that many elements. A more practical limit would be based on the combination of available RAM and disk space because the amount of space will likely be the limiting factor.
@@ -69,4 +83,4 @@ Some types of serialization will clear the contents on disk automatically when y
6983
You should treat storing any element retrieved from a BigArrayList as if it were a copy-by-value. The reason for this is because the content in a BigArrayList can be serialized and deserialized during any operation. Therefore, upon deserialization, a new object is created. Any old references in the program are now referencing a different object than what is being stored in the BigArrayList. If you retrieve an element from a BigArrayList and change it, make sure to save it back to the list.
7084

7185
## How to Build
72-
Import normally as a Gradle project. The SimpleTest.java file can be run as a standard Java application to test the build.
86+
Import normally as a Gradle project. The SimpleTest.java file can be run as a standard Java application to test the build.

src/main/java/examples/SimpleExample.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public static void main(String[] args) throws IOException
2929
System.out.println(bal.get(5));
3030

3131
//clear contents on disk
32-
bal.clearMemory();
32+
// bal.clearMemory();
3333
}
3434
}
3535

0 commit comments

Comments
 (0)