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 /** 029 * Throws a {@code NullPointerException} if the specified parameter is 030 * {@code null}, otherwise returns the specified parameter. 031 * <p> 032 * On Java 7, just use {@code Objects.requireNonNull(T, String)} 033 * </p> 034 * <p> 035 * Usage: 036 * </p> 037 * <pre> 038 * // earlier you would write this: 039 * public SomeConstructor(Object param) { 040 * if (param == null) { 041 * throw new NullPointerException("param"); 042 * } 043 * this.field = param; 044 * } 045 * 046 * // now you can do the same in one line: 047 * public SomeConstructor(Object param) { 048 * this.field = Assert.requireNonNull("param"); 049 * } 050 * </pre> 051 * 052 * @param <T> the type of the parameter to check and return 053 * @param object the parameter to check 054 * @param message message to populate the NPE with if necessary 055 * @return the specified parameter 056 * @throws NullPointerException if {@code object} is {@code null} 057 * @deprecated Will be removed in 2.5. 058 */ 059 @Deprecated 060 public static <T> T requireNonNull(final T object, final String message) { 061 return Objects.requireNonNull(object, message); 062 } 063}