Skip navigation links
com.groupdocs.assembly

Class DocumentTableCollection

  • java.lang.Object
    • com.groupdocs.assembly.DocumentTableCollection
  • All Implemented Interfaces:
    java.lang.Iterable

    public class DocumentTableCollection
extends java.lang.Object
implements java.lang.Iterable
    Represents a read-only collection of DocumentTable objects of a particular DocumentTableSet instance. The collection is filled automatically while loading the corresponding tables from a document and can not be modified. However, properties of DocumentTable objects contained within the collection can be modified.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean contains(DocumentTable table)
      Returns a value indicating whether this collection contains the specified table.
      boolean contains(java.lang.String name)
      Returns a value indicating whether this collection contains a table with the specified name.
      DocumentTable get(int index)
      Gets a DocumentTable instance from the collection at the specified index.
      DocumentTable get(java.lang.String name)
      Gets a DocumentTable instance with the specified name from the collection.
      int getCount()
      Gets the total number of DocumentTable objects in the collection.
      int indexOf(DocumentTable table)
      Returns the index of the specified table within this collection.
      int indexOf(java.lang.String name)
      Returns the index of a table with the specified name within this collection.
      java.util.Iterator iterator()
      Returns an enumerator to iterate DocumentTable objects of this collection.

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

    • Method Detail

      • iterator

        public java.util.Iterator iterator()
        Returns an enumerator to iterate DocumentTable objects of this collection.
        Specified by:
        iterator in interface java.lang.Iterable
        Returns:
        An enumerator to iterate DocumentTable objects of this collection.

      • contains

        public boolean contains(java.lang.String name)
        Returns a value indicating whether this collection contains a table with the specified name.
        Parameters:
        name - The case-insensitive name of a table to look for.
        Returns:
        A value indicating whether this collection contains a table with the specified name.

      • contains

        public boolean contains(DocumentTable table)
        Returns a value indicating whether this collection contains the specified table.
        Parameters:
        table - A table to look for.
        Returns:
        A value indicating whether this collection contains the specified table.

      • indexOf

        public int indexOf(java.lang.String name)
        Returns the index of a table with the specified name within this collection.
        Parameters:
        name - The case-insensitive name of a table to find.
        Returns:
        The zero-based index of a table with the specified name, or -1 if the table does not exist in this collection.

      • indexOf

        public int indexOf(DocumentTable table)
        Returns the index of the specified table within this collection.
        Parameters:
        table - A table to find.
        Returns:
        The zero-based index of the specified table, or -1 if the table does not exist in this collection.

      • get

        public DocumentTable get(int index)
        Gets a DocumentTable instance from the collection at the specified index.
        Parameters:
        index - The zero-based index of the table to return.
        Returns:
        A DocumentTable instance from the collection at the specified index.

      • get

        public DocumentTable get(java.lang.String name)
        Gets a DocumentTable instance with the specified name from the collection.
        Parameters:
        name - The case-insensitive name of the table to return.
        Returns:
        A DocumentTable instance with the specified name from the collection or null if such an instance does not exist.

      • getCount

        public int getCount()
        Gets the total number of DocumentTable objects in the collection.
        Returns:
        The total number of DocumentTable objects in the collection.