br.com.caelum.stella.boleto.Banco Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of caelum-stella-boleto Show documentation

There is a newer version: 2.2.0

package br.com.caelum.stella.boleto;

import java.net.URL;

/**
 * Interface que define métodos específicos ao funcionamento de cada banco para
 * gerar o código de barras e a linha digitável.


 * 
 * Infelizmente cada banco funciona de uma maneira diferente para gerar esses
 * valores, e as vezes até mudam de funcionamento.
 * 
 * Documentação que pode ser consultada:


 * 
 * http://www.macoratti.net/boleto.htm

 * http://pt.wikipedia.org/wiki/Boleto_bancário


 * 
 * Para testes rapidos: http://evandro.net/codigo_barras.html


 * 
 * Apesar de possuirmos diversos unit tests, sempre é bom ter precaução com
 * valores e testar alguns boletos, em especial se valores serão altos.
 * 
 * @author Paulo Silveira
 * @author Cauê Guerra
 * 
 */
public interface Banco {

    /**
     * Retorna o número desse banco, formatado com 3 dígitos
     * 
     * @return
     */
    String getNumeroFormatado();

    /**
     * Pega a URL com a imagem de um banco
     * 
     * @return
     */
    URL getImage();

    /**
     * Gera o código de barras para determinado boleto
     */
    String geraCodigoDeBarrasPara(Boleto boleto);

    /**
     * Gera a linha digitavel para determinado boleto
     * 
     */
    String geraLinhaDigitavelPara(Boleto boleto);

}