View Javadoc

1   package org.apache.maven.archiva.repository.project;
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 org.apache.maven.archiva.model.ArchivaProjectModel;
23  
24  import java.io.File;
25  import java.io.IOException;
26  import java.io.Writer;
27  
28  /**
29   * ProjectModelWriter 
30   *
31   * @version $Id: ProjectModelWriter.java 718864 2008-11-19 06:33:35Z brett $
32   */
33  public interface ProjectModelWriter
34  {
35      /**
36       * Write a project model out to disk.
37       * 
38       * @param model the model to write.
39       * @param pomFile the (pom) file on disk to write to.
40       * @throws ProjectModelException if there was a problem with the model itself.
41       * @throws IOException if there was a problem writing the pom file.
42       */
43      public void write( ArchivaProjectModel model, File pomFile )
44          throws ProjectModelException, IOException;
45  
46      /**
47       * Write a project model out to a {@link Writer}.
48       * 
49       * @param model the model to write.
50       * @param writer the writer (stream) to write to.
51       * @throws ProjectModelException if there was a problem with the model itself.
52       * @throws IOException if there was a problem writing the pom file.
53       */
54      public void write( ArchivaProjectModel model, Writer writer )
55          throws ProjectModelException, IOException;
56  }