org.jrimum.vallia.digitoverificador.BoletoLinhaDigitavelDV.java Source code

Introduction

Here is the source code for org.jrimum.vallia.digitoverificador.BoletoLinhaDigitavelDV.java

Source

/*
 * 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:22:21
 * 
 * ================================================================================
 * 
 * Direitos autorais 2008 JRimum Project
 * 
 * Licenciado sob a Licena Apache, Verso 2.0 ("LICENA"); voc no pode usar
 * esse arquivo exceto em conformidade com a esta LICENA. Voc pode obter uma
 * cpia desta LICENA em http://www.apache.org/licenses/LICENSE-2.0 A menos que
 * haja exigncia legal ou acordo por escrito, a distribuio de software sob
 * esta LICENA se dar COMO EST??, SEM GARANTIAS OU CONDIES DE QUALQUER
 * TIPO, sejam expressas ou tcitas. Veja a LICENA para a redao especfica a
 * reger permisses e limitaes sob esta LICENA.
 * 
 * Criado em: 30/03/2008 - 18:22:21
 * 
 */

package org.jrimum.vallia.digitoverificador;

import java.util.regex.Pattern;

import org.apache.commons.lang.StringUtils;
import org.jrimum.utilix.text.Filler;

/**
 * <p>
 * Segundo o padro FEBRABAN a linha digitvel possui cinco campos, dos quais
 * apenas os trs primeiros necessitam de validao com dgito verificador.
 * </p>
 * <p>
 * Para fins de validao  preciso saber o seguinte:
 * <ul>
 * <li>O primerio campo tem tamanho 9 (nove) mais o dgito verificador.</li>
 * <li>O segundo campo tem tamanho 10 (dez) mais o dgito verificador.</li>
 * <li>O terceiro campo tem tamanho 10 (dez) mais o dgito verificador.</li>
 * </ul>
 * </p>
 * <p>
 * Obs1.: Todos os campos listados podem vir com um ponto (.) de separao
 * exatamente aps o dgito da 5 posio. <br />
 * Exemplo de linha digitvel:<br />
 * <code>99997.77213 30530.150082 18975.000003 1 10010000035000</code>
 * </p>
 * <p>
 * O clculo do dgito verificador  descrito atravs da expresso
 * <code>DV = 11 - R</code>, onde R  o resultado do clculo do mdulo.<br />
 * Obs1.: O dgito verificador ser 0 (zero) se o resto (resultado do mdulo)
 * for 0 (zero). <br />
 * Obs2.: A rotina de mdulo utilizada  a mdulo 10.
 * </p>
 * 
 * @author <a href="http://gilmatryx.googlepages.com/">Gilmar P.S.L</a>
 * @author <a href="mailto:misaelbarreto@gmail.com">Misael Barreto</a>
 * @author <a href="mailto:romulomail@gmail.com">Rmulo Augusto</a>
 * @author <a href="http://www.nordestefomento.com.br">Nordeste Fomento
 *         Mercantil</a>
 * 
 * @since 0.2
 * 
 * @version 0.2
 */
public class BoletoLinhaDigitavelDV extends AbstractDigitoVerificador {

    private static final long serialVersionUID = -9177413216786384292L;

    /**
     *<p>
     * Mdulo 10 utilizado no clculo.
     * </p>
     */
    private static final Modulo modulo10 = new Modulo(TipoDeModulo.MODULO10);

    /**
     * <p>
     * Expresso regular para validao do campo da linha digitvel, aceita os
     * seguintes formatos:
     * </p>
     * <ul>
     *    <li>#########</li>
     *    <li>#####.####</li>
     *    <li>##########</li>
     *    <li>#####.#####</li>
     * </ul>
     */
    private static final String REGEX_CAMPO = "(\\d{9})|(\\d{10})|(\\d{5})\\.(\\d{4})|(\\d{5})\\.(\\d{5})";

    /**
     * @see org.jrimum.vallia.digitoverificador.AbstractDigitoVerificador#calcule(java.lang.String)
     * @since 0.2
     */
    @Override
    public int calcule(long numero) {

        return calcule(Filler.ZERO_LEFT.fill(String.valueOf(numero), 10));
    }

    /**
     * @see org.jrimum.vallia.digitoverificador.AbstractDigitoVerificador#calcule(java.lang.String)
     * @since 0.2
     */
    @Override
    public int calcule(String numero) throws IllegalArgumentException {

        int dv = 0;
        int resto = 0;

        if (StringUtils.isNotBlank(numero) && Pattern.matches(REGEX_CAMPO, numero)) {

            numero = StringUtils.replaceChars(numero, ".", "");

            resto = modulo10.calcule(numero);

            if (resto != 0) {
                dv = modulo10.valor() - resto;
            }
        } else {
            throw new IllegalArgumentException(
                    "O campo [" + numero + "] da linha digitvel deve conter apenas nmeros com 9 ou 10 dgitos "
                            + "ou nos formatos [#####.####, #####.#####]");
        }

        return dv;
    }
}