org.jrimum.utilix.ObjectUtil Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bpp-cobranca Show documentation

This is a fork and merge from JRimum ( http://www.jrimum.org ), - Bopepo: https://github.com/jrimum/bopepo - Texgit: https://github.com/jrimum/texgit - Valia: https://github.com/jrimum/vallia - Utilix: https://github.com/jrimum/utilix - Domkee: https://github.com/jrimum/domkee For Brazillian Boleto Payment Method. So much thanks for original authors: Gilmar P. S. L, Misael Barreto and Rômulo Augusto.

The newest version!

/*
 * Copyright 2008 JRimum Project
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by
 * applicable law or agreed to in writing, software distributed under the
 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
 * OF ANY KIND, either express or implied. See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * Created at: 30/03/2008 - 18:02:40
 * 
 * ================================================================================
 * 
 * Direitos autorais 2008 JRimum Project
 * 
 * Licenciado sob a Licença Apache, Versão 2.0 ("LICENÇA"); você não pode usar
 * esse arquivo exceto em conformidade com a esta LICENÇA. Você pode obter uma
 * cópia desta LICENÇA em http://www.apache.org/licenses/LICENSE-2.0 A menos que
 * haja exigência legal ou acordo por escrito, a distribuição de software sob
 * esta LICENÇA se dará “COMO ESTÁ”, SEM GARANTIAS OU CONDIÇÕES DE QUALQUER
 * TIPO, sejam expressas ou tácitas. Veja a LICENÇA para a redação específica a
 * reger permissões e limitações sob esta LICENÇA.
 * 
 * Criado em: 30/03/2008 - 18:02:40
 * 
 */

package org.jrimum.utilix;

import java.io.Serializable;

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.log4j.Logger;

/**
 * 
 * 
 * Classe raiz para todo o projeto detentora de metodos básicos e necessários.
 * 
 * 
 * 
 * Todas as classes do projeto devem herdar de ObjectUtil
 * para reutilizar métodos como o toString() e
 * isNull(Object, String).
 * 
 * 
 * 
 * @author Gilmar P.S.L.
 * 
 * @since 0.2
 * 
 * @version 0.2
 * 
 * @see #isNull(Object, String)
 * @see #toString()
 * @see Cucurbita
 */

public class ObjectUtil implements Serializable {

	private static final long serialVersionUID = -6790981191128287923L;
	
	private static Logger log = Logger.getLogger(ObjectUtil.class);
	
	private ObjectUtil() {
		throw new AssertionError();
	}

	/**
	 * 
	 * Verifica a referência ao objeto e lança uma exceção para casos onde a
	 * referência é nula incluíndo na mensagem de exceção o nome do parâmetro
	 * passado.
	 * 
	 * 
	 * @param object
	 * @param name
	 * 
	 * @return (object == null ? true : false)
	 * 
	 * @throws IllegalArgumentException
	 * 
	 * @see #isNotNull(Object, String)
	 * 
	 * @since 0.2
	 */
	public static boolean isNull(Object object, String name) throws IllegalArgumentException {

		boolean is = true;

		if (object != null) {
			is = false;
			
		} else {

			IllegalArgumentException e = new IllegalArgumentException(
					(name != null ? name : "Objeto ") + " inválido : [" + object + "]!");

			log.error(StringUtils.EMPTY, e);

			throw e;
		}

		return is;
	}

	/**
	 * 
	 * Verifica a referência ao objeto e lança uma exceção para casos onde a
	 * referência é nula incluíndo na mensagem de exceção o nome do parâmetro
	 * passado.
	 * 
	 * 
	 * 
	 * É o mesmo que usar !isNull(obj1,"obj1") a diferença é que
	 * utiliza-se um símbolo ! a menos.
	 * 
	 * 
	 * @param object
	 * @param name
	 * 
	 * @return (object != null ? true : false)
	 * 
	 * @throws IllegalArgumentException
	 * 
	 * @see #isNull(Object, String)
	 * 
	 * @since 0.2
	 */
	public static boolean isNotNull(Object object, String name) throws IllegalArgumentException {
		return !isNull(object, name);
	}

	/**
	 * 
	 * Verifica a referência ao objeto.
	 * 
	 * 
	 * @param object
	 * 
	 * @return (object != null ? true : false)
	 * 
	 * @see #isNull(Object)
	 * 
	 * @since 0.2
	 */
	public static boolean isNotNull(Object object) {
		return (object != null);
	}
	
	/**
	 * 
	 * Verifica se existe uma referência ao objeto dado.
	 * 
	 * 
	 * @param object
	 * 
	 * @return (object != null ? true : false)
	 * 
	 * @see #isNotNull(Object)
	 * 
	 * @since 0.2
	 */
	public static boolean exists(Object object) {
		return (object != null);
	}

	/**
	 * 
	 * Verifica a referência ao objeto.
	 * 
	 * 
	 * @param object
	 * 
	 * @return (object == null ? true : false)
	 * 
	 * @see #isNotNull(Object)
	 * 
	 * @since 0.2
	 */
	public static boolean isNull(Object object) {
		return (object == null);
	}

	/**
	 * Exibe os valores de instância para um objeto JRimum.
	 * 
	 * @see org.apache.commons.lang3.builder.ToStringBuilder#reflectionToString
	 * 
	 * @since 0.2
	 * 
	 * @see #toString()
	 */
	public static String toString(Object obj) {
		return "JRimumObject: " + ToStringBuilder.reflectionToString(obj);
	}
}