com.marvelution.maven.components.migration.manager.phases.AbstractMigrationPhase Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maven-migration-manager Show documentation

Maven 2.x Plexus Migration Manager Component used by the maven-migrator-plugin

The newest version!

/*
 * Licensed to Marvelution under one or more contributor license 
 * agreements.  See the NOTICE file distributed with this work 
 * for additional information regarding copyright ownership.
 * Marvelution licenses this file to you 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 com.marvelution.maven.components.migration.manager.phases;

import org.codehaus.plexus.logging.AbstractLogEnabled;

import com.marvelution.maven.components.migration.manager.MigrationResult;
import com.marvelution.maven.components.migration.manager.configuration.MigrationDescriptor;
import com.marvelution.maven.components.migration.manager.environment.MigrationEnvironment;
import com.marvelution.maven.components.migration.manager.exception.MigrationExecutionException;
import com.marvelution.maven.components.migration.manager.exception.MigrationFailureException;

/**
 * Abstract {@link MigrationPhase} with default implementation of the {@link MigrationPhase} interface
 * 
 * @author Mark Rekveld
 */
public abstract class AbstractMigrationPhase extends AbstractLogEnabled implements MigrationPhase {

	/**
	 * {@inheritDoc}
	 */
	public MigrationResult simulate(final MigrationDescriptor descriptor, final MigrationEnvironment environment)
					throws MigrationExecutionException, MigrationFailureException {
		final MigrationResult result = execute(descriptor, environment);
		result.setResultCode(MigrationResult.SUCCESS);
		return result;
	}

	/**
	 * {@inheritDoc}
	 */
	public MigrationResult clean(final MigrationDescriptor descriptor, final MigrationEnvironment environment) {
		return getMigrationResultSuccess();
	}

	/**
	 * Getter for a {@link MigrationResult} with {@link MigrationResult#SUCCESS} as result code
	 * 
	 * @return {@link MigrationResult}
	 */
	protected MigrationResult getMigrationResultSuccess() {
		final MigrationResult result = new MigrationResult();
		result.setResultCode(MigrationResult.SUCCESS);
		return result;
	}
}