View Javadoc
1   package org.apache.maven.shared.release.transform;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.io.File;
23  
24  import org.apache.maven.model.Model;
25  import org.apache.maven.shared.release.ReleaseExecutionException;
26  
27  /**
28   * <p>ModelETL interface.</p>
29   *
30   * @author Robert Scholte
31   * @since 3.0
32   */
33  public interface ModelETL
34  {
35      /**
36       * <p>extract.</p>
37       *
38       * @param pomFile a {@link java.io.File} object
39       * @throws org.apache.maven.shared.release.ReleaseExecutionException if any.
40       */
41      void extract( File pomFile ) throws ReleaseExecutionException;
42  
43      /**
44       * <p>transform.</p>
45       */
46      void transform();
47  
48      /**
49       * <p>load.</p>
50       *
51       * @param pomFile a {@link java.io.File} object
52       * @throws org.apache.maven.shared.release.ReleaseExecutionException if any.
53       */
54      void load( File pomFile ) throws ReleaseExecutionException;
55  
56      // will be removed once transform() is implemented
57      /**
58       * <p>getModel.</p>
59       *
60       * @return a {@link org.apache.maven.model.Model} object
61       */
62      @Deprecated
63      Model getModel();
64  }