001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache license, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the license for the specific language governing permissions and 015 * limitations under the license. 016 */ 017package org.apache.logging.log4j.core.util; 018 019import java.util.Objects; 020 021/** 022 * Utility class providing common validation logic. 023 */ 024public final class Assert { 025 private Assert() { 026 } 027 028 public static int valueIsAtLeast(final int value, final int minValue) { 029 if (value < minValue) { 030 throw new IllegalArgumentException("Value should be at least " + minValue + " but was " + value); 031 } 032 return value; 033 } 034 035 /** 036 * Throws a {@code NullPointerException} if the specified parameter is 037 * {@code null}, otherwise returns the specified parameter. 038 * <p> 039 * On Java 7, just use {@code Objects.requireNonNull(T, String)} 040 * </p> 041 * <p> 042 * Usage: 043 * </p> 044 * <pre> 045 * // earlier you would write this: 046 * public SomeConstructor(Object param) { 047 * if (param == null) { 048 * throw new NullPointerException("param"); 049 * } 050 * this.field = param; 051 * } 052 * 053 * // now you can do the same in one line: 054 * public SomeConstructor(Object param) { 055 * this.field = Assert.requireNonNull("param"); 056 * } 057 * </pre> 058 * 059 * @param <T> the type of the parameter to check and return 060 * @param object the parameter to check 061 * @param message message to populate the NPE with if necessary 062 * @return the specified parameter 063 * @throws NullPointerException if {@code object} is {@code null} 064 * @deprecated Will be removed in 2.5. 065 */ 066 @Deprecated 067 public static <T> T requireNonNull(final T object, final String message) { 068 return Objects.requireNonNull(object, message); 069 } 070}