com.dataart.spreadsheetanalytics.api.model.CustomFunctionMeta Maven / Gradle / Ivy

Go to download
/*
Copyright 2015 DataArt Apps, Inc

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package com.dataart.spreadsheetanalytics.api.model;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import com.dataart.spreadsheetanalytics.engine.Functions;

/**
 * Marker interface for {@link ICustomFunction}s.
 * Must contain name of function and (optional) number of arguments.
 * Used in Custom Function scan process (in {@link Functions} class.
 */
@Target(TYPE)
@Retention(RUNTIME)
public @interface CustomFunctionMeta {

    /** Name of the custom function. */
    String value();

    /** Number of input arguments in case this is a static information. */
    int numberOfArguments() default 0;
}