Info (gradle-javacpp-plugin 1.0.11 API)

java.lang.Object
- org.bytedeco.javacpp.tools.Info

```
public class Info
extends java.lang.Object
```
Holds information useful to the Parser and associated with C++ identifiers. Info objects are meant to be added by the user to an InfoMap passed as argument to InfoMapper.map(InfoMap). A class inheriting from the latter becomes a kind of configuration file entirely written in Java.
For usage examples, one can refer to the source code of the default values defined in the initializer of InfoMap.defaults.

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String[]`	`annotations` Additional Java annotations that should prefix the identifiers on output.
`java.lang.String`	`base` Allows to override the base class of `pointerTypes`.
`boolean`	`cast` Annotates Java identifiers with @`Cast` containing C++ identifier names `cppNames`.
`java.lang.String[]`	`cppNames` A list of C++ identifiers, expressions, or header filenames to which this info is to be bound.
`java.lang.String`	`cppText` Replaces the code associated with the declaration of C++ identifiers, before parsing.
`java.lang.String[]`	`cppTypes` A list of C++ types to supply to or substitute from macros, templates, typedefs, etc.
`boolean`	`define` Indicates expressions of conditional macro groups to parse, or templates to specialize.
`boolean`	`enumerate` Maps native C++ `enum` classes to Java `enum` types, along with methods using them.
`boolean`	`flatten` Outputs declarations for this class into their subclasses as well.
`java.lang.String[]`	`javaNames` The Java identifiers to output corresponding to the C++ identifiers of `cppNames`.
`java.lang.String`	`javaText` Outputs the given code, instead of the result parsed from the declaration of C++ identifiers.
`java.lang.String[]`	`linePatterns` A list of regular expressions (start1, end1, start2, end2, ...) that are matched against lines in header files, where only the ones in between each pair are parsed (or not if `skip` is true).
`boolean`	`objectify` Map global functions to instance methods, without `static` modifier, to implement an interface, etc.
`java.lang.String[]`	`pointerTypes` A list of (usually) `Pointer` Java subclasses to be used to map C++ pointer types.
`boolean`	`purify` Forces a class to be treated as if it were abstract.
`boolean`	`skip` Skips entirely all the code associated with the C++ identifiers, expressions, or header filenames.
`boolean`	`skipDefaults` Ignores default function arguments to avoid ambiguous C++ function calls.
`boolean`	`translate` Attempts to translate naively the statements of variable-like macros to Java.
`java.lang.String[]`	`valueTypes` A list of (usually) primitive Java types to be used to map C++ value types.
`boolean`	`virtualize` Annotates virtual functions with @`Virtual` and adds appropriate constructors.

Constructor Summary

Constructors
Constructor and Description

Info()

Info(Info i)

Info(java.lang.String... cppNames)

Constructors
Constructor and Description
`Info()`
`Info(Info i)`
`Info(java.lang.String... cppNames)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Info`	`annotations(java.lang.String... annotations)`
`Info`	`base(java.lang.String base)`
`Info`	`cast()`
`Info`	`cast(boolean cast)`
`Info`	`cppNames(java.lang.String... cppNames)`
`Info`	`cppText(java.lang.String cppText)`
`Info`	`cppTypes(java.lang.String... cppTypes)`
`Info`	`define()`
`Info`	`define(boolean define)`
`Info`	`enumerate()`
`Info`	`enumerate(boolean enumerate)`
`Info`	`flatten()`
`Info`	`flatten(boolean flatten)`
`Info`	`javaNames(java.lang.String... javaNames)`
`Info`	`javaText(java.lang.String javaText)`
`Info`	`linePatterns(java.lang.String... linePatterns)`
`Info`	`objectify()`
`Info`	`objectify(boolean objectify)`
`Info`	`pointerTypes(java.lang.String... pointerTypes)`
`Info`	`purify()`
`Info`	`purify(boolean purify)`
`Info`	`skip()`
`Info`	`skip(boolean skip)`
`Info`	`skipDefaults()`
`Info`	`skipDefaults(boolean skipDefaults)`
`Info`	`translate()`
`Info`	`translate(boolean translate)`
`Info`	`valueTypes(java.lang.String... valueTypes)`
`Info`	`virtualize()`
`Info`	`virtualize(boolean virtualize)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - cppNames
```
public java.lang.String[] cppNames
```
    A list of C++ identifiers, expressions, or header filenames to which this info is to be bound. Usually set via the constructor parameter of Info(String...).
  - javaNames
```
public java.lang.String[] javaNames
```
    The Java identifiers to output corresponding to the C++ identifiers of cppNames. By default, the names of C++ identifiers cppNames are used.
  - annotations
```
public java.lang.String[] annotations
```
    Additional Java annotations that should prefix the identifiers on output.
  - cppTypes
```
public java.lang.String[] cppTypes
```
    A list of C++ types to supply to or substitute from macros, templates, typedefs, etc. By default, identifiers with missing type information are skipped, except for variable-like macros for which the type is guessed based on the expression.
  - valueTypes
```
public java.lang.String[] valueTypes
```
    A list of (usually) primitive Java types to be used to map C++ value types. By default, pointerTypes prefixed with @ByVal are used.
  - pointerTypes
```
public java.lang.String[] pointerTypes
```
    A list of (usually) Pointer Java subclasses to be used to map C++ pointer types. By default, the names of the C++ types cppNames are used.
  - linePatterns
```
public java.lang.String[] linePatterns
```
    A list of regular expressions (start1, end1, start2, end2, ...) that are matched against lines in header files, where only the ones in between each pair are parsed (or not if skip is true).
  - cast
```
public boolean cast
```
    Annotates Java identifiers with @Cast containing C++ identifier names cppNames.
  - define
```
public boolean define
```
    Indicates expressions of conditional macro groups to parse, or templates to specialize.
  - enumerate
```
public boolean enumerate
```
    Maps native C++ enum classes to Java enum types, along with methods using them. To use as keys in maps, etc, intern() must be called on instances returned from native code.
  - flatten
```
public boolean flatten
```
    Outputs declarations for this class into their subclasses as well. Also adds methods for explicit casting, as done for multiple inheritance by default.
  - objectify
```
public boolean objectify
```
    Map global functions to instance methods, without static modifier, to implement an interface, etc.
  - translate
```
public boolean translate
```
    Attempts to translate naively the statements of variable-like macros to Java.
  - skip
```
public boolean skip
```
    Skips entirely all the code associated with the C++ identifiers, expressions, or header filenames. Unless more Info is provided...
  - skipDefaults
```
public boolean skipDefaults
```
    Ignores default function arguments to avoid ambiguous C++ function calls.
  - purify
```
public boolean purify
```
    Forces a class to be treated as if it were abstract.
  - virtualize
```
public boolean virtualize
```
    Annotates virtual functions with @Virtual and adds appropriate constructors.
  - base
```
public java.lang.String base
```
    Allows to override the base class of pointerTypes. Defaults to Pointer.
  - cppText
```
public java.lang.String cppText
```
    Replaces the code associated with the declaration of C++ identifiers, before parsing.
  - javaText
```
public java.lang.String javaText
```
    Outputs the given code, instead of the result parsed from the declaration of C++ identifiers.
- Constructor Detail
  - Info
```
public Info()
```
  - Info
```
public Info(java.lang.String... cppNames)
```
  - Info
```
public Info(Info i)
```
- Method Detail
  - cppNames
```
public Info cppNames(java.lang.String... cppNames)
```
  - javaNames
```
public Info javaNames(java.lang.String... javaNames)
```
  - annotations
```
public Info annotations(java.lang.String... annotations)
```
  - cppTypes
```
public Info cppTypes(java.lang.String... cppTypes)
```
  - valueTypes
```
public Info valueTypes(java.lang.String... valueTypes)
```
  - pointerTypes
```
public Info pointerTypes(java.lang.String... pointerTypes)
```
  - linePatterns
```
public Info linePatterns(java.lang.String... linePatterns)
```
  - cast
```
public Info cast()
```
  - cast
```
public Info cast(boolean cast)
```
  - define
```
public Info define()
```
  - define
```
public Info define(boolean define)
```
  - enumerate
```
public Info enumerate()
```
  - enumerate
```
public Info enumerate(boolean enumerate)
```
  - flatten
```
public Info flatten()
```
  - flatten
```
public Info flatten(boolean flatten)
```
  - objectify
```
public Info objectify()
```
  - objectify
```
public Info objectify(boolean objectify)
```
  - translate
```
public Info translate()
```
  - translate
```
public Info translate(boolean translate)
```
  - skip
```
public Info skip()
```
  - skip
```
public Info skip(boolean skip)
```
  - skipDefaults
```
public Info skipDefaults()
```
  - skipDefaults
```
public Info skipDefaults(boolean skipDefaults)
```
  - purify
```
public Info purify()
```
  - purify
```
public Info purify(boolean purify)
```
  - virtualize
```
public Info virtualize()
```
  - virtualize
```
public Info virtualize(boolean virtualize)
```
  - base
```
public Info base(java.lang.String base)
```
  - cppText
```
public Info cppText(java.lang.String cppText)
```
  - javaText
```
public Info javaText(java.lang.String javaText)
```

Class Info

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cppNames

javaNames

annotations

cppTypes

valueTypes

pointerTypes

linePatterns

cast

define

enumerate

flatten

objectify

translate

skip

skipDefaults

purify

virtualize

base

cppText

javaText

Constructor Detail

Info

Info

Info

Method Detail

cppNames

javaNames

annotations

cppTypes

valueTypes

pointerTypes

linePatterns

cast

cast

define

define

enumerate

enumerate

flatten

flatten

objectify

objectify

translate

translate

skip

skip

skipDefaults

skipDefaults

purify

purify

virtualize

virtualize

base

cppText

javaText