cn.wensiqun.asmsupport.standard.action.ArrayAction 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;


/**
 * The array action set.
 *
 *
 * @author wensiqun(at)163.com
 */
public interface ArrayAction<_P extends IParam> {
    

	/**
     * 
     * Make an empty array value according an array type and the length of each dimensions call this method is seem like to 
     * following java code :
     * 
     * 
     * 
     * 
     * new String[2][3][4];
     * 
     * 
     * Following code is the implement of preceding code :
     * 
     * newArray(AClassFactory.getArrayClass(String[][][].class), val(2), val(3), val(4));

     * 

	 * @param arraytype array value type. must be an array type
	 * @param allocateDims length of each dimensions
	 * @return {@link _P}
	 */
	_P makeArray(final AClass arraytype, final _P... allocateDims);
	
	/**
	 * Same to {@link #makeArray(AClass, _P...)}
	 * 
	 * 
	 * @param arraytype
	 * @param dimensions
	 * @return {@link _P}
	 */
	_P makeArray(Class arraytype, final _P... dimensions);

	/**
	 * 
     * 
     * Make an array value according an array type and an array value that element type is 
     * {@link cn.wensiqun.asmsupport.standard.def.IParam}, call this method is seem like to 
     * following java code :
     * 
     * 
     * 
     * new String[][]{{"00", "01"}, {"10", "11"}};
     * 
     * 
     * Following code is the implement of preceding code :
     *      * {@link _P}[][] values = {@link _P}[][]{
     *     {val("00"), val("01")},
     *     {val("10"), val("11")}
     * };
     * newarray(AClassFactory.getType(String[][].class), values);
     * 
	 * 
	 * @param arraytype array type you want to make. must be an array type
	 * @param arrayobject the array value that you want to assign.
	 * @return {@link _P}
	 * @see ActionSet#arrayvar(String, AClass, _P, _P...)
	 * @see #makeArray(AClass, _P...)
	 */
	_P newarray(AClass arraytype, final Object arrayobject);
	
	/**
	 * It's seem like {@link #newarray(AClass, Object)}
	 * 
	 * @param type
	 * @param arrayObject
	 * @return {@link _P}
	 */
	_P newarray(Class type, Object arrayObject);
    
    /**
     * 
     * 
     * Get array element according arguments. call this method is seem like to 
     * following java code :
     * 
     * 
     * 
     * String value = {{"[0][0]","[0][1]"},{"[1][0]","[1][1]"}}[0][1];
     * 
     * 
     * Following code is the implement of preceding code :
     * 
     * _arrayLoad(values, val(0), val(1));

     * 
     * 
     * 
     * @param arrayReference the array value reference.
     * @param pardim the first dimension index.
     * @param parDims other dimensions index array.
     * @return {@link _P}
     */
    _P arrayLoad(_P arrayReference, _P pardim, _P... parDims);
    

    /**
     * 
     * 
     * Set element value to array according argument. call this method is seem like to 
     * following java code :
     * 
     * 
     * 
     * {{"[0][0]","[0][1]"},{"[1][0]","[1][1]"}}[0][1]=100
     * 
     * 
     * Following code is the implement of preceding code :
     * 
     * _arrayStore(arrayValues, val(100), val(0), val(1))
     * 
     * 
     * @param arrayReference array reference
     * @param value the value it's you want save to array.
     * @param dim the first dimension index
     * @param dims the other dimensions indexs
     * @return {@link _P}
     */
    _P arrayStore(_P arrayReference, _P value, _P dim, _P... dims);
    
    
    /**
     * Get array length, call this method is seem like to 
     * following java code : 
     * 
     * 
     * {{"[0][0]","[0][1]"},{"[1][0]","[1][1]"}}[0].length;
     * 
     * 
     * Following code is the implement of preceding code :
     * 
     * _arrayLength(values, val(0))
     * 
     * 
     * 
     * @param arrayReference array reference
     * @param dims the dimensions index array that corresponding to each dimension
     * @return {@link _P}
     */
    _P arrayLength(_P arrayReference, _P... dims);
    

}