com.helger.commons.format

Class FormatterMinLengthAddTrailing

java.lang.Object

com.helger.commons.format.AbstractFormatterString

com.helger.commons.format.FormatterMinLengthAddTrailing

All Implemented Interfaces:

IFormatter, Serializable

public final class FormatterMinLengthAddTrailing
extends AbstractFormatterString

A string formatter that ensures that a string has a minimum length by filling the remaining chars with a custom character at the end (trailing).

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FormatterMinLengthAddTrailing(IFormatter aPrevFormatter, int nMinLength, char cFill)
FormatterMinLengthAddTrailing(int nMinLength, char cFill)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
char	getFillChar()
protected String	getFormattedValueAsString(Object aValue) Convert the passed value from Object to formatted String.
int	getMinLength()
int	hashCode()
String	toString()

Methods inherited from class com.helger.commons.format.AbstractFormatterString

getFormattedValue, getPreviousFormatter, getValueAsString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FormatterMinLengthAddTrailing

public FormatterMinLengthAddTrailing(@Nonnegative
                                     int nMinLength,
                                     char cFill)

FormatterMinLengthAddTrailing

public FormatterMinLengthAddTrailing(@Nullable
                                     IFormatter aPrevFormatter,
                                     @Nonnegative
                                     int nMinLength,
                                     char cFill)

Method Detail

getMinLength

@Nonnegative
public int getMinLength()

getFillChar

public char getFillChar()

getFormattedValueAsString

protected String getFormattedValueAsString(@Nullable
                                           Object aValue)

Description copied from class: AbstractFormatterString

Convert the passed value from Object to formatted String. Use AbstractFormatterString.getValueAsString(Object) in implementations of this method to do the base conversion from Object to String.

Specified by:

getFormattedValueAsString in class AbstractFormatterString

Parameters:

aValue - The source object. May be null.

Returns:

The formatted string value.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class AbstractFormatterString