org.gradle.plugins.ide.api.PropertiesFileContentMerger 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 2012 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.api;

import groovy.lang.Closure;
import org.gradle.api.Action;
import org.gradle.api.Incubating;
import org.gradle.api.internal.ClosureBackedAction;
import org.gradle.api.internal.PropertiesTransformer;

import java.util.Properties;

/**
 * Models the generation/parsing/merging capabilities.
 * Adds properties-related hooks.
 * 
 * For examples see docs for {@link org.gradle.plugins.ide.eclipse.model.EclipseJdt} and others.
 */
public class PropertiesFileContentMerger extends FileContentMerger {

    private PropertiesTransformer transformer;

    public PropertiesFileContentMerger(PropertiesTransformer transformer) {
        this.transformer = transformer;
    }

    public PropertiesTransformer getTransformer() {
        return transformer;
    }

    public void setTransformer(PropertiesTransformer transformer) {
        this.transformer = transformer;
    }

    /**
     * Adds a closure to be called when the file has been created.
     * The {@link Properties} are passed to the closure as a parameter.
     * The closure can modify the Properties before they are written to the output file.
     * 

     * For examples see docs for {@link org.gradle.plugins.ide.eclipse.model.EclipseJdt} and others.
     *
     * @param closure The closure to execute when the Properties have been created.
     */
    public void withProperties(Closure closure) {
        withProperties(new ClosureBackedAction(closure, Closure.OWNER_FIRST));
    }

    /**
     * Adds an action to be called when the file has been created.
     * The {@link Properties} are passed to the action as a parameter.
     * The action can modify the Properties before they are written to the output file.
     * 
     * For examples see docs for {@link org.gradle.plugins.ide.eclipse.model.EclipseJdt} and others.
     *
     * @param action The action to execute when the Properties have been created.
     */
    @Incubating
    public void withProperties(Action action) {
        transformer.addAction(action);
    }
}