org.jrimum.vallia.AbstractDigitoVerificador 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:21:41
 * 
 * ================================================================================
 * 
 * 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:21:41
 * 
 */

package org.jrimum.vallia;

/**
 *
 * FactoryCampoLivre padrão utilizada por qualquer classe que implemente uma
 * lógica de cálculo de um dígito verificador qualquer.
 * 
 * 
 * 
 * @author Gilmar P.S.L
 * @author Misael Barreto
 * @author Rômulo Augusto
 * @author Nordeste Fomento
 *         Mercantil
 * 
 * @since 0.2
 * 
 * @version 0.2
 */
public abstract class AbstractDigitoVerificador {

	/**
	 * 
	 * Calcula o dígito verificador de um número de acordo com uma lógica
	 * específica.
	 * 
	 * 
	 * @param numero
	 *            - número que será calculado o dígito verificador.
	 * @return dígito verificador.
	 * @throws IllegalArgumentException
	 *             caso a String não esteja em um formatador aceitável. (O
	 *             formatador é definido nas subclasses implementadoras).
	 * @since 0.2
	 */
	public abstract int calcule(String numero) throws IllegalArgumentException;

	/**
	 * 
	 * Calcula o dígito verificador de um número de acordo com uma lógica
	 * específica.
	 * 
	 * 
	 * Se não sobrescrito o retorno é sempre igual a 0 (zero).
	 * 
	 * 
	 * @param numero
	 *            - número que será calculado o dígito verificador.
	 * @return dígito verificador
	 * @since 0.2
	 */
	public int calcule(long numero) {

		return 0;
	}

}