org.eclipse.sirius.common.tools.api.resource.ResourceMigrationMarker.java Source code

Introduction

Here is the source code for org.eclipse.sirius.common.tools.api.resource.ResourceMigrationMarker.java

Source

/*******************************************************************************
 * Copyright (c) 2014 Obeo.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Obeo - initial API and implementation
 *******************************************************************************/
package org.eclipse.sirius.common.tools.api.resource;

import org.eclipse.emf.common.notify.impl.AdapterImpl;
import org.eclipse.emf.ecore.resource.Resource;

import com.google.common.base.Predicates;
import com.google.common.collect.Iterables;
import com.google.common.collect.Iterators;

/**
 * Utility class used to mark a {@link Resource} as having been migrated. A
 * {@link Resource} having such a marker *might* have been processed by a
 * migration logic during its loading and hence have some changes pendings from
 * a serialization point of view.
 * 
 * This class should be used when an adopter wants the runtime to consider this
 * resource as "potentially changed" even if no logical change has been made on
 * the model.
 * 
 * @author cedric
 */
public class ResourceMigrationMarker extends AdapterImpl {
    /**
     * Add a marker on an existing resource if it is not already there.
     * 
     * @param res
     *            resource to mark.
     */
    public static void addMigrationMarker(Resource res) {
        if (!hasMigrationMarker(res)) {
            res.eAdapters().add(new ResourceMigrationMarker());
        }
    }

    /**
     * Clear the {@link ResourceMigrationMarker} from the resource.
     * 
     * @param res
     *            resource to clear.
     */
    public static void clearMigrationMarker(Resource res) {
        Iterables.removeIf(res.eAdapters(), Predicates.instanceOf(ResourceMigrationMarker.class));
    }

    /**
     * Return true if the {@link Resource} has a migration marker.
     * 
     * @param res
     *            resource to test.
     * @return true if the {@link Resource} has a migration marker.
     */
    public static boolean hasMigrationMarker(Resource res) {
        return Iterators.any(res.eAdapters().iterator(), Predicates.instanceOf(ResourceMigrationMarker.class));
    }
}