org.bytedeco.javacpp.annotation.Index Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javacpp Show documentation

The missing bridge between Java and native C++

There is a newer version: 1.5.11

package org.bytedeco.javacpp.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.bytedeco.javacpp.tools.Generator;

/**
 * Allows using method arguments to call {@code operator[]} in some circumstances.
 * For example, a call like {@code (*this)[i].foo(str)} could be accomplished with
 * {@code @Index native void foo(int i, String str)}.
 *
 * @see Generator
 *
 * @author Samuel Audet
 */
@Documented @Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface Index {
    /** The number of indices spread over the parameters, for multidimensional access. */
    int value() default 1;
    /** The name of a function to call instead of {@code operator[]}, for example, "at". */
    String function() default "";
}