cn.wensiqun.asmsupport.standard.action.ActionSet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of asmsupport-standard Show documentation
This module is a standard apid definition of asmsupport, all implements of asmsupport will be following this standard api.
There is a newer version: 0.4.3
Show newest version
/**    
 *  Asmsupport is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU 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 Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see .
 */
package cn.wensiqun.asmsupport.standard.action;

import cn.wensiqun.asmsupport.standard.def.IParam;
import cn.wensiqun.asmsupport.standard.def.clazz.AClass;
import cn.wensiqun.asmsupport.standard.def.var.IFieldVar;
import cn.wensiqun.asmsupport.standard.def.var.IVar;

/**
 * 
 * The all action.
 * 
 * @author wensiqun(at)163.com
 *
 */
public interface ActionSet<
_P extends IParam,
_V extends IVar,
_F extends IFieldVar, 
_IF, _While, _DoWhile, _ForEach, _TRY, _SYN> 
extends 
ValueAction<_P>, 
AClassDefAction,
VariableAction<_P, _V>, 
MethodInvokeAction<_P, _F>, 
ArrayAction<_P>, 
ArithmeticAction<_P>, 
BitwiseAction<_P>, 
CrementAction<_P>,
RelationalAction<_P>, 
LogicalAction<_P>, 
CreateBlockAction<_IF, _While, _DoWhile, _ForEach, _TRY, _SYN> {

    /**
     * check cast object type, such as following code:
     * 
     * String cc1 = (String)cc;
     * 
     * 
     * Following code is the asmsupport code.
     * 
     * checkcast(cc_para, AClassFactory.defType(String.class));
     * 
     * 
     * 
     * @param obj
     *            original object
     * @param to
     *            the type need to check cast.
     * @return {@link _P}
     */
    _P checkcast(_P obj, AClass to);

    /**
     * check cast object type, such as following code:
     * 
     * String cc1 = (String)cc;
     * 
     * 
     * Following code is the asmsupport code.
     * 
     * checkcast(cc_para, AClassFactory.defType(String.class));
     * 
     * 
     * 
     * @param obj
     *            original object
     * @param to
     *            the type need to check cast.
     * @return
     */
    _P checkcast(_P cc, Class to);

    /**
     * the negative operator. following is example.
     * 
     * int negValue = -factor;
     * 
     * 
     * Following code is the asmsupport code.
     * 
     * neg(factor);
     * 
     * 
     * 
     * @param factor
     *            must a number.
     * @return {@link _P}
     */
    _P neg(_P factor);

    /**
     * The ternary operator in java.
     * 
     * String result = booleanValue ? "YES" : "NO"
     * ;
     * 
     * 
     * 
     * Following code is the asmsupport code.
     * 
     * ternary(booleanValueParameterized, Value.value("YES"),
     * Value.value("NO"));
     * 
     * 
     * 
     * @param exp1
     *            the expression result must be a boolean.
     * @param exp2
     * @param exp3
     * @return {@link _P}
     */
    _P ternary(_P exp1, _P exp2, _P exp3);

    /**
     * 
     * 
     * The string append operator. such as "A" + "B" + "C". if we want append
     * some string, can't use
     * {@link ArithmeticAction#add(_P, _P)} method, that
     * is different to write java code directly.
     * 
     * 
     * Following is the java sample.
     * 
     * String sayHello = "hello " + "world";
     * 
     * 
     * 
     * Following code is the asmsupport code.
     * 
     * stradd(Value.value("hello "), Value.value("world"));
     * 
     * 
     * @param par1
     * @param pars
     * @return
     */
    _P stradd(_P par1, _P... pars);

    /**
     * Generate the instanceof instruction.
     * 
     * 
     * boolean isString = object instanceof String;
     * 
     * 
     * Following code is the asmsupport code.
     * 
     * instanceOf(object, AClassFactory.defType(String.class));
     * 
     * 
     * 
     * @param obj
     * @param type
     * @return {@link _P}a boolean type Parameterized
     */
    _P instanceof_(_P obj, AClass type);

    /**
     * Generate the instanceof instruction, the method is same as
     * {@link #instanceof_(_P, AClass)}
     * 
     * @see #instanceof_(_P, AClass)
     * @param obj
     * @param type
     * @return
     */
    _P instanceof_(_P obj, Class type);

    /**
     * Corresponding to break statement in loop.
     * 
     */
    public void break_();

    /**
     * Corresponding to continue statement in loop.
     * 
     */
    public void continue_();

    /**
     * Throw an exception.
     * 
     * 
     * throw new RuntimeException()
     * 
     * 
     * Following code is the asmsupport code.
     * 
     * throwException(invokeConstructor(RuntimeException_ACLASS));
     * 
     * 
     * 
     * @param exception
     */
    public void throw_(_P exception);

    /**
     * Corresponding to return statement with no return value.
     * 
     */
    public void return_();

    /**
     * Corresponding to return statement with return value.
     * 
     * @param parame
     *            return value.
     * 
     */
    public void return_(_P parame);
}