Class ToCollectionConverter

  • All Implemented Interfaces:

    public class ToCollectionConverter
    extends Object
    implements Converter<Collection>

    The omnifaces.ToCollectionConverter is intented to convert submitted String values to a Java collection based on a delimiter. Additionally, it trims any whitespace around each delimited submitted value. This is useful for among others comma separated value inputs.


    This converter is available by converter ID omnifaces.ToCollectionConverter. Just specify it in the converter attribute of the component referring the Collection property. For example:

     <h:inputText value="#{bean.commaSeparatedValues}" converter="omnifaces.ToCollectionConverter" />

    The default delimiter is comma followed by space , and the default collection type is java.util.LinkedHashSet for a Set property and java.util.ArrayList for anything else, and the default converter for each item will in getAsString() be determined based on item type and in getAsObject() be determined based on generic return type of the getter method.

    You can use <o:converter> to specify those attributes. The delimiter must be a String, the collectionType must be a FQN and the itemConverter can be anything which is acceptable by Faces.createConverter(Object).

     <h:inputText value="#{bean.uniqueOrderedSemiColonSeparatedNumbers}">
         <o:converter converterId="omnifaces.ToCollectionConverter"
                      itemConverter="jakarta.faces.Integer" >
    Bauke Scholtz
    See Also:
    • Constructor Detail

      • ToCollectionConverter

        public ToCollectionConverter()
    • Method Detail

      • setDelimiter

        public void setDelimiter​(String delimiter)
        Sets the delimiter to split on.
        delimiter - The delimiter to split on.
      • setCollectionType

        public void setCollectionType​(String collectionType)
        Sets the FQN of the collection to create.
        collectionType - The FQN of the collection to create.
      • setItemConverter

        public void setItemConverter​(Object itemConverter)
        Sets the converter for the item.
        itemConverter - The converter for the item.