nl.weeaboo.lua2.lib.ZeroArgFunction Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2009-2011 Luaj.org. All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
******************************************************************************/
package nl.weeaboo.lua2.lib;
import nl.weeaboo.lua2.io.LuaSerializable;
import nl.weeaboo.lua2.vm.LuaValue;
import nl.weeaboo.lua2.vm.Varargs;
/**
* Abstract base class for Java function implementations that take no arguments and return one value.
*
* Subclasses need only implement {@link LuaValue#call()} to complete this class, simplifying development. All
* other uses of {@link #call(LuaValue)}, {@link #invoke(Varargs)},etc, are routed through this method by this
* class.
*
* If one or more arguments are required, or variable argument or variable return values, then use one of the
* related function {@link OneArgFunction}, {@link TwoArgFunction}, {@link ThreeArgFunction}, or
* {@link VarArgFunction}.
*
* See {@link LibFunction} for more information on implementation libraries and library functions.
*
* @see #call()
* @see LibFunction
* @see OneArgFunction
* @see TwoArgFunction
* @see ThreeArgFunction
* @see VarArgFunction
*/
@LuaSerializable
public abstract class ZeroArgFunction extends LibFunction {
private static final long serialVersionUID = -4675605076010039321L;
/** Default constructor. */
public ZeroArgFunction() {
}
/**
* Constructor with specific environment
*
* @param env The environment to apply during constructon.
*/
public ZeroArgFunction(LuaValue env) {
this.env = env;
}
@Override
public abstract LuaValue call();
@Override
public final LuaValue call(LuaValue arg) {
return call();
}
@Override
public final LuaValue call(LuaValue arg1, LuaValue arg2) {
return call();
}
@Override
public final LuaValue call(LuaValue arg1, LuaValue arg2, LuaValue arg3) {
return call();
}
@Override
public final Varargs invoke(Varargs varargs) {
return call();
}
}