org.web3j.gradle.plugin.Web3jExtension Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of web3j-gradle-plugin Show documentation

Gradle plugin providing tasks to generate web3j contracts from Solidity.

There is a newer version: 4.6.0

package org.web3j.gradle.plugin;

import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

import org.gradle.api.Project;

/**
 * web3j extension for plugin configuration.
 */
public class Web3jExtension {

    /**
     * Extension name used in Gradle build files.
     */
    static final String NAME = "web3j";

    private static final String DEFAULT_GENERATED_PACKAGE = "org.web3j.model";

    /**
     * Generated package name for web3j contract wrappers.
     * Accepts a {@link java.text.MessageFormat} string
     * with a unique parameter (i.e. {0} ), formatted as
     * the contract name in lower case.
     */
    private String generatedPackageName;

    /**
     * Base directory for generated Java files.
     */
    private String generatedFilesBaseDir;

    /**
     * Generate smart contract wrappers using native Java types.
     */
    private Boolean useNativeJavaTypes;

    /**
     * Excluded contract names from wrapper generation.
     */
    private List excludedContracts;

    public String getGeneratedPackageName() {
        return generatedPackageName;
    }

    public void setGeneratedPackageName(final String generatedPackageName) {
        Objects.requireNonNull(generatedPackageName);
        this.generatedPackageName = generatedPackageName;
    }

    public String getGeneratedFilesBaseDir() {
        return generatedFilesBaseDir;
    }

    public void setGeneratedFilesBaseDir(final String generatedFilesBaseDir) {
        Objects.requireNonNull(generatedFilesBaseDir);
        this.generatedFilesBaseDir = generatedFilesBaseDir;
    }

    public Boolean getUseNativeJavaTypes() {
        return useNativeJavaTypes;
    }

    public void setUseNativeJavaTypes(final Boolean useNativeJavaTypes) {
        this.useNativeJavaTypes = useNativeJavaTypes;
    }

    public List getExcludedContracts() {
        return excludedContracts;
    }

    public void setExcludedContracts(final List excludedContracts) {
        this.excludedContracts = excludedContracts;
    }

    public Web3jExtension(final Project project) {
        generatedFilesBaseDir = project.getBuildDir().getAbsolutePath()
                + "/generated/source/web3j";

        // Use the project's group name in generated package
        final String projectGroup = project.getGroup().toString();
        if (!projectGroup.isEmpty()) {
            generatedPackageName = projectGroup + ".web3j";
        } else {
            generatedPackageName = DEFAULT_GENERATED_PACKAGE;
        }

        useNativeJavaTypes = true;
        excludedContracts = new ArrayList<>();
    }

}