Class Collection

server/src/main/java/com/postman/collection/Collection.java:49–890

Encapsulates a Postman collection Postman SDK analog: Collection Ingest a collection file Collection myCollection = pmcFactory(new File("example-cat-facts-with-tests

 * <p><code>String myCode = preReq.getSourceCode();</code></p>
 */
public class Collection extends ItemGroup {


    private RequestAuth auth = null;
    private HashMap<String, String> info;
    private PropertyList<Property> variable = null;


    /**
     * Moves an item in the array of items contained by this collection from one parent to another.
     *
     * @param itemToMoveKey
     * @param parentKey
     * @throws InvalidCollectionActionException If either the parent or item to be moved aren't present in the <code>item</code> array
     */
    public void moveItem(String itemToMoveKey, String parentKey) throws RecursiveItemAddException, InvalidCollectionActionException {
        Item itemToMove = this.getItem(itemToMoveKey);
        Folder parent = this.getFolder(parentKey);

        if (itemToMove == null || parent == null) {
            throw new InvalidCollectionActionException("Attempt to move a null item, or an item to a null parent");
        }


        this.moveItem(itemToMove, parent);

    }


    /**
     * Convenience method to add an item with no child items to this collection.
     *
     * @param name The name for the new item
     * @throws RecursiveItemAddException
     * @throws IllegalPropertyAccessException
     */
    public Folder addFolder(String name) throws RecursiveItemAddException, IllegalPropertyAccessException {
        Folder newFolder = new Folder(name);
        this.addItem(newFolder);
        return newFolder;

    }

    /**
     * Convenience method to add an item with no child items to this collection.
     *
     * @param name The name for the new item
     * @throws RecursiveItemAddException
     * @throws IllegalPropertyAccessException
     */
    public Folder addFolder(String name, int index) throws RecursiveItemAddException, IllegalPropertyAccessException {
        Folder newFolder = new Folder(name);
        this.addItem(newFolder, index);
        return newFolder;

    }