IndicatePresenceOfBackupPomsPhase.java

/*
 * Copyright (C) 2016 Ronald Jack Jenkins Jr.
 *
 * 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 info.ronjenkins.maven.rtr.releasephases;

import info.ronjenkins.maven.rtr.RTR;

import java.util.List;

import org.apache.maven.AbstractMavenLifecycleParticipant;
import org.apache.maven.project.MavenProject;
import org.apache.maven.shared.release.ReleaseExecutionException;
import org.apache.maven.shared.release.ReleaseFailureException;
import org.apache.maven.shared.release.ReleaseResult;
import org.apache.maven.shared.release.config.ReleaseDescriptor;
import org.apache.maven.shared.release.env.ReleaseEnvironment;
import org.apache.maven.shared.release.phase.AbstractReleasePhase;
import org.apache.maven.shared.release.phase.ReleasePhase;
import org.codehaus.plexus.component.annotations.Component;
import org.codehaus.plexus.component.annotations.Requirement;

/**
 * Indicates to the Smart Reactor that the backup POMs have been created
 * successfully.
 *
 * @author Ronald Jack Jenkins Jr.
 * @see DefensiveRestoreBackupPomsPhase
 * @see RemoveBackupPomsPhase
 */
@Component(role = ReleasePhase.class, hint = "indicate-presence-of-backup-poms")
public class IndicatePresenceOfBackupPomsPhase extends AbstractReleasePhase {
  @Requirement(role = AbstractMavenLifecycleParticipant.class, hint = "rtr")
  private RTR rtr;

  /**
   * Indicates to the Smart Reactor that the backup POMs have been created
   * successfully.
   *
   * @param rd
   *          not null.
   * @param re
   *          not null.
   * @param projects
   *          not null.
   * @return the result of the phase execution.
   * @throws ReleaseExecutionException
   *           as needed.
   * @throws ReleaseFailureException
   *           as needed.
   */
  @Override
  public ReleaseResult execute(final ReleaseDescriptor rd,
      final ReleaseEnvironment re, final List<MavenProject> projects)
      throws ReleaseExecutionException, ReleaseFailureException {
    this.rtr.setBackupPomsCreated(true);
    final ReleaseResult result = new ReleaseResult();
    result.setResultCode(ReleaseResult.SUCCESS);
    return result;
  }

  /**
   * Invokes the {@link #execute(ReleaseDescriptor, ReleaseEnvironment, List)
   * execute} method.
   *
   * @param rd
   *          not null.
   * @param re
   *          not null.
   * @param projects
   *          not null.
   * @return the result of the phase execution.
   * @throws ReleaseExecutionException
   *           as needed.
   * @throws ReleaseFailureException
   *           as needed.
   */
  @Override
  public ReleaseResult simulate(final ReleaseDescriptor rd,
      final ReleaseEnvironment re, final List<MavenProject> projects)
      throws ReleaseExecutionException, ReleaseFailureException {
    return this.execute(rd, re, projects);
  }
}