Util.java

/**
 * Portions of this software was developed by employees of the National Institute
 * of Standards and Technology (NIST), an agency of the Federal Government and is
 * being made available as a public service. Pursuant to title 17 United States
 * Code Section 105, works of NIST employees are not subject to copyright
 * protection in the United States. This software may be subject to foreign
 * copyright. Permission in the United States and in foreign countries, to the
 * extent that NIST may hold copyright, to use, copy, modify, create derivative
 * works, and distribute this software and its documentation without fee is hereby
 * granted on a non-exclusive basis, provided that this notice and disclaimer
 * of warranty appears in all copies.
 *
 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
 */

package gov.nist.secauto.swid.builder.util;

/**
 * Portions of this software was developed by employees of the National Institute
 * of Standards and Technology (NIST), an agency of the Federal Government.
 * Pursuant to title 17 United States Code Section 105, works of NIST employees are
 * not subject to copyright protection in the United States and are considered to
 * be in the public domain. Permission to freely use, copy, modify, and distribute
 * this software and its documentation without fee is hereby granted, provided that
 * this notice and disclaimer of warranty appears in all copies.
 *
 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
 * SHALL NASA BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, OR
 * IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
 */

import java.util.regex.Pattern;

public class Util {
  private Util() {
    // disable construction
  }

  /**
   * Checks that the provided string is not empty.
   * 
   * @param str
   *          the string to check
   * @return the same string
   * @throws NullPointerException
   *           if the provided string is <code>null</code>
   * @throws IllegalArgumentException
   *           if the provided string is empty
   */
  public static String requireNonEmpty(String str) {
    if (str.isEmpty()) {
      throw new IllegalArgumentException();
    }
    return str;
  }

  /**
   * Checks that the provided string is not empty.
   * 
   * @param str
   *          the string to check
   * @param message
   *          the exception message to use
   * @return the same string
   * @throws NullPointerException
   *           if the provided string is <code>null</code>
   * @throws IllegalArgumentException
   *           if the provided string is empty
   */
  public static String requireNonEmpty(String str, String message) {
    if (str.isEmpty()) {
      throw new IllegalArgumentException(message);
    }
    return str;
  }

  /**
   * Checks that the provided string is not empty.
   * 
   * @param array
   *          the array to check
   * @return the same array
   * @throws NullPointerException
   *           if the provided array is <code>null</code>
   * @throws IllegalArgumentException
   *           if the provided array is zero length
   */
  public static Object[] requireNonEmpty(Object[] array) {
    if (array.length == 0) {
      throw new IllegalArgumentException();
    }
    return array;
  }

  /**
   * Checks that the provided string is not empty.
   * 
   * @param array
   *          the array to check
   * @param message
   *          the exception message to use
   * @return the same array
   * @throws NullPointerException
   *           if the provided array is <code>null</code>
   * @throws IllegalArgumentException
   *           if the provided string is zero length
   */
  public static Object[] requireNonEmpty(Object[] array, String message) {
    if (array.length == 0) {
      throw new IllegalArgumentException(message);
    }
    return array;
  }

  /**
   * Checks that the provided string matches the provided pattern.
   * 
   * @param pattern
   *          the pattern to match against
   * @param str
   *          the string to check
   * @param message
   *          the exception message to use
   * @throws NullPointerException
   *           if the provided string is <code>null</code>
   * @throws IllegalArgumentException
   *           if the provided string is empty or if the string doesn't match the pattern
   */
  public static void requirePatternMatch(Pattern pattern, String str, String message) {
    requireNonEmpty(str);
    if (!pattern.matcher(str).matches()) {
      throw new IllegalArgumentException(message);
    }
  }
}