org.gradle.plugins.ide.idea.model.IdeaModel Maven / Gradle / Ivy
/*
* Copyright 2011 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.model;
import com.google.common.base.Preconditions;
import groovy.lang.Closure;
import org.gradle.api.Action;
import java.io.File;
import java.util.Map;
import static org.gradle.util.ConfigureUtil.configure;
/**
* DSL-friendly model of the IDEA project information.
* First point of entry when it comes to customizing the IDEA generation.
*
* See the examples in docs for {@link IdeaModule} or {@link IdeaProject}.
*/
public class IdeaModel {
private IdeaModule module;
private IdeaProject project;
private IdeaWorkspace workspace = new IdeaWorkspace();
private String targetVersion;
/**
* Configures IDEA module information.
For examples see docs for {@link IdeaModule}.
*/
public IdeaModule getModule() {
return module;
}
public void setModule(IdeaModule module) {
this.module = module;
}
/**
* Configures IDEA project information.
For examples see docs for {@link IdeaProject}.
*/
public IdeaProject getProject() {
return project;
}
public void setProject(IdeaProject project) {
this.project = project;
}
/**
* Configures IDEA workspace information.
*
* For examples see docs for {@link IdeaWorkspace}.
*/
public IdeaWorkspace getWorkspace() {
return workspace;
}
public void setWorkspace(IdeaWorkspace workspace) {
this.workspace = workspace;
}
/**
* Configures the target IDEA version.
*/
public String getTargetVersion() {
return targetVersion;
}
public void setTargetVersion(String targetVersion) {
this.targetVersion = targetVersion;
}
/**
* Configures IDEA module information.
For examples see docs for {@link IdeaModule}.
*/
public void module(Closure closure) {
configure(closure, getModule());
}
/**
* Configures IDEA module information.
For examples see docs for {@link IdeaModule}.
* @since 3.5
*/
public void module(Action super IdeaModule> action) {
action.execute(getModule());
}
/**
* Configures IDEA project information.
For examples see docs for {@link IdeaProject}.
*/
public void project(Closure closure) {
configure(closure, getProject());
}
/**
* Configures IDEA project information.
For examples see docs for {@link IdeaProject}.
* @since 3.5
*/
public void project(Action super IdeaProject> action) {
action.execute(getProject());
}
/**
* Configures IDEA workspace information.
For examples see docs for {@link IdeaWorkspace}.
*/
public void workspace(Closure closure) {
configure(closure, getWorkspace());
}
/**
* Configures IDEA workspace information.
For examples see docs for {@link IdeaWorkspace}.
* @since 3.5
*/
public void workspace(Action super IdeaWorkspace> action) {
action.execute(getWorkspace());
}
/**
* Adds path variables to be used for replacing absolute paths in resulting files (*.iml, etc.).
For example see docs for {@link IdeaModule}.
*
* @param pathVariables A map with String->File pairs.
*/
public void pathVariables(Map pathVariables) {
Preconditions.checkNotNull(pathVariables);
module.getPathVariables().putAll(pathVariables);
}
}