br.com.caelum.stella.boleto
Class Boleto

java.lang.Object
  br.com.caelum.stella.boleto.Boleto

public class Boleto
extends Object

Bean que representa os dados de um boleto.

Author:

Paulo Silveira, Caue Guerra

Method Summary

boolean	getAceite() Devolve o aceite do boleto Valor padrão: 'N'
Banco	getBanco() Devolve o banco do boleto
int	getCodEspecieMoeda() Devolve o código da espécie da moeda.
Datas	getDatas() Devolve as datas do boleto
List<String>	getDescricoes() Devolve as descrições do boleto.
Emissor	getEmissor() Devolve o emissor do boleto
String	getEspecieDocumento() Devolve a espécie do documento do boleto.
String	getEspecieMoeda() Devolve a espécie da moeda.
int	getFatorVencimento() Devolve o fator de vencimento do boleto.
List<String>	getInstrucoes() Devolve as instruções do boleto
List<String>	getLocaisDePagamento() Devolve os locais de pagamento do boleto
String	getNoDocumento() Devolve o número do documento.
String	getNoDocumentoFormatado() Devolve o número do documento formatado (com 4 digitos)
BigDecimal	getQtdMoeda() Devolve a quantidade da moeda
Sacado	getSacado() Devolve o sacado do banco
BigDecimal	getValorBoleto() Devolve o valor desse boleto
String	getValorFormatado() Devolve o valor do boleto formatado (com 10 digitos)
BigDecimal	getValorMoeda() Devolve o valor da moeda, format
static Boleto	newBoleto() Cria um novo boleto com valores padrão.
Boleto	withAceite(boolean aceite) Associa o aceite ao boleto.
Boleto	withBanco(Banco banco) Associa um banco ao boleto
Boleto	withDatas(Datas datas) Associa datas ao boleto
Boleto	withDescricoes(String... descricoes) Associa as descrições ao boleto.
Boleto	withEmissor(Emissor emissor) Associa um sacado ao boleto
Boleto	withEspecieDocumento(String especieDocumento) Associa a espécie do documento ao boleto.
Boleto	withInstrucoes(String... instrucoes) Associa instruções ao boleto
Boleto	withLocaisDePagamento(String... locaisDePagamento) Associa locais de pagamento ao boleto
Boleto	withNoDocumento(String noDocumento) Associa o número do documento ao boleto Código informado pelo banco.
Boleto	withQtdMoeda(BigDecimal qtdMoeda) Associa a quantidade de moeda ao boleto
Boleto	withSacado(Sacado sacado) Associa um sacado ao banco
Boleto	withValorBoleto(BigDecimal valorBoleto)
Boleto	withValorBoleto(double valorBoleto)
Boleto	withValorBoleto(String valorBoleto) Associa um valor ao boleto, convertendo a String para BigDecimal utilizando o Locale da JVM
Boleto	withValorMoeda(BigDecimal valorMoeda) Associa um valor de moeda ao boleto

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newBoleto

public static Boleto newBoleto()

Cria um novo boleto com valores padrão.

getAceite

public boolean getAceite()

Devolve o aceite do boleto Valor padrão: 'N'

Returns:

withAceite

public Boleto withAceite(boolean aceite)

Associa o aceite ao boleto. Valor padrão: 'N'

Parameters:

aceite -

getDatas

public Datas getDatas()

Devolve as datas do boleto

Returns:

withDatas

public Boleto withDatas(Datas datas)

Associa datas ao boleto

Parameters:

datas -

getEspecieDocumento

public String getEspecieDocumento()

Devolve a espécie do documento do boleto. Valor padrão: "DV"

Returns:

withEspecieDocumento

public Boleto withEspecieDocumento(String especieDocumento)

Associa a espécie do documento ao boleto. Valor padrão: "DV"

Parameters:

especieDocumento -

getNoDocumento

public String getNoDocumento()

Devolve o número do documento. Código informado pelo banco.

Returns:

withNoDocumento

public Boleto withNoDocumento(String noDocumento)

Associa o número do documento ao boleto Código informado pelo banco.

Parameters:

noDocumento -

getQtdMoeda

public BigDecimal getQtdMoeda()

Devolve a quantidade da moeda

Returns:

withQtdMoeda

public Boleto withQtdMoeda(BigDecimal qtdMoeda)

Associa a quantidade de moeda ao boleto

Parameters:

qtdMoeda -

Returns:

getValorBoleto

public BigDecimal getValorBoleto()

Devolve o valor desse boleto

withValorBoleto

public Boleto withValorBoleto(String valorBoleto)

Associa um valor ao boleto, convertendo a String para BigDecimal utilizando o Locale da JVM

Parameters:

valorBoleto -

Returns:

withValorBoleto

public Boleto withValorBoleto(BigDecimal valorBoleto)

withValorBoleto

public Boleto withValorBoleto(double valorBoleto)

getEspecieMoeda

public String getEspecieMoeda()

Devolve a espécie da moeda. Valor padrão: "R$"

Returns:

getCodEspecieMoeda

public int getCodEspecieMoeda()

Devolve o código da espécie da moeda. Valor padrão: '9' (para R$)

Returns:

getValorMoeda

public BigDecimal getValorMoeda()

Devolve o valor da moeda, format

Returns:

withValorMoeda

public Boleto withValorMoeda(BigDecimal valorMoeda)

Associa um valor de moeda ao boleto

getBanco

public Banco getBanco()

Devolve o banco do boleto

Returns:

withBanco

public Boleto withBanco(Banco banco)

Associa um banco ao boleto

Parameters:

banco -

Returns:

getSacado

public Sacado getSacado()

Devolve o sacado do banco

Returns:

withSacado

public Boleto withSacado(Sacado sacado)

Associa um sacado ao banco

Parameters:

sacado -

Returns:

getEmissor

public Emissor getEmissor()

Devolve o emissor do boleto

Returns:

withEmissor

public Boleto withEmissor(Emissor emissor)

Associa um sacado ao boleto

Parameters:

emissor -

Returns:

getInstrucoes

public List<String> getInstrucoes()

Devolve as instruções do boleto

Returns:

withInstrucoes

public Boleto withInstrucoes(String... instrucoes)

Associa instruções ao boleto

Parameters:

instrucoes -

Returns:

getDescricoes

public List<String> getDescricoes()

Devolve as descrições do boleto. Note que esse campo não aparece no boleto gerado em PNG

Returns:

withDescricoes

public Boleto withDescricoes(String... descricoes)

Associa as descrições ao boleto. Note que esse campo não aparece no boleto gerado em PNG

Returns:

getLocaisDePagamento

public List<String> getLocaisDePagamento()

Devolve os locais de pagamento do boleto

Returns:

withLocaisDePagamento

public Boleto withLocaisDePagamento(String... locaisDePagamento)

Associa locais de pagamento ao boleto

Parameters:

locaisDePagamento -

Returns:

getFatorVencimento

public int getFatorVencimento()

Devolve o fator de vencimento do boleto. Utilizado para geração do código de barras e da linha digitável

Returns:

getValorFormatado

public String getValorFormatado()

Devolve o valor do boleto formatado (com 10 digitos)

Returns:

getNoDocumentoFormatado

public String getNoDocumentoFormatado()

Devolve o número do documento formatado (com 4 digitos)

Returns: