cvs commit: jakarta-jetspeed-2/portal/src/java/org/apache/jetspeed/util ArgUtil.java

[we...@apache.org]

weaver      2003/07/30 11:23:47

  Added:       portal/src/java/org/apache/jetspeed/util ArgUtil.java
  Log:
  Simple utility that, right now, simplfies testing for null arguments and throws
  IllegalArgumentException if there are nulls.
  
  Revision  Changes    Path
  1.1                  jakarta-jetspeed-2/portal/src/java/org/apache/jetspeed/util/ArgUtil.java
  
  Index: ArgUtil.java
  ===================================================================
  /* ====================================================================
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2000-2003 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution,
   *    if any, must include the following acknowledgment:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowledgment may appear in the software itself,
   *    if and wherever such third-party acknowledgments normally appear.
   *
   * 4. The names "Apache" and "Apache Software Foundation" and
   *    "Apache Jetspeed" must not be used to endorse or promote products
   *    derived from this software without prior written permission. For
   *    written permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache",
   *    "Apache Jetspeed", nor may "Apache" appear in their name, without
   *    prior written permission of the Apache Software Foundation.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  package org.apache.jetspeed.util;
  
  /**
   * <p>
   * ArgUtil
   * </p>
   * 
   * Misc. utilities for rudimentary argument validation
   * 
   * @author <a href="mailto:weaver@apache.org">Scott T. Weaver</a>
   * @version $Id: ArgUtil.java,v 1.1 2003/07/30 18:23:47 weaver Exp $
   *
   */
  public class ArgUtil
  {
      private static final String MSG_1 = "Argument \"";
      private static final String MSG_2 = "\" cannot be null for method ";
  
      /**
       * 
       * @throws java.lang.IllegalArgumentException If ANY of the arguments are <code>null</code>
       * @param args array of arguments to validate as not nul
       * @param argNames array of arguments names, idexes should match with args. 
       * @param methodName Name of method we are validating arguments for.
       */
      public static void notNull(Object[] args, String[] argNames, String methodName)
      {
          for (int i = 0; i < args.length; i++)
          {
              Object arg = args[i];
              if (arg == null)
              {
                  StringBuffer buf = new StringBuffer(150);
                  String argName = null;
                  if (i < argNames.length)
                  {
                      argName = argNames[i];
                  }
                  else
                  {
                      argName = String.valueOf(i);
                  }
  
                  buf.append(MSG_1 + argName + MSG_2 + methodName);
                  throw new IllegalArgumentException(buf.toString());
              }
          }
      }
  }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jetspeed-dev-help@jakarta.apache.org