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  
32  import java.math.BigInteger;
33  
34  import edu.umd.cs.findbugs.annotations.NonNull;
35  
36  public interface INonNegativeIntegerItem extends IIntegerItem {
37    @SuppressWarnings("null")
38    @NonNull
39    INonNegativeIntegerItem ONE = valueOf(BigInteger.ONE);
40    @SuppressWarnings("null")
41    @NonNull
42    INonNegativeIntegerItem ZERO = valueOf(BigInteger.ZERO);
43  
44    @NonNull
45    static INonNegativeIntegerItem valueOf(@NonNull IIntegerItem value) {
46      return valueOf(value.asInteger());
47    }
48  
49    @SuppressWarnings("null")
50    @NonNull
51    static INonNegativeIntegerItem valueOf(long value) {
52      return valueOf(BigInteger.valueOf(value));
53    }
54  
55    @NonNull
56    static INonNegativeIntegerItem valueOf(@NonNull BigInteger value) {
57      return new NonNegativeIntegerItemImpl(value);
58    }
59  
60    @NonNull
61    static INonNegativeIntegerItem valueOf(@NonNull String value) {
62      try {
63        return valueOf(MetaschemaDataTypeProvider.NON_NEGATIVE_INTEGER.parse(value));
64      } catch (IllegalArgumentException ex) {
65        throw new InvalidValueForCastFunctionException(String.format("Unable to parse string value '%s'", value),
66            ex);
67      }
68    }
69  
70    @NonNull
71    static INonNegativeIntegerItem cast(@NonNull IAnyAtomicItem item) {
72      return MetaschemaDataTypeProvider.NON_NEGATIVE_INTEGER.cast(item);
73    }
74  }