org.jsimpledb.cli.func.SimpleCliFunction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsimpledb-cli Show documentation

JSimpleDB classes supporting command line interfaces.

The newest version!


/*
 * Copyright (C) 2015 Archie L. Cobbs. All rights reserved.
 */

package org.jsimpledb.cli.func;

import org.jsimpledb.cli.CliSession;
import org.jsimpledb.parse.ParseSession;
import org.jsimpledb.parse.expr.Value;
import org.jsimpledb.parse.func.SimpleFunction;

/**
 * CLI extension of {@link SimpleFunction}.
 */
public abstract class SimpleCliFunction extends SimpleFunction {

// Constructors

    /**
     * Constructor.
     *
     * @param name function name
     * @param minArgs minimum number of arguments (inclusive)
     * @param maxArgs maximum number of arguments (inclusive)
     */
    protected SimpleCliFunction(String name, int minArgs, int maxArgs) {
        super(name, minArgs, maxArgs);
    }

    @Override
    protected final Value apply(ParseSession session, Value[] params) {
        return this.apply((CliSession)session, params);
    }

    /**
     * Apply this function to the given values.
     *
     * @param session CLI session
     * @param params parsed parameters; will already be checked between {@link #getMinArgs} and {@link #getMaxArgs}
     * @return value returned by this function
     * @throws RuntimeException if there is an error
     */
    protected abstract Value apply(CliSession session, Value[] params);
}