org.gradle.plugins.ide.idea.GenerateIdeaModule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
There is a newer version: 8.11.1
/*
 * Copyright 2010 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.gradle.plugins.ide.idea;

import org.gradle.api.tasks.Internal;
import org.gradle.internal.xml.XmlTransformer;
import org.gradle.plugins.ide.api.XmlGeneratorTask;
import org.gradle.plugins.ide.idea.model.IdeaModule;
import org.gradle.plugins.ide.idea.model.Module;

import javax.inject.Inject;
import java.io.File;

/**
 * Generates an IDEA module file. If you want to fine tune the idea configuration
 * 
 * Please refer to interesting examples on idea configuration in {@link IdeaModule}.
 * 

 * At this moment nearly all configuration is done via {@link IdeaModule}.
 */
public class GenerateIdeaModule extends XmlGeneratorTask {

    private IdeaModule module;

    public GenerateIdeaModule() {}

    @Inject
    public GenerateIdeaModule(IdeaModule module) {
        this.module = module;
    }

    @Override
    protected Module create() {
        return new Module(getXmlTransformer(), module.getPathFactory());
    }

    @Override
    protected void configure(Module xmlModule) {
        getModule().mergeXmlModule(xmlModule);
    }

    @Override
    public XmlTransformer getXmlTransformer() {
        if (module == null) {
            return super.getXmlTransformer();
        }
        return module.getIml().getXmlTransformer();
    }

    /**
     * Configures output *.iml file. It's optional because the task should configure it correctly for you (including making sure it is unique in the multi-module build). If you really need to
     * change the output file name it is much easier to do it via the idea.module.name property.  Please refer to documentation in {@link IdeaModule} name property. In IntelliJ IDEA
     * the module name is the same as the name of the *.iml file.
     */
    public File getOutputFile() {
        if (module == null) {
            return super.getOutputFile();
        }
        return module.getOutputFile();
    }

    public void setOutputFile(File newOutputFile) {
        module.setOutputFile(newOutputFile);
    }

    /**
     * The Idea module model containing the details required to generate the module file.
     */
    @Internal
    public IdeaModule getModule() {
        return module;
    }

    public void setModule(IdeaModule module) {
        this.module = module;
    }

}