com.univocity.parsers.fixed
Enum FieldAlignment

java.lang.Object
  java.lang.Enum<FieldAlignment>
      com.univocity.parsers.fixed.FieldAlignment

All Implemented Interfaces:

Serializable, Comparable<FieldAlignment>

public enum FieldAlignment
extends Enum<FieldAlignment>

Alignment of text in a fixed-width field.

Author:

uniVocity Software Pty Ltd - parsers@univocity.com

Enum Constant Summary

CENTER
Centralizes values

LEFT
Aligns values to the left

RIGHT
Aligns values to the right

Method Summary

int	calculatePadding(int totalLength, int lengthToWrite) Calculates how many whites paces to introduce before a value so it is printed as specified by the alignment type.
static FieldAlignment	valueOf(String name) Returns the enum constant of this type with the specified name.
static FieldAlignment[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LEFT

public static final FieldAlignment LEFT

Aligns values to the left

CENTER

public static final FieldAlignment CENTER

Centralizes values

RIGHT

public static final FieldAlignment RIGHT

Aligns values to the right

Method Detail

values

public static FieldAlignment[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FieldAlignment c : FieldAlignment.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FieldAlignment valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

calculatePadding

public int calculatePadding(int totalLength,
                            int lengthToWrite)

Calculates how many whites paces to introduce before a value so it is printed as specified by the alignment type.

Parameters:

totalLength - the total length available to write for a given field

lengthToWrite - the length of a value that will be written to the field

Returns:

the number of whites paces to introduce in before the value to make it align as specified.