org.jrimum.texgit.IFiller Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bpp-cobranca Show documentation

This is a fork and merge from JRimum ( http://www.jrimum.org ), - Bopepo: https://github.com/jrimum/bopepo - Texgit: https://github.com/jrimum/texgit - Valia: https://github.com/jrimum/vallia - Utilix: https://github.com/jrimum/utilix - Domkee: https://github.com/jrimum/domkee For Brazillian Boleto Payment Method. So much thanks for original authors: Gilmar P. S. L, Misael Barreto and Rômulo Augusto.

The newest version!

package org.jrimum.texgit;

import java.io.Serializable;

import org.jrimum.texgit.TextStream;

public interface IFiller extends Serializable{

	/**
	 * Preenche o campo com o caracter especificado e no lado especificado.
	 * 
	 * 
	 * Exemplo:
	 * 

	 * Se sideToFill == SideToFill.LEFT, o caracter especificado será adicionado à String
	 * no lado esquerdo até que o campo fique com o tamanho que foi definido.
	 * 
	 * 
	 * @param toFill
	 * @param length
	 * @return String preenchida
	 * 
	 * @since 0.2
	 */
	String fill(String toFill, int length);

	/**
	 * Executa o método fill(String, int) passando o parâmetro
	 * toFill como String.valueOf(toFill).
	 * 
	 * @param tofill
	 * @param length
	 * @return String preenchida
	 * 
	 * @see IFiller#fill(String, int)
	 * 
	 * @since 0.2
	 */
	String fill(long tofill, int length);

	/**
	 * Executa o método fill(String, int) passando o parâmetro
	 * toFill como String.valueOf(toFill).
	 * 
	 * @param tofill
	 * @param length
	 * @return String preenchida
	 * 
	 * @see IFiller#fill(String, int)
	 * 
	 * @since 0.2
	 */
	String fill(int tofill, int length);

	/**
	 * Executa o método fill(String, int) passando o parâmetro
	 * toFill como String.valueOf(toFill).
	 * 
	 * @param tofill
	 * @param length
	 * @return String preenchida
	 * 
	 * @see IFiller#fill(String, int)
	 * 
	 * @since 0.2
	 */
	String fill(short tofill, int length);

	/**
	 * Executa o método fill(String, int) passando o parâmetro
	 * toFill como String.valueOf(toFill).
	 * 
	 * @param tofill
	 * @param length
	 * @return String preenchida
	 * 
	 * @see IFiller#fill(String, int)
	 * 
	 * @since 0.2
	 */
	String fill(byte tofill, int length);

	/**
	 * Executa o método fill(String, int) passando o parâmetro
	 * toFill como String.valueOf(toFill).
	 * 
	 * @param tofill
	 * @param length
	 * @return String preenchida
	 * 
	 * @see IFiller#fill(String, int)
	 * 
	 * @since 0.2
	 */
	String fill(char tofill, int length);

	/**
	 * Executa o método fill(String, int) passando o parâmetro
	 * toFill como String.valueOf(toFill).
	 * 
	 * @param tofill
	 * @param length
	 * @return String preenchida
	 * 
	 * @see IFiller#fill(String, int)
	 * 
	 * @since 0.2
	 */
	String fill(double tofill, int length);

	/**
	 * Executa o método fill(String, int) passando o parâmetro
	 * toFill como String.valueOf(toFill).
	 * 
	 * @param tofill
	 * @param length
	 * @return String preenchida
	 * 
	 * @see IFiller#fill(String, int)
	 * 
	 * @since
	 */
	String fill(float tofill, int length);

	/**
	 * Executa o método fill(String, int) passando o parâmetro
	 * toFill como toFill.toString().
     *
	 * 
	 * Caso toFill seja null, o método 
	 * fill(String, int) receberá uma String nula como parâmetro.
	 * 
	 * 
	 * @param tofill
	 * @param length
	 * @return String preenchida
	 * 
	 * @see IFiller#fill(String, int)
	 * 
	 * @since 0.2
	 */
	String fill(Object tofill, int length);

	/**
	 * Executa o método fill(String, int) passando o parâmetro
	 * toFill como toFill.write().
     *
	 * 
	 * Caso toFill seja null, o método 
	 * fill(String, int) receberá uma String nula como parâmetro.
	 * 
	 * 
	 * @param tofill
	 * @param length
	 * @return String preenchida
	 * 
	 * @see IFiller#fill(String, int)
	 * 
	 * @since 0.2
	 */
	String fill(TextStream tofill, int length);
}