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;
/**
* An annotation indicating that a method should behave like an array allocator.
* However, methods with signature {@code native void allocateArray(int)} are
* recognized as array allocators even without annotation. This behavior can be
* changed by annotating the method with the {@link Function} annotation.
* <p>
* In a nutshell, an array allocator uses the C++ {@code new[]} operator, and
* initializes the {@link Pointer#address} as well as the {@link Pointer#deallocator}
* with {@code NativeDeallocator}, based on the {@code delete[]} operator, if
* not additionally annotated with {@link NoDeallocator}.
*
* @see Pointer#init(long, long, long, long)
* @see Generator
*
* @author Samuel Audet
*/
@Documented @Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface ArrayAllocator { }