com.realcomp.prime.conversion.RightPad Maven / Gradle / Ivy

Go to download
package com.realcomp.prime.conversion;

import org.apache.commons.lang3.StringUtils;

import java.util.Objects;

/**
 * Converts a value to a String (toString), and right pads the value with some character(s) to a specified length.
 * Default pad character is a single space.
 *
 */
@com.realcomp.prime.annotation.Converter("rightPad")
public class RightPad extends SimpleConverter{

    private static final int USE_ORIGINAL_LENGTH = -1;
    private int length = USE_ORIGINAL_LENGTH;
    private String with = " ";

    public RightPad(){
        super();
    }

    public RightPad(int length){
        super();
        if (length < 0){
            throw new IllegalArgumentException("length < 0");
        }
        this.length = length;
    }

    @Override
    public Object convert(Object value) throws ConversionException{

        if (length == USE_ORIGINAL_LENGTH){
            return value;
        }
        else{
            return value == null ? null : StringUtils.rightPad(value.toString(), length, with).substring(0, length);
        }
    }

    @Override
    public RightPad copyOf(){
        RightPad copy = new RightPad();
        copy.length = length;
        copy.with = with;
        return copy;
    }

    public int getLength(){
        return length;
    }

    public void setLength(int length){
        if (length < 0){
            throw new IllegalArgumentException("length < 0");
        }
        this.length = length;
    }

    public String getWith(){
        return with;
    }

    public void setWith(String pad){
        this.with = pad;
    }

    @Override
    public int hashCode(){
        int hash = 3;
        hash = 53 * hash + this.length;
        hash = 53 * hash + Objects.hashCode(this.with);
        return hash;
    }

    @Override
    public boolean equals(Object obj){
        if (obj == null){
            return false;
        }
        if (getClass() != obj.getClass()){
            return false;
        }
        final RightPad other = (RightPad) obj;
        if (this.length != other.length){
            return false;
        }
        if (!Objects.equals(this.with, other.with)){
            return false;
        }
        return true;
    }
}