org.jrimum.domkee.financeiro.banco.febraban.Agencia.java Source code

Introduction

Here is the source code for org.jrimum.domkee.financeiro.banco.febraban.Agencia.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:57:33
 * 
 * ================================================================================
 * 
 * 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:57:33
 * 
 */

package org.jrimum.domkee.financeiro.banco.febraban;

import static org.apache.commons.lang.StringUtils.EMPTY;

import org.apache.commons.lang.StringUtils;
import org.jrimum.utilix.Objects;

/**
 * <p>
 * Esta classe segue o padro especificado pela FEBRABAN:
 * <br/>
 * Invariantes:
 * <ul>
 * <li>Cdigo: deve ser um inteiro natural (incluindo zero) entre 1 e 5 dgitos</li>
 * <li>Dgito Verificador: alpha-numrico sendo um inteiro natural (incluindo zero)
 * ou caracter no vazio (' ') com um dgito.</li>
 * </ul>
 * </p>
 * 
 * @author <a href="http://gilmatryx.googlepages.com/">Gilmar P.S.L.</a> 
 * @author <a href="mailto:romulomail@gmail.com">Rmulo Augusto</a>
 * @author <a href="mailto:misaelbarreto@gmail.com">Misael Barreto</a>
 * @author <a href="mailto:samuelvalerio@gmail.com">Samuel Valrio</a>
 * 
 * @since 0.2
 * 
 * @version 0.2
 */
public final class Agencia implements org.jrimum.domkee.financeiro.banco.Agencia<Integer, String> {

    /**
     * 
     */
    private static final long serialVersionUID = -3512980818455792739L;

    private final Integer codigo;

    private final String digitoVerificador;

    public Agencia(Integer codigo) {

        this.codigo = codigo;
        verifyCodigo();
        this.digitoVerificador = EMPTY;
    }

    public Agencia(Integer codigo, String digito) {

        this.codigo = codigo;
        verifyCodigo();
        this.digitoVerificador = digito;
        verifyDv();
    }

    public void verifyCodigo() {

        if (codigo < 0) {
            throw new IllegalArgumentException(
                    "O cdigo da agncia deve ser um inteiro natural (incluindo zero)");
        }

        if (String.valueOf(codigo).length() > 5) {
            throw new IllegalArgumentException("O cdigo da agncia deve possuir de 1 a 5 dgitos");
        }
    }

    public void verifyDv() {

        if (StringUtils.isBlank(digitoVerificador)) {
            throw new IllegalArgumentException(
                    "O dgito verificador da agncia no pode ser null ou apenas espaos em branco");
        }

        if (digitoVerificador.length() > 1) {
            throw new IllegalArgumentException("O dgito verificador da agncia deve possuir apenas um dgito");
        }

        if (!StringUtils.isAlphanumeric(digitoVerificador)) {
            throw new IllegalArgumentException("O dgito verificador da agncia deve ser letra ou dgito");
        }
    }

    public Integer getCodigo() {
        return codigo;
    }

    public String getDigitoVerificador() {
        return digitoVerificador;
    }

    @Override
    public String toString() {
        return Objects.toString(this);
    }
}