Package org.apache.commons.collections4.list

Class PredicatedList<E>

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>
    public class PredicatedList<E>
extends PredicatedCollection<E>
implements java.util.List<E>
    Decorates another List to validate that all additions match a specified predicate.

    This list exists to provide validation for the decorated list. It is normally created to decorate an empty list. If an object cannot be added to the list, an IllegalArgumentException is thrown.

    One usage would be to ensure that no null entries are added to the list. 

     
 List<String> list =
   PredicatedList.predicatedList(new ArrayList<String>(), PredicateUtils.notNullPredicate());

    This class is Serializable from Commons Collections 3.1.

    Since:
    3.0
    See Also:
    Serialized Form

    • Method Detail

      • predicatedList

        public static <T> PredicatedList<T> predicatedList​(java.util.List<T> list,
                                                   Predicate<? super T> predicate)
        Factory method to create a predicated (validating) list.

        If there are any elements already in the list being decorated, they are validated.

        Type Parameters:
        T - the type of the elements in the list
        Parameters:
        list - the list to decorate, must not be null
        predicate - the predicate to use for validation, must not be null
        Returns:
        a new predicated list
        Throws:
        java.lang.NullPointerException - if list or predicate is null
        java.lang.IllegalArgumentException - if the list contains invalid elements
        Since:
        4.0

      • equals

        public boolean equals​(java.lang.Object object)
        Specified by:
        equals in interface java.util.Collection<E>
        Specified by:
        equals in interface java.util.List<E>
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface java.util.Collection<E>
        Specified by:
        hashCode in interface java.util.List<E>
        Overrides:
        hashCode in class java.lang.Object

      • get

        public E get​(int index)
        Specified by:
        get in interface java.util.List<E>

      • indexOf

        public int indexOf​(java.lang.Object object)
        Specified by:
        indexOf in interface java.util.List<E>

      • lastIndexOf

        public int lastIndexOf​(java.lang.Object object)
        Specified by:
        lastIndexOf in interface java.util.List<E>

      • remove

        public E remove​(int index)
        Specified by:
        remove in interface java.util.List<E>

      • add

        public void add​(int index,
                E object)
        Specified by:
        add in interface java.util.List<E>

      • addAll

        public boolean addAll​(int index,
                      java.util.Collection<? extends E> coll)
        Specified by:
        addAll in interface java.util.List<E>

      • listIterator

        public java.util.ListIterator<E> listIterator()
        Specified by:
        listIterator in interface java.util.List<E>

      • listIterator

        public java.util.ListIterator<E> listIterator​(int i)
        Specified by:
        listIterator in interface java.util.List<E>

      • set

        public E set​(int index,
             E object)
        Specified by:
        set in interface java.util.List<E>

      • subList

        public java.util.List<E> subList​(int fromIndex,
                                 int toIndex)
        Specified by:
        subList in interface java.util.List<E>