ExcludedPathAddChange.java

/*
 * Copyright 2016 Nokia Solutions and Networks
 * Licensed under the Apache License, Version 2.0,
 * see license.txt file for details.
 */
package org.robotframework.ide.eclipse.main.plugin.refactoring;

import java.util.ArrayList;
import java.util.Collection;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.OperationCanceledException;
import org.eclipse.e4.core.services.events.IEventBroker;
import org.eclipse.ltk.core.refactoring.Change;
import org.eclipse.ltk.core.refactoring.RefactoringStatus;
import org.eclipse.ui.PlatformUI;
import org.rf.ide.core.project.RobotProjectConfig;
import org.rf.ide.core.project.RobotProjectConfig.ExcludedFolderPath;
import org.robotframework.ide.eclipse.main.plugin.project.RedProjectConfigEventData;
import org.robotframework.ide.eclipse.main.plugin.project.RobotProjectConfigEvents;

import com.google.common.annotations.VisibleForTesting;


/**
 * @author Michal Anglart
 *
 */
class ExcludedPathAddChange extends Change {

    private final IFile redXmlFile;

    private final ExcludedFolderPath excludedPathToAdd;

    private final RobotProjectConfig config;

    private final IEventBroker eventBroker;

    ExcludedPathAddChange(final IFile redXmlFile, final RobotProjectConfig config,
            final ExcludedFolderPath excludedPathToAdd) {
        this(redXmlFile, config, excludedPathToAdd,
                (IEventBroker) PlatformUI.getWorkbench().getService(IEventBroker.class));
    }

    @VisibleForTesting
    ExcludedPathAddChange(final IFile redXmlFile, final RobotProjectConfig config,
            final ExcludedFolderPath excludedPathToAdd, final IEventBroker eventBroker) {
        this.redXmlFile = redXmlFile;
        this.config = config;
        this.excludedPathToAdd = excludedPathToAdd;
        this.eventBroker = eventBroker;
    }

    @Override
    public String getName() {
        return "The path '" + excludedPathToAdd.getPath() + "' will be added";
    }

    @Override
    public void initializeValidationData(final IProgressMonitor pm) {
        // nothing to do currently
    }

    @Override
    public RefactoringStatus isValid(final IProgressMonitor pm) throws CoreException, OperationCanceledException {
        return new RefactoringStatus();
    }

    @Override
    public Change perform(final IProgressMonitor pm) throws CoreException {
        config.getExcludedPath().add(excludedPathToAdd);
        
        final Collection<IPath> changedPaths = new ArrayList<>();
        final RedProjectConfigEventData<Collection<IPath>> eventData = new RedProjectConfigEventData<>(
                redXmlFile, changedPaths);

        eventBroker.send(RobotProjectConfigEvents.ROBOT_CONFIG_VALIDATION_EXCLUSIONS_STRUCTURE_CHANGED, eventData);

        return new ExcludedPathRemoveChange(redXmlFile, config, excludedPathToAdd);
    }

    @Override
    public Object getModifiedElement() {
        return excludedPathToAdd;
    }
}