org.bytedeco.javacpp.annotation

Annotation Type ValueSetter

@Documented
 @Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface ValueSetter

An annotation indicating that a method should behave like a value setter. However, a pair of methods named get() and put(), where the number of parameters are either equal, in the case of arrays, or differs by one where the type of the extra parameter is the same as the return value of the other, and the remaining return value types are void or of the enclosing class, are recognized as a value getter/setter pair even without annotation. This behavior can be changed by annotating the methods with the Function annotation.

A value setter must return no value, or an object of its own Class, while its number of parameters must be greater than 0. The assigned value is assumed to come from pointer dereference, but anything that follows the same syntax as the assignment of a dereferenced pointer could potentially work with this annotation. All but the last argument are considered as indices to access a value array.

Author:

Samuel Audet

See Also:

Generator