| Matthias Andreas Benkard | 31c61e7 | 2021-12-16 20:06:39 +0100 | [diff] [blame] | 1 | package eu.mulk.jgvariant.core; |
| 2 | |
| 3 | /** |
| 4 | * A dynamically typed GVariant value carrying a {@link Signature} describing its type. |
| 5 | * |
| 6 | * <p>{@link #value()} can be of one of the following types: |
| 7 | * |
| 8 | * <ul> |
| 9 | * <li>{@link Boolean} |
| 10 | * <li>{@link Byte} |
| 11 | * <li>{@link Short} |
| 12 | * <li>{@link Integer} |
| 13 | * <li>{@link Long} |
| 14 | * <li>{@link String} |
| 15 | * <li>{@link java.util.Optional} (a GVariant {@code Maybe} type) |
| 16 | * <li>{@link java.util.List} (a GVariant array) |
| 17 | * <li>{@link Object[]} (a GVariant structure) |
| Matthias Andreas Benkard | b50fcd0 | 2021-12-16 20:17:20 +0100 | [diff] [blame^] | 18 | * <li>{@link Variant} (a nested variant) |
| Matthias Andreas Benkard | 31c61e7 | 2021-12-16 20:06:39 +0100 | [diff] [blame] | 19 | * </ul> |
| 20 | * |
| 21 | * @param signature the signature describing the type of the value. |
| 22 | * @param value the value itself; one of {@link Boolean}, {@link Byte}, {@link Short}, {@link |
| 23 | * Integer}, {@link Long}, {@link String}, {@link java.util.Optional}, {@link java.util.List}, |
| Matthias Andreas Benkard | b50fcd0 | 2021-12-16 20:17:20 +0100 | [diff] [blame^] | 24 | * {@link Object[]}, {@link Variant}. |
| Matthias Andreas Benkard | 31c61e7 | 2021-12-16 20:06:39 +0100 | [diff] [blame] | 25 | */ |
| 26 | public record Variant(Signature signature, Object value) {} |