Plexus-Mirror/toml4j
1
0
Fork 0
mirror of https://github.com/plexusorg/toml4j.git synced 2024-12-29 11:42:15 +00:00
Code Issues Projects Releases Wiki Activity

Improved display of TOML -> Java mappings

Browse source 
[ci skip]
This commit is contained in:
moandji.ezana 2015-01-15 01:48:51 +02:00
parent 6906dea7d0
commit 0026bb3467
1 changed files with 10 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -74,14 +74,17 @@ assert user.address.street.equals("123 A Street");
Any keys not found in both the TOML and the class are ignored. Fields may be private. Any keys not found in both the TOML and the class are ignored. Fields may be private.
All TOML primitives can be mapped, as well as a number of Java-specific types: TOML primitives can be mapped to a number of Java types:
* A TOML Number can be converted to any primitive type (or the wrapper equivalent), `BigInteger` or `BigDecimal` TOML | Java
* A TOML string can be converted to a `String`, enum, `java.net.URI` or `java.net.URL` ---- | ----
* A single-letter TOML string can be converted to a `char` or `Character` Integer | `int`, `long` (or wrapper), `java.math.BigInteger`
* Multiline and literal TOML strings can be converted to `String` Float | float`, `double` (or wrapper), `java.math.BigDecimal`
* A TOML array can be converted to a `List`, `Set` or array. The generic type can be anything that can be converted. String | `String`, enum, `java.net.URI`, `java.net.URL`
* A TOML table can be converted to a custom class or to a `Map<String, Object>`. The generic type of the value can be anything that can be converted. One-letter String | `char`, `Character`
Multiline and Literal Strings | `String`
Array | `List`, `Set`, array. The generic type can be anything that can be converted.
Table | Custom class, `Map<String, Object>`
Custom classes, Maps and collections thereof can be nested to any level. See [TomlToClassTest#should_convert_fruit_table_array()](src/test/java/com/moandjiezana/toml/TomlToClassTest.java) for an example. Custom classes, Maps and collections thereof can be nested to any level. See [TomlToClassTest#should_convert_fruit_table_array()](src/test/java/com/moandjiezana/toml/TomlToClassTest.java) for an example.