org.jrimum.texgit.FixedField 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!
/*
 * 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: 26/07/2008 - 12:44:41
 *
 * ================================================================================
 *
 * Direitos autorais 2008 JRimum Project
 *
 * Licenciado sob a Licença Apache, Versão 2.0 ("LICENÇA"); você não pode usar
 * esse arquivo exceto em conformidade com a esta LICENÇA. Você pode obter uma
 * cópia desta LICENÇA em http://www.apache.org/licenses/LICENSE-2.0 A menos que
 * haja exigência legal ou acordo por escrito, a distribuição de software sob
 * esta LICENÇA se dará “COMO ESTÁ”, SEM GARANTIAS OU CONDIÇÕES DE QUALQUER
 * TIPO, sejam expressas ou tácitas. Veja a LICENÇA para a redação específica a
 * reger permissões e limitações sob esta LICENÇA.
 *
 * Criado em: 26/07/2008 - 12:44:41
 *
 */
package org.jrimum.texgit;

import static java.lang.String.format;
import static org.apache.commons.lang3.StringUtils.EMPTY;
import static org.jrimum.utilix.Objects.isNotNull;

import java.text.Format;

import org.jrimum.utilix.Objects;

/**
 * @author Gilmar P.S.L.
 *
 * @param 
 */
@SuppressWarnings("serial")
public class FixedField extends Field implements IFixedField {

    /**
     * 
     * Tamanho da string de escrita do campo.
     * 
     */
    protected Integer instantLength;

    /**
     *
     */
    public FixedField() {
        super();
    }

    public FixedField(G value, Integer length) {
        super(value);
        setFixedLength(length);
    }

    public FixedField(G value, Integer length, IFiller filler) {
        super(value);
        setFixedLength(length);
        setFiller(filler);
    }

    public FixedField(G value, Integer length, Format formatter) {
        super(value, formatter);
        setFixedLength(length);
    }

    public FixedField(G value, Integer length, Format formatter, IFiller filler) {
        super(value, formatter);
        setFixedLength(length);
        setFiller(filler);
    }

    public FixedField(String name, G value, Integer length) {
        super(name, value);
        setFixedLength(length);
    }

    public FixedField(String name, G value, Integer length, IFiller filler) {
        super(name, value);
        setFixedLength(length);
        setFiller(filler);
    }

    public FixedField(String name, G value, Integer length, Format formatter) {
        super(name, value, formatter);
        setFixedLength(length);
    }

    public FixedField(String name, G value, Integer length, Format formatter, IFiller filler) {
        super(name, value, formatter);
        setFixedLength(length);
        setFiller(filler);
    }

    @Override
    public FixedField clone() throws CloneNotSupportedException {

        return (FixedField) super.clone();
    }

    /**
     * @see org.jrimum.texgit.type.component.Field#read(java.lang.String)
     */
    @Override
    public void read(String str) {

        Objects.checkNotNull(str, "String inválida [null]!");

        if (str.length() == getFixedLength()) {
            super.read(str);
        } else {
            throw new IllegalArgumentException(format("Tamanho da string [%s] diferente do especificado [%s]! %s", str.length(), getFixedLength(), toString()));
        }
    }

    /**
     * @see org.jrimum.texgit.type.component.Field#write()
     */
    @Override
    public String write() {
        String str = fill(super.write());
        instantLength = str.length();
        if (isTruncate() && instantLength > getFixedLength()) {
            str = str.substring(0, getFixedLength());
            instantLength = getFixedLength();
        }
        isFixedAsDefined();
        return str;
    }

    public boolean isFixedAsDefined() throws IllegalStateException {
        if (instantLength.equals(getFixedLength())) {
            return true;
        } else {
            throw new IllegalStateException(format("Tamanho da string [%s] diferente do especificado [%s]! %s", instantLength, getFixedLength(), toString()));
        }
    }

    public Integer getFixedLength() {

        return this.length;
    }

    public void setFixedLength(Integer length) {

        if (isNotNull(length) && length.intValue() > 0) {
            this.length = length;
        } else {
            throw new IllegalArgumentException(format("Comprimento inválido [%s]!", length));
        }

    }

    public void setFiller(IFiller filler) {
        if (isNotNull(filler)) {
            this.filler = filler;
        } else {
            throw new IllegalArgumentException(format("Preenchedor inválido [%s]!", filler));
        }
    }

    public boolean isTruncate() {
        return this.truncate;
    }

    public void setTruncate(boolean truncate) {
        this.truncate = truncate;
    }

    public boolean isApenasDigitos() {
        return this.apenasDigitos;
    }

    public void setApenasDigitos(boolean apenasDigitos) {
        this.apenasDigitos = apenasDigitos;
    }


    @Override
    public String toString() {
        return format(
                "%s FixedField [length=%s, instantLength=%s, filler=%s, truncate=%s]",
                super.toString(),
                Objects.whenNull(this.length, EMPTY),
                Objects.whenNull(this.instantLength, EMPTY),
                Objects.whenNull(this.filler, EMPTY),
                Objects.whenNull(this.truncate, EMPTY));
    }

    //Melhorar isso
    public boolean equalsValue(FixedField ff) {
        return ff != null && ff.getValue() != null
                && ff.getValue().equals(this.getValue());
    }
}