com.igormaznitsa.jbbp.plugin.gradle

Class JBBPExtension

java.lang.Object

com.igormaznitsa.jbbp.plugin.gradle.JBBPExtension

public class JBBPExtension
extends java.lang.Object

JBBP extension settings.

Since:

1.3.0

Field Summary

Fields

Modifier and Type	Field and Description
boolean	addBinAnnotations Generate Bin annotations for fields
boolean	addGettersSetters Flag to generate getters and setters in result class, all fields will be protected ones.
boolean	addNewInstanceMethods Generate methods newInstance in generated classes.
java.lang.String	customText Text to be inserted into body of generated class.
java.io.File	customTextFile Text file which content will be injected into body of generated class.
java.util.Set<java.lang.String>	customTypes Allowed custom types for JBBP scripts.
boolean	disableGenerateFields Disable generate fields for target class.
boolean	doAbstract Make the result class as abstract one even if it doesn't have abstract methods.
boolean	doInternalClassesNonStatic Make inner clases non-static ones
static java.lang.String	EXT_NAME The Registered name of the extension.
java.lang.String	headComment Text to be placed in the head of generated class as comments.
java.io.File	headCommentFile Text file which content will be added into head of generated class as comments.
java.lang.String	inEncoding Encoding for text input.
java.util.Set<java.lang.String>	interfaces Interfaces to be implemented by the generated class.
java.util.Map<java.lang.String,java.lang.String>	mapSubClassInterfaces Interface names mapped to generated sub-classes, mapped interface will be used in getters instead of the sub-class type.
java.util.Map<java.lang.String,java.lang.String>	mapSubClassSuperclasses Superclasses to be mapped to generated sub-classes
java.lang.String	outEncoding Encoding for text output.
java.io.File	output Output folder for result classes.
java.lang.String	packageName Package name to override the package name extracted from JBBP script name.
java.util.Set<ParserFlags>	parserFlags Set of parser flags.
org.gradle.api.file.ConfigurableFileTree	source Source folder to find JBBP scripts.
java.lang.String	superClass Super-class for the generated class.
Target	target Target of translation.

Constructor Summary

Constructors

Constructor and Description
JBBPExtension(org.gradle.api.Project project)

Method Summary

Modifier and Type	Method and Description
void	prepare(org.gradle.api.Project project)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXT_NAME

public static final java.lang.String EXT_NAME

The Registered name of the extension.

See Also:

Constant Field Values

target

public Target target

Target of translation.

addGettersSetters

public boolean addGettersSetters

Flag to generate getters and setters in result class, all fields will be protected ones.

doAbstract

public boolean doAbstract

Make the result class as abstract one even if it doesn't have abstract methods.

interfaces

public java.util.Set<java.lang.String> interfaces

Interfaces to be implemented by the generated class.

parserFlags

public java.util.Set<ParserFlags> parserFlags

Set of parser flags.

customTypes

public java.util.Set<java.lang.String> customTypes

Allowed custom types for JBBP scripts.

mapSubClassInterfaces

public java.util.Map<java.lang.String,java.lang.String> mapSubClassInterfaces

Interface names mapped to generated sub-classes, mapped interface will be used in getters instead of the sub-class type.

mapSubClassSuperclasses

public java.util.Map<java.lang.String,java.lang.String> mapSubClassSuperclasses

Superclasses to be mapped to generated sub-classes

Since:

1.4.0

inEncoding

public java.lang.String inEncoding

Encoding for text input.

outEncoding

public java.lang.String outEncoding

Encoding for text output.

headComment

public java.lang.String headComment

Text to be placed in the head of generated class as comments.

headCommentFile

public java.io.File headCommentFile

Text file which content will be added into head of generated class as comments.

customText

public java.lang.String customText

Text to be inserted into body of generated class.

customTextFile

public java.io.File customTextFile

Text file which content will be injected into body of generated class.

superClass

public java.lang.String superClass

Super-class for the generated class.

packageName

public java.lang.String packageName

Package name to override the package name extracted from JBBP script name.

disableGenerateFields

public boolean disableGenerateFields

Disable generate fields for target class.

Since:

1.4.0

doInternalClassesNonStatic

public boolean doInternalClassesNonStatic

Make inner clases non-static ones

Since:

1.4.0

output

public java.io.File output

Output folder for result classes.

source

public org.gradle.api.file.ConfigurableFileTree source

Source folder to find JBBP scripts.

addNewInstanceMethods

public boolean addNewInstanceMethods

Generate methods newInstance in generated classes.

addBinAnnotations

public boolean addBinAnnotations

Generate Bin annotations for fields

Constructor Detail

JBBPExtension

public JBBPExtension(@Nonnull
                     org.gradle.api.Project project)

Method Detail

prepare

public void prepare(@Nonnull
                    org.gradle.api.Project project)