Skip to content

Commit 2e8d87d

Browse files
committed
improved documentation
1 parent bab2d23 commit 2e8d87d

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

jbbp/src/main/java/com/igormaznitsa/jbbp/model/JBBPNumericField.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,15 @@ public interface JBBPNumericField extends JBBPInvertableBitOrder, JBBPNamedField
2626
* Get the field value as integer.
2727
*
2828
* @return the field value as integer
29+
* @throws IllegalStateException can be thrown if impossible to represent saved value as int
2930
*/
3031
int getAsInt();
3132

3233
/**
3334
* Get the field value as double.
3435
*
3536
* @return the field value as double
37+
* @throws IllegalStateException can be thrown if impossible to represent saved value as double
3638
* @since 1.4.0
3739
*/
3840
double getAsDouble();
@@ -41,6 +43,7 @@ public interface JBBPNumericField extends JBBPInvertableBitOrder, JBBPNamedField
4143
* Get the field value as float.
4244
*
4345
* @return the field value as float
46+
* @throws IllegalStateException can be thrown if impossible to represent saved value as float
4447
* @since 1.4.0
4548
*/
4649
float getAsFloat();
@@ -49,13 +52,15 @@ public interface JBBPNumericField extends JBBPInvertableBitOrder, JBBPNamedField
4952
* Get the field value as long
5053
*
5154
* @return the field value as long
55+
* @throws IllegalStateException can be thrown if impossible to represent saved value as long
5256
*/
5357
long getAsLong();
5458

5559
/**
5660
* Get the field value as boolean, usually if the value is 0 then false, true otherwise.
5761
*
5862
* @return the field value as boolean
63+
* @throws IllegalStateException can be thrown if impossible to represent saved value as boolean
5964
*/
6065
boolean getAsBool();
6166

0 commit comments

Comments
 (0)