1 /* 2 * Copyright (c) 2002-2023, City of Paris 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 9 * 1. Redistributions of source code must retain the above copyright notice 10 * and the following disclaimer. 11 * 12 * 2. Redistributions in binary form must reproduce the above copyright notice 13 * and the following disclaimer in the documentation and/or other materials 14 * provided with the distribution. 15 * 16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its 17 * contributors may be used to endorse or promote products derived from 18 * this software without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE 24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 * 32 * License 1.0 33 */ 34 package fr.paris.lutece.plugins.document.utils; 35 36 import org.apache.commons.lang3.StringUtils; 37 38 39 /** 40 * 41 * IntegerUtils 42 * 43 */ 44 public final class IntegerUtils 45 { 46 /** Default value in case the conversion fails */ 47 private static final int DEFAULT = -1; 48 49 /** 50 * Private constructor 51 */ 52 private IntegerUtils( ) 53 { 54 } 55 56 /** 57 * Convert a given String into an integer. 58 * <br /> 59 * If the String is blank or is not numerical, then it returns {@link #DEFAULT}. 60 * @param strToParse the String to convert 61 * @return the numerical value of the String 62 */ 63 public static int convert( String strToParse ) 64 { 65 return convert( strToParse, DEFAULT ); 66 } 67 68 /** 69 * Convert a given String into an integer. 70 * <br /> 71 * If the String is blank or is not numerical, then it returns nDefault 72 * @param strToParse the String to parse 73 * @param nDefault the default value in case the conversion fails 74 * @return the numerical value of the String 75 */ 76 public static int convert( String strToParse, int nDefault ) 77 { 78 if ( StringUtils.isNotBlank( strToParse ) && StringUtils.isNumeric( strToParse ) ) 79 { 80 return Integer.parseInt( strToParse ); 81 } 82 83 return nDefault; 84 } 85 86 /** 87 * Check if the given String is numeric 88 * @param strToCheck the String to check 89 * @return true if it is numeric, false otherwise 90 */ 91 public static boolean isNumeric( String strToCheck ) 92 { 93 return StringUtils.isNotBlank( strToCheck ) && StringUtils.isNumeric( strToCheck ); 94 } 95 96 /** 97 * Check if the given String is not numerical 98 * @param strToCheck the String to check 99 * @return true if it is not numeric, false otherwise 100 */ 101 public static boolean isNotNumeric( String strToCheck ) 102 { 103 return !isNumeric( strToCheck ); 104 } 105 106 /** 107 * Check if the given number is equal to {@link #DEFAULT} 108 * @param nNumber the number to check 109 * @return true if it is equal, false otherwise 110 */ 111 public static boolean isDefault( int nNumber ) 112 { 113 return nNumber == DEFAULT; 114 } 115 }