Interface IList

  • All Superinterfaces:
    com4j.Com4jObject, java.lang.Iterable<com4j.Com4jObject>
    All Known Subinterfaces:
    IFactoryList, IHierarchySupportList

    public interface IList
    extends com4j.Com4jObject, java.lang.Iterable<com4j.Com4jObject>
    Services to create and maintain lists. Use any factory object to create any number of list instances for objects in the factory.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void add​(java.lang.Object vNew)
      Adds a new item to the current list object.
      int count()
      The number of items in the list.
      void insert​(int pos, java.lang.Object vNew)
      Inserts a new item at the specified position.
      java.lang.Object item​(int index)
      Gets an item by index.
      java.util.Iterator<com4j.Com4jObject> iterator()
      Gets an IEnumVARIANT enumerator.
      void remove​(int index)
      Removes the specified item from the current list object.
      void swap​(int pos1, int pos2)
      Swaps the two list items specified by their positions.
      • Methods inherited from interface com4j.Com4jObject

        advise, dispose, equals, getComThread, getIUnknownPointer, getPointer, getPtr, hashCode, is, queryInterface, setName, toString
      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator
    • Method Detail

      • count

        int count()

        The number of items in the list.

        Getter method for the COM property "Count"

        Returns:
        Returns a value of type int
      • add

        void add​(java.lang.Object vNew)

        Adds a new item to the current list object.

        Parameters:
        vNew - Mandatory java.lang.Object parameter.
      • remove

        void remove​(int index)

        Removes the specified item from the current list object.

        Parameters:
        index - Mandatory int parameter.
      • item

        java.lang.Object item​(int index)

        Gets an item by index. The index is one-based.

        Getter method for the COM property "Item"

        Parameters:
        index - Mandatory int parameter.
        Returns:
        Returns a value of type java.lang.Object
      • iterator

        java.util.Iterator<com4j.Com4jObject> iterator()

        Gets an IEnumVARIANT enumerator. For information on the IEnumVARIANT, see Microsoft documentation.

        Getter method for the COM property "_NewEnum"

        Specified by:
        iterator in interface java.lang.Iterable<com4j.Com4jObject>
      • insert

        void insert​(int pos,
                    java.lang.Object vNew)

        Inserts a new item at the specified position.

        Parameters:
        pos - Mandatory int parameter.
        vNew - Mandatory java.lang.Object parameter.
      • swap

        void swap​(int pos1,
                  int pos2)

        Swaps the two list items specified by their positions.

        Parameters:
        pos1 - Mandatory int parameter.
        pos2 - Mandatory int parameter.