View Javadoc
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  import gov.nist.secauto.metaschema.core.util.ObjectUtils;
32  
33  import java.math.BigDecimal;
34  
35  import edu.umd.cs.findbugs.annotations.NonNull;
36  
37  public interface IDecimalItem extends INumericItem {
38    @SuppressWarnings("null")
39    @NonNull
40    IDecimalItem ZERO = valueOf(BigDecimal.ZERO);
41  
42    @SuppressWarnings("null")
43    @NonNull
44    static IDecimalItem valueOf(long value) {
45      return valueOf(BigDecimal.valueOf(value));
46    }
47  
48    @NonNull
49    static IDecimalItem valueOf(double value) {
50      return valueOf(ObjectUtils.notNull(Double.toString(value)));
51    }
52  
53    @NonNull
54    static IDecimalItem valueOf(@NonNull BigDecimal value) {
55      return new DecimalItemImpl(value);
56    }
57  
58    @NonNull
59    static IDecimalItem valueOf(@NonNull String value) {
60      try {
61        return valueOf(MetaschemaDataTypeProvider.DECIMAL.parse(value));
62      } catch (IllegalArgumentException ex) {
63        throw new InvalidValueForCastFunctionException(String.format("Unable to parse string value '%s'", value),
64            ex);
65      }
66    }
67  
68    static @NonNull IDecimalItem cast(@NonNull IAnyAtomicItem item)
69        throws InvalidValueForCastFunctionException {
70      return MetaschemaDataTypeProvider.DECIMAL.cast(item);
71    }
72  
73    @Override
74    BigDecimal getValue();
75  }