1 /*
2 * Portions of this software was developed by employees of the National Institute
3 * of Standards and Technology (NIST), an agency of the Federal Government and is
4 * being made available as a public service. Pursuant to title 17 United States
5 * Code Section 105, works of NIST employees are not subject to copyright
6 * protection in the United States. This software may be subject to foreign
7 * copyright. Permission in the United States and in foreign countries, to the
8 * extent that NIST may hold copyright, to use, copy, modify, create derivative
9 * works, and distribute this software and its documentation without fee is hereby
10 * granted on a non-exclusive basis, provided that this notice and disclaimer
11 * of warranty appears in all copies.
12 *
13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25 */
26
27 package gov.nist.secauto.metaschema.core.metapath.item.atomic;
28
29 import gov.nist.secauto.metaschema.core.datatype.adapter.MetaschemaDataTypeProvider;
30 import gov.nist.secauto.metaschema.core.metapath.function.InvalidValueForCastFunctionException;
31
32 import java.math.BigInteger;
33
34 import edu.umd.cs.findbugs.annotations.NonNull;
35
36 public interface IIntegerItem extends INumericItem {
37
38 @SuppressWarnings("null")
39 @NonNull
40 IIntegerItem ONE = valueOf(BigInteger.ONE);
41 @SuppressWarnings("null")
42 @NonNull
43 IIntegerItem ZERO = valueOf(BigInteger.ZERO);
44 @SuppressWarnings("null")
45 @NonNull
46 IIntegerItem NEGATIVE_ONE = valueOf(BigInteger.ONE.negate());
47
48 @NonNull
49 static IIntegerItem valueOf(long value) {
50 @SuppressWarnings("null")
51 @NonNull BigInteger bigInteger = BigInteger.valueOf(value);
52 return valueOf(bigInteger);
53 }
54
55 /**
56 * Create an integer item from a string representing an integer value.
57 *
58 * @param value
59 * an integer value
60 * @return the item
61 * @throws NumberFormatException
62 * if the provided value is not a valid representation of a
63 * {@link BigInteger}
64 */
65 @NonNull
66 static IIntegerItem valueOf(@NonNull String value) {
67 return valueOf(new BigInteger(value));
68 }
69
70 @NonNull
71 static IIntegerItem valueOf(@NonNull BigInteger value) {
72 int signum = value.signum();
73
74 IIntegerItem retval;
75 if (signum == -1) { // negative
76 retval = new IntegerItemImpl(value);
77 } else if (signum == 0) { // zero
78 retval = INonNegativeIntegerItem.valueOf(value);
79 } else { // positive
80 retval = IPositiveIntegerItem.valueOf(value);
81 }
82 return retval;
83 }
84
85 @NonNull
86 static IIntegerItem cast(@NonNull IAnyAtomicItem item) throws InvalidValueForCastFunctionException {
87 return MetaschemaDataTypeProvider.INTEGER.cast(item);
88 }
89
90 @Override
91 IIntegerItem abs();
92
93 @Override
94 default IIntegerItem ceiling() {
95 return this;
96 }
97
98 @Override
99 default IIntegerItem floor() {
100 return this;
101 }
102
103 @Override
104 BigInteger getValue();
105 }