Skip to content

Commit 2162c2b

Browse files
authored
Update README.md
1 parent 3df7164 commit 2162c2b

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
11
# JavaBeans
22

33
Library providing java beans utilities and observables.
4+
Provides interfaces and several implementations for properties, observable data and such.
5+
6+
## Building
7+
8+
Simply run `./gradlew build` from the main directory.
9+
This will build the library and export it along with a sources jar and javadoc archive into `build/libs`.
10+
11+
## Properties
12+
13+
JavaBeans introduces the `Property` interface, which is a mutable value.
14+
There are also specializations for the interface for primitive types: `long`, `int`, `boolean`, `double`.
15+
16+
### Implementations
17+
18+
JavaBeans provides the following implementations for `Property`, each implementation exists for the specializations as well:
19+
- Simple: a basic variable value which can be read from and written to.
20+
- Atomic: a thread-safe implementation.
21+
22+
### Observables
23+
24+
An `ObservableValue` is a value which can be observed for changes using listeners.
25+
An `ObservableProperty` is a property which can be observed for changed using listeners.
26+
27+
Both `ObservableValue` and `ObservableProperty` have primitive specializations.
28+
29+
There are several implementations provided:
30+
- Simple: a basic variable value which can be read from and written to.
31+
- Atomic: a thread-safe implementation.

0 commit comments

Comments
 (0)