View Javadoc

1   /*
2    * ModeShape (http://www.modeshape.org)
3    * See the COPYRIGHT.txt file distributed with this work for information
4    * regarding copyright ownership.  Some portions may be licensed
5    * to Red Hat, Inc. under one or more contributor license agreements.
6    * See the AUTHORS.txt file in the distribution for a full listing of 
7    * individual contributors. 
8    *
9    * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
10   * is licensed to you under the terms of the GNU Lesser General Public License as
11   * published by the Free Software Foundation; either version 2.1 of
12   * the License, or (at your option) any later version.
13   *
14   * ModeShape is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17   * Lesser General Public License for more details.
18   *
19   * You should have received a copy of the GNU Lesser General Public
20   * License along with this software; if not, write to the Free
21   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
23   */
24  package org.modeshape.jdbc.util;
25  
26  import org.modeshape.jdbc.JdbcI18n;
27  
28  /**
29   * Utility class that checks arguments to methods. This class is to be used only in API methods, where failure to supply correct
30   * arguments should result in a useful error message. In all cases, use the <code>assert</code> statement.
31   */
32  public final class CheckArg {
33  
34      // ########################## int METHODS ###################################
35  
36      /**
37       * Check that the specified argument is non-null
38       * 
39       * @param argument The argument
40       * @param name The name of the argument
41       * @throws IllegalArgumentException If argument is null
42       */
43      public static void isNotNull( Object argument,
44                                    String name ) {
45          if (argument == null) {
46              throw new IllegalArgumentException(JdbcI18n.argumentMayNotBeNull.text(name));
47          }
48      }
49  
50      private CheckArg() {
51          // prevent construction
52      }
53  }