br.com.nordestefomento.jrimum.vallia.digitoverificador.BoletoCodigoDeBarrasDV.java Source code

Java tutorial

Introduction

Here is the source code for br.com.nordestefomento.jrimum.vallia.digitoverificador.BoletoCodigoDeBarrasDV.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:11
 * 
 * ================================================================================
 * 
 * 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:11
 * 
 */

package br.com.nordestefomento.jrimum.vallia.digitoverificador;

import org.apache.commons.lang.StringUtils;

/**
 * <p>
 * Lgica de clculo do dgito verificador do cdigo de barras de um boleto.<br />
 * A lgica funciona da seguinte forma:
 * </p>
 * <p>
 * Utilizando-se o mdulo 11, considerando-se os 43 dgitos que compem o cdigo
 * de barras, j excluda a 5 posio (posio do dgito verificador), segue-se
 * o procedimento abaixo:
 * </p>
 * <p>
 * Calcula-se o dgito verificador atravs da expresso <code>DV = 11 - R</code>
 * , onde R  o resultado do clculo do mdulo.<br />
 * Observao: O dgito verificador ser 1 para os restos (resultado do mdulo):
 * 0 , 10 ou 1 (zero, dez, um).
 * </p>
 * <p>
 * Obs.: A rotina de mdulo utilizada  o mdulo 11.
 * </p>
 * 
 * @see Modulo
 * 
 * @author <a href="http://gilmatryx.googlepages.com/">Gilmar P.S.L</a>
 * @author Misael Barreto
 * @author Rmulo Augusto
 * @author <a href="http://www.nordeste-fomento.com.br">Nordeste Fomento
 *         Mercantil</a>
 * 
 * @version 0.2
 * 
 * @since 0.2
 */
public class BoletoCodigoDeBarrasDV extends AbstractDigitoVerificador {

    private static final long serialVersionUID = 7977220668336110040L;

    private static final int TAMANHO_SEM_DV = 43;

    private static final Modulo modulo11 = new Modulo(TipoDeModulo.MODULO11);

    /**
     * <p>
     * Construtor vaizo, o mesmo que <tt>super()</tt>.
     * </p>
     * 
     * @since 0.2
     */
    public BoletoCodigoDeBarrasDV() {

        super();
    }

    /**
     * @see br.com.nordestefomento.jrimum.vallia.digitoverificador.AbstractDigitoVerificador#calcule(String)
     * @since 0.2
     */
    @Override
    public int calcule(String numero) throws IllegalArgumentException {

        int dv = 0;
        int resto = 0;

        if (StringUtils.isNotBlank(numero) && StringUtils.isNumeric(numero)
                && (numero.length() == TAMANHO_SEM_DV)) {

            // Realizando o clculo do dgito verificador utilizando mdulo 11.
            // Obtendo o resto da diviso por 11.
            resto = modulo11.calcule(numero);

            // Seguindo as especificaes da FEBRABAN, caso o resto seja
            // (0), (1) ou (10), ser atribudo (1) ao digito verificador.
            if ((resto == 0) || (resto == 1) || (resto == 10))
                dv = 1;
            // Caso contrrio, dv = 11 - resto.
            else
                dv = modulo11.valor() - resto;

        } else {
            throw new IllegalArgumentException("O cdigo de barras " + "[ " + numero
                    + " ] deve conter apenas nmeros e " + TAMANHO_SEM_DV + " caracteres.");
        }

        return dv;
    }

}