js.dom.EList Maven / Gradle / Ivy
package js.dom;
/**
* List of elements returned by elements finders. Instances of this interface are returned by findBy search methods
* from both document and elements. Search methods always returns instance of this interface, even if empty. User code may use
* {@link #isEmpty()} to detect if search actually find some elements.
*
* Beside standard iterable this interfaces has method for list size and indexed random access. Also provides generic method
* execution on all list elements.
*
* @author Iulian Rotaru
* @version final
*/
public interface EList extends Iterable {
/**
* Get this list size.
*
* @return this list size.
*/
int size();
/**
* Get element from index. Returns the element identified by given index or null if index is not valid.
*
* @param index element index relative to this list.
* @return element from requested index.
*/
Element item(int index);
/**
* Test if this list is empty.
*
* @return true if this elements list is empty.
*/
boolean isEmpty();
/**
* Remove all elements. Remove all elements from this list and also from owning document. After executing this method
* {@link #isEmpty} returns true and {@link #iterator} returns an empty iterator.
*/
void remove();
/**
* Execute specified method for every element from this list. Traverse all this elements list and execute requested method
* with given arguments. Ignore elements that does not own specified method.
*
* For example, find all li elements and add item CSS class.
*
*
* doc.findByTag("li").call("addCssClass", "item");
*
*
* @param methodName the name of element's method to be invoked,
* @param args optional runtime method arguments.
* @return this pointer.
*/
EList call(String methodName, Object... args);
}