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


/**
 * 
 * Bit operations
 * 
 * @author wensiqun(at)163.com
 */
public interface BitwiseAction<_P extends IParam> {
	
    /**
     * 
     * 
     * ～leftFactor
     * 
     * 
     * @param factor
     * @return {@link _P}
     */
    _P reverse(_P factor);
    
    /**
     * The bit and operator.
     * 
     * 
     * leftFactor & rightFactor
     * 
     * 
     * @param leftFactor
     * @param rightFactor
     * @return {@link _P}
     */
    _P band(_P leftFactor, _P rightFactor);
	
    /**
     * 
     * The bit or operator, the following code is the sample :
     * 
     * 
     * leftFactor | rightFactor
     * 
     * 
     * @param leftFactor
     * @param rightFactor
     * @return {@link _P}
     */
    _P bor(_P leftFactor, _P rightFactor);
    
    /**
     * 
     * The xor operator, the following code is the sample.
     * 
     * 
     * leftFactor ^ rightFactor
     * 
     * 
     * 
     * @param leftFactor
     * @param rightFactor
     * @return {@link _P}
     */
    _P bxor(_P leftFactor, _P rightFactor);
    
    /**
     * 
     * The shift left operator.
     * 
     * 
     * leftFactor << rightFactor
     * 
     * 
     * @param leftFactor
     * @param rightFactor
     * @return {@link _P}
     */
    _P shl(_P leftFactor, _P rightFactor);
    
    /**
     * The bitwise shift right operator.
     * 
     * 
     * leftFactor >> rightFactor
     * 
     * 
     * @param leftFactor
     * @param rightFactor
     * @return {@link _P}
     */
    _P shr(_P leftFactor, _P rightFactor);
    
    /**
     * The unsigned shift right operator.
     * 
     * 
     * leftFactor >>> rightFactor
     * 
     * 
     * @param leftFactor
     * @param rightFactor
     * @return {@link _P}
     */
    _P ushr(_P leftFactor, _P rightFactor);
    
}