View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.plugins.assembly.io;
20  
21  import java.io.File;
22  import java.util.List;
23  
24  import org.apache.maven.plugin.MojoFailureException;
25  import org.apache.maven.plugins.assembly.AssemblerConfigurationSource;
26  import org.apache.maven.plugins.assembly.InvalidAssemblerConfigurationException;
27  import org.apache.maven.plugins.assembly.model.Assembly;
28  
29  /**
30   *
31   */
32  public interface AssemblyReader {
33  
34      List<Assembly> readAssemblies(AssemblerConfigurationSource configSource)
35              throws AssemblyReadException, InvalidAssemblerConfigurationException;
36  
37      Assembly getAssemblyForDescriptorReference(String ref, AssemblerConfigurationSource configSource)
38              throws AssemblyReadException, InvalidAssemblerConfigurationException;
39  
40      Assembly getAssemblyFromDescriptorFile(File file, AssemblerConfigurationSource configSource)
41              throws AssemblyReadException, InvalidAssemblerConfigurationException;
42  
43      void includeSiteInAssembly(Assembly assembly, AssemblerConfigurationSource configSource)
44              throws MojoFailureException, InvalidAssemblerConfigurationException;
45  }