DS_Iterable.java

/* --------------------------------------------------------- *
 *    __________    D E L T A S C R I P T                    *
 *   (_________()                                            *
 *    /  ===   /   - A fast, dynamic scripting language      *
 *   |  ==    |    - Version 4.13.11.0                       *
 *   /  ===   /    - Developed by Adam R. Nelson             *
 *  |  =  =  |     - 2011-2013                               *
 *  /  ===   /     - Distributed under GNU LGPL v3           *
 * (________()     - http://github.com/ar-nelson/deltascript *
 *                                                           *
 * --------------------------------------------------------- */

package com.sector91.delta.script.objects;

/**
 * <p>Any {@link DS_Object} that can be iterated over, including arrays,
 * collections, and streams.</p>
 * 
 * @author Adam R. Nelson
 * @version 4.13.11.0
 * @since 3.12.3.0
 */
public interface DS_Iterable extends DS_Object, Iterable<DS_Object>
{
    /**
     * <p>Dumps the entire contents of this iterable into a Java array</p>
     * 
     * @return A Java array containing the contents of this iterable.
     * @since 4.13.2.0
     */
    public DS_Object[] dumpToArray();
}