net.sourceforge.jenesis4java.For Maven / Gradle / Ivy

Go to download
package net.sourceforge.jenesis4java;

/*
 * #%L
 * Jenesis 4 Java Code Generator
 * %%
 * Copyright (C) 2000 - 2015 jenesis4java
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import java.util.List;

/**
 * Copyright (C) 2008, 2010 Richard van Nieuwenhoven - ritchie [at] gmx [dot] at
 * Copyright (C) 2000, 2001 Paul Cody Johnston - [email protected] 

 * This file is part of Jenesis4java. Jenesis4java is free software: you can
 * redistribute it and/or modify it under the terms of the GNU Lesser General
 * Public License as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.

 * Jenesis4java is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.

 * You should have received a copy of the GNU Lesser General Public License
 * along with Jenesis4java. If not, see .
 */
/**
 * {@code Statement} subinterface for the {@code for} construct. It has an
 * declaration statement, a conditional statement, and an update statement (all
 * of which are optional).
 */
public interface For extends ConditionalStatement {

    /**
     * Adds this statement expression to the comma separated list of
     * initialization expressions.
     */
    For addInit(Expression expr);

    /**
     * Adds this declaration statement to the list of updates.
     */
    For addUpdate(Expression update);

    /**
     * Gets the comma separated list of initialzers from this for statement as
     * an List of {@code Expression} OR a single {@code Let} object (depending
     * on how it was defined). One need check the RTTI to be sure.
     */
    List getInits();

    /**
     * Gets the comma separated list of updates from this for statement as an
     * List of {@code Expression}.
     */
    List getUpdates();

    /**
     * Sets this declaration statement to a {@code Let} statement with the given
     * {@code Type}. If any initialization expressions have previously been
     * added through the {@code addInit(Expression)} method, they will all be
     * overwritten. This is because the Java Language Specification allows the
     * initialization section of the for statement to be a {@code Let}
     * expression.
     */
    Let setInit(Type type);
}