001/*
002 * Portions of this software was developed by employees of the National Institute
003 * of Standards and Technology (NIST), an agency of the Federal Government and is
004 * being made available as a public service. Pursuant to title 17 United States
005 * Code Section 105, works of NIST employees are not subject to copyright
006 * protection in the United States. This software may be subject to foreign
007 * copyright. Permission in the United States and in foreign countries, to the
008 * extent that NIST may hold copyright, to use, copy, modify, create derivative
009 * works, and distribute this software and its documentation without fee is hereby
010 * granted on a non-exclusive basis, provided that this notice and disclaimer
011 * of warranty appears in all copies.
012 *
013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
025 */
026
027package gov.nist.secauto.metaschema.core.metapath.item.atomic;
028
029import gov.nist.secauto.metaschema.core.datatype.adapter.MetaschemaDataTypeProvider;
030import gov.nist.secauto.metaschema.core.metapath.function.InvalidValueForCastFunctionException;
031
032import java.math.BigInteger;
033
034import edu.umd.cs.findbugs.annotations.NonNull;
035
036public interface IPositiveIntegerItem extends IIntegerItem {
037  @SuppressWarnings("null")
038  @NonNull
039  IPositiveIntegerItem ONE = valueOf(BigInteger.ONE);
040
041  @NonNull
042  static IPositiveIntegerItem valueOf(@NonNull IIntegerItem value) {
043    return valueOf(value.asInteger());
044  }
045
046  @SuppressWarnings("null")
047  @NonNull
048  static IPositiveIntegerItem valueOf(long value) {
049    return valueOf(BigInteger.valueOf(value));
050  }
051
052  @NonNull
053  static IPositiveIntegerItem valueOf(@NonNull BigInteger value) {
054    return new PositiveIntegerItemImpl(value);
055  }
056
057  @NonNull
058  static IPositiveIntegerItem valueOf(@NonNull String value) {
059    try {
060      return valueOf(MetaschemaDataTypeProvider.POSITIVE_INTEGER.parse(value));
061    } catch (IllegalArgumentException ex) {
062      throw new InvalidValueForCastFunctionException(String.format("Unable to parse string value '%s'", value),
063          ex);
064    }
065  }
066
067  @NonNull
068  static IPositiveIntegerItem cast(@NonNull IAnyAtomicItem item) {
069    return MetaschemaDataTypeProvider.POSITIVE_INTEGER.cast(item);
070  }
071}