MavenPomHandler.java

/*
 * Copyright 2012-2013 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 at.nonblocking.maven.nonsnapshot;

import java.io.File;

import at.nonblocking.maven.nonsnapshot.model.MavenModule;
import org.apache.maven.model.Model;

/**
 * Handler for Maven POM access and modification.
 *
 * @author Juergen Kofler
 */
public interface MavenPomHandler {

  /**
   * Convert given POM model to a WorkspaceArtifact object.
   *
   * @param model Model
   * @return WorkspaceArtifact
   */
  MavenModule readArtifact(Model model);

  /**
   * Read the POM model from given file and return a completely filled WorkspaceArtifact object.
   *
   * @param pomFile File
   * @return WorkspaceArtifact
   */
  MavenModule readArtifact(File pomFile);

  /**
   * Update the project version and all the versions of dirty dependencies.
   *
   * @param workspaceArtifact WorkspaceArtifact
   */
  void updateArtifact(MavenModule workspaceArtifact);

}