View Javadoc

1   package org.apache.maven.plugin.assembly.io;
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.plugin.MojoFailureException;
23  import org.apache.maven.plugin.assembly.AssemblerConfigurationSource;
24  import org.apache.maven.plugin.assembly.InvalidAssemblerConfigurationException;
25  import org.apache.maven.plugin.assembly.model.Assembly;
26  
27  import java.io.File;
28  import java.util.List;
29  
30  /**
31   * @version $Id: AssemblyReader.java 1000934 2010-09-24 16:09:58Z jdcasey $
32   */
33  public interface AssemblyReader
34  {
35  
36      public List<Assembly> readAssemblies( AssemblerConfigurationSource configSource )
37          throws AssemblyReadException, InvalidAssemblerConfigurationException;
38  
39      public Assembly getAssemblyForDescriptorReference( String ref, AssemblerConfigurationSource configSource )
40          throws AssemblyReadException, InvalidAssemblerConfigurationException;
41  
42      public Assembly getAssemblyFromDescriptorFile( File file, AssemblerConfigurationSource configSource )
43          throws AssemblyReadException, InvalidAssemblerConfigurationException;
44  
45      public void includeSiteInAssembly( Assembly assembly, AssemblerConfigurationSource configSource )
46          throws MojoFailureException, InvalidAssemblerConfigurationException;
47  
48  }