Class FieldUtils
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.interactive.form.FieldUtils
-
public final class FieldUtils extends java.lang.Object
A set of utility methods to help with common AcroForm form and field related functions.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) static class
FieldUtils.KeyValue
An implementation of a basic key value pair.(package private) static class
FieldUtils.KeyValueKeyComparator
Comparator to sort KeyValue by key.(package private) static class
FieldUtils.KeyValueValueComparator
Comparator to sort KeyValue by value.
-
Constructor Summary
Constructors Modifier Constructor Description private
FieldUtils()
Constructor.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description (package private) static java.util.List<java.lang.String>
getPairableItems(COSBase items, int pairIdx)
Return either one of a list which can have two-element arrays entries.(package private) static void
sortByKey(java.util.List<FieldUtils.KeyValue> pairs)
Sort two related lists simultaneously by the elements in the value parameter.(package private) static void
sortByValue(java.util.List<FieldUtils.KeyValue> pairs)
Sort two related lists simultaneously by the elements in the key parameter.(package private) static java.util.List<FieldUtils.KeyValue>
toKeyValueList(java.util.List<java.lang.String> key, java.util.List<java.lang.String> value)
Return two related lists as a single list with key value pairs.
-
-
-
Method Detail
-
toKeyValueList
static java.util.List<FieldUtils.KeyValue> toKeyValueList(java.util.List<java.lang.String> key, java.util.List<java.lang.String> value)
Return two related lists as a single list with key value pairs.- Parameters:
key
- the key elementsvalue
- the value elements- Returns:
- a sorted list of KeyValue elements.
-
sortByValue
static void sortByValue(java.util.List<FieldUtils.KeyValue> pairs)
Sort two related lists simultaneously by the elements in the key parameter.- Parameters:
pairs
- a list of KeyValue elements
-
sortByKey
static void sortByKey(java.util.List<FieldUtils.KeyValue> pairs)
Sort two related lists simultaneously by the elements in the value parameter.- Parameters:
pairs
- a list of KeyValue elements
-
getPairableItems
static java.util.List<java.lang.String> getPairableItems(COSBase items, int pairIdx)
Return either one of a list which can have two-element arrays entries.Some entries in a dictionary can either be an array of elements or an array of two-element arrays. This method will either return the elements in the array or in case of two-element arrays, the element designated by the pair index
An
IllegalArgumentException
will be thrown if the items contain two-element arrays and the index is not 0 or 1.- Parameters:
items
- the array of elements or two-element arrayspairIdx
- the index into the two-element array- Returns:
- a List of single elements
-
-