org.jrimum.vallia.CPFDV Maven / Gradle / Ivy
Show all versions of bpp-cobranca Show documentation
/*
* 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:51:09
*
* ================================================================================
*
* 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:51:09
*
*/
package org.jrimum.vallia;
import java.util.regex.Pattern;
import org.apache.commons.lang3.StringUtils;
import org.jrimum.texgit.Filler;
/**
*
* O cálculo do dígito verificador do CPF é realizado em duas etapas e é
* auxiliado pela rotina de módulo 11.
*
*
* Abaixo é demonstrado como esse cálculo é feito:
*
* Exemplo para um número hipotético 222.333.666-XX:
*
* Primeiramente obtém-se um número R, calculado através da rotina de módulo 11,
* a partir dos nove primeiros números do CPF, nesse caso 222333666.
* Para obter o primeiro dígito verificador deve-se seguir a seguinte lógica:
*
* Se o número R for menor que 2, o dígito terá valor 0 (zero); senão, será a
* subtração do valor do módulo (11) menos o valor do número R, ou seja,
* DV = 11 - R.
*
*
* Para obter o segundo dígito verificador é da mesma forma do primeiro, porém
* deve ser calculado a partir dos dez primeiros números do CPF, ou seja,
* 222333666 + primeiro dígito.
*
*
* Obs.: Os limites mínimos e máximos do módulo 11 para o cálculo do primeiro e
* do segundo dígito verificador são 2 - 10 e 2 e 11, respectivamente.
*
*
* @see Modulo
*
*
* @author Gilmar P.S.L
* @author Misael Barreto
* @author Rômulo Augusto
* @author Nordeste Fomento
* Mercantil
*
* @since 0.2
*
* @version 0.2
*/
public class CPFDV extends AbstractDigitoVerificador {
/**
*
*/
private static final long serialVersionUID = 2059692008894172695L;
/**
*
* Liminte mínimo do para cálculo no módulo 11.
*
*/
private static final int LIMITE_MINIMO = 2;
/**
*
* Expressão regular para validação dos nove primeiros números do CPF sem
* formatação: "#########".
*
*/
private static final String REGEX_CPF_DV = "\\d{9}";
/**
*
* Expressão regular para validação dos nove primeiros números do CPF
* formatado: "###.###.###".
*
*/
private static final String REGEX_CPF_DV_FORMATTED = "\\d{3}\\.\\d{3}\\.\\d{3}";
/**
* @see br.com.nordestefomento.jrimum.vallia.digitoverificador.AbstractDigitoVerificador#calcule(long)
* @since 0.2
*/
@Override
public int calcule(long numero) {
return calcule(Filler.ZERO_LEFT.fill(String.valueOf(numero), 9));
}
/**
* @see br.com.nordestefomento.jrimum.vallia.digitoverificador.AbstractDigitoVerificador#calcule(java.lang.String)
* @since 0.2
*/
@Override
public int calcule(String numero) throws IllegalArgumentException {
int dv1 = 0;
int dv2 = 0;
boolean isFormatoValido = false;
validacao: {
if (StringUtils.isNotBlank(numero)) {
isFormatoValido = (Pattern.matches(REGEX_CPF_DV, numero) || Pattern
.matches(REGEX_CPF_DV_FORMATTED, numero));
if (isFormatoValido) {
numero = StringUtils.replaceChars(numero, ".", "");
dv1 = calcule(numero, 10);
dv2 = calcule(numero + dv1, 11);
break validacao;
}
}
throw new IllegalArgumentException(
"O CPF [ "
+ numero
+ " ] deve conter apenas números, sendo eles no formato ###.###.### ou ######### !");
}
return Integer.parseInt(dv1 + "" + dv2);
}
/**
*
* Método auxiliar para o cálculo do dígito verificador.
*
*
* Calcula os dígitos separadamente.
*
*
* @param numero
* - número a partir do qual será extraído o dígito verificador.
* @param limiteMaximoDoModulo
* - limite máximo do módulo utilizado, no caso, módulo 11.
* @return um número que faz parte de um dígito verificador.
* @throws IllegalArgumentException
* caso o número não esteja no formatador desejável.
* @since 0.2
*/
private int calcule(String numero, int limiteMaximoDoModulo)
throws IllegalArgumentException {
int dv = 0;
int resto = 0;
resto = Modulo
.calculeMod11(numero, LIMITE_MINIMO, limiteMaximoDoModulo);
if (resto >= 2) {
dv = TipoDeModulo.MODULO11.valor() - resto;
}
return dv;
}
}