org.bytedeco.javacpp.annotation.Optional 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++

The newest version!

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.Pointer;
import org.bytedeco.javacpp.tools.Generator;

/**
 * A shorthand for {@code @Adapter("OptionalAdapter")}.
 * We can also define the {@code OPTIONAL_NAMESPACE} macro
 * to something like {@code boost} instead of the default {@code std}.
 *
 * @see Adapter
 * @see Generator
 *
 * @author Samuel Audet
 */
@Documented @Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.PARAMETER})
@Adapter("OptionalAdapter")
public @interface Optional {
    /** The template type of {@code OptionalAdapter}. If not specified, it is
     *  inferred from the value type of the {@link Pointer} or Java array. */
    String value() default "";
}