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 IIntegerItem extends INumericItem { 037 038 @SuppressWarnings("null") 039 @NonNull 040 IIntegerItem ONE = valueOf(BigInteger.ONE); 041 @SuppressWarnings("null") 042 @NonNull 043 IIntegerItem ZERO = valueOf(BigInteger.ZERO); 044 @SuppressWarnings("null") 045 @NonNull 046 IIntegerItem NEGATIVE_ONE = valueOf(BigInteger.ONE.negate()); 047 048 @NonNull 049 static IIntegerItem valueOf(long value) { 050 @SuppressWarnings("null") 051 @NonNull BigInteger bigInteger = BigInteger.valueOf(value); 052 return valueOf(bigInteger); 053 } 054 055 /** 056 * Create an integer item from a string representing an integer value. 057 * 058 * @param value 059 * an integer value 060 * @return the item 061 * @throws NumberFormatException 062 * if the provided value is not a valid representation of a 063 * {@link BigInteger} 064 */ 065 @NonNull 066 static IIntegerItem valueOf(@NonNull String value) { 067 return valueOf(new BigInteger(value)); 068 } 069 070 @NonNull 071 static IIntegerItem valueOf(@NonNull BigInteger value) { 072 int signum = value.signum(); 073 074 IIntegerItem retval; 075 if (signum == -1) { // negative 076 retval = new IntegerItemImpl(value); 077 } else if (signum == 0) { // zero 078 retval = INonNegativeIntegerItem.valueOf(value); 079 } else { // positive 080 retval = IPositiveIntegerItem.valueOf(value); 081 } 082 return retval; 083 } 084 085 @NonNull 086 static IIntegerItem cast(@NonNull IAnyAtomicItem item) throws InvalidValueForCastFunctionException { 087 return MetaschemaDataTypeProvider.INTEGER.cast(item); 088 } 089 090 @Override 091 IIntegerItem abs(); 092 093 @Override 094 default IIntegerItem ceiling() { 095 return this; 096 } 097 098 @Override 099 default IIntegerItem floor() { 100 return this; 101 } 102 103 @Override 104 BigInteger getValue(); 105}