Class AbstractFormattedPlaceholderPopulator

java.lang.Object

com.itextpdf.commons.actions.producer.AbstractFormattedPlaceholderPopulator

All Implemented Interfaces:

IPlaceholderPopulator

Direct Known Subclasses:

CurrentDatePlaceholderPopulator, UsedProductsPlaceholderPopulator

abstract class AbstractFormattedPlaceholderPopulator
extends Object
implements IPlaceholderPopulator

Abstract populator for placeholders consuming a parameter which is a pattern string. Any latin letter inside the pattern which is not quoted considered as a param defining the component of the outputted value.

Field Summary

Fields

Modifier and Type	Field	Description
private static final char	A_LOWERCASE
private static final char	A_UPPERCASE
protected static final char	APOSTROPHE	Escaping character.
private static final char	ESCAPE_CHARACTER
private static final char	Z_LOWERCASE
private static final char	Z_UPPERCASE

Constructor Summary

Constructors

Constructor	Description
AbstractFormattedPlaceholderPopulator()

Method Summary

Modifier and Type	Method	Description
protected int	attachQuotedString(int index, StringBuilder builder, char[] formatArray)	Processes quoted string inside format array.
protected final boolean	isLetter(char ch)	Checks if provided character is a latin letter.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface IPlaceholderPopulator

populate

Field Details

APOSTROPHE

protected static final char APOSTROPHE

Escaping character.

See Also:

• Constant Field Values

ESCAPE_CHARACTER

private static final char ESCAPE_CHARACTER

See Also:

• Constant Field Values

A_UPPERCASE

private static final char A_UPPERCASE

See Also:

• Constant Field Values

Z_UPPERCASE

private static final char Z_UPPERCASE

See Also:

• Constant Field Values

A_LOWERCASE

private static final char A_LOWERCASE

See Also:

• Constant Field Values

Z_LOWERCASE

private static final char Z_LOWERCASE

See Also:

• Constant Field Values

Constructor Details

AbstractFormattedPlaceholderPopulator

AbstractFormattedPlaceholderPopulator()

Method Details

attachQuotedString

protected int attachQuotedString(int index,
 StringBuilder builder,
 char[] formatArray)

Processes quoted string inside format array. It is expected that provided index points to the apostrophe character so that since the index + 1 position quoted string starts.

String may contain escaped apostrophes \' which processed as characters. Backslash is used for escaping so you need double backslash to print it \\. All the rest backslashes (not followed by apostrophe or one more backslash) are simply ignored.

Parameters:

index - is a index of apostrophe starting a new quoted string

builder - is a StringBuilder building a resulting formatted string. It is updated by the method: quoted string is attached

formatArray - is a format representation

Returns:

index of the character after the closing apostrophe

Throws:

IllegalArgumentException - if there is no closing apostrophe

isLetter

protected final boolean isLetter(char ch)

Checks if provided character is a latin letter.

Parameters:

ch - is character to check

Returns:

true if character is a latin letter and false otherwise