DefaultAssemblyReader (Apache Maven Assembly Plugin 2.5.5 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.plugin.assembly.io
Class DefaultAssemblyReader

java.lang.Object
  org.codehaus.plexus.logging.AbstractLogEnabled
      org.apache.maven.plugin.assembly.io.DefaultAssemblyReader

All Implemented Interfaces:: AssemblyReader, org.codehaus.plexus.logging.LogEnabled

@Component(role=AssemblyReader.class) public class DefaultAssemblyReader
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements AssemblyReader
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements AssemblyReader

Version:: $Id: DefaultAssemblyReader.java 1644916 2014-12-12 14:57:54Z krosenvold $

Constructor Summary
`DefaultAssemblyReader()`

Method Summary
`static org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator`	`createProjectInterpolator(MavenProject project)`
`Assembly`	`getAssemblyForDescriptorReference(String ref, AssemblerConfigurationSource configSource)`
`Assembly`	`getAssemblyFromDescriptorFile(File file, AssemblerConfigurationSource configSource)`
`protected org.codehaus.plexus.logging.Logger`	`getLogger()`
`void`	`includeSiteInAssembly(Assembly assembly, AssemblerConfigurationSource configSource)`
`protected void`	`mergeComponentsWithMainAssembly(Assembly assembly, File assemblyDir, AssemblerConfigurationSource configSource, ComponentXpp3Reader.ContentTransformer transformer)` Add the contents of all included components to main assembly
`protected void`	`mergeComponentWithAssembly(Component component, Assembly assembly)` Add the content of a single Component to main assembly
`List<Assembly>`	`readAssemblies(AssemblerConfigurationSource configSource)`
`Assembly`	`readAssembly(Reader reader, String locationDescription, File assemblyDir, AssemblerConfigurationSource configSource)`

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled
`enableLogging, setupLogger, setupLogger, setupLogger`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

DefaultAssemblyReader

public DefaultAssemblyReader()

Method Detail

readAssemblies

public List<Assembly> readAssemblies(AssemblerConfigurationSource configSource)
                              throws AssemblyReadException,
                                     InvalidAssemblerConfigurationException

Specified by:: readAssemblies in interface AssemblyReader

Throws:: AssemblyReadException; InvalidAssemblerConfigurationException

getAssemblyForDescriptorReference

public Assembly getAssemblyForDescriptorReference(String ref,
                                                  AssemblerConfigurationSource configSource)
                                           throws AssemblyReadException,
                                                  InvalidAssemblerConfigurationException

Specified by:: getAssemblyForDescriptorReference in interface AssemblyReader

Throws:: AssemblyReadException; InvalidAssemblerConfigurationException

getAssemblyFromDescriptorFile

public Assembly getAssemblyFromDescriptorFile(File file,
                                              AssemblerConfigurationSource configSource)
                                       throws AssemblyReadException,
                                              InvalidAssemblerConfigurationException

Specified by:: getAssemblyFromDescriptorFile in interface AssemblyReader

Throws:: AssemblyReadException; InvalidAssemblerConfigurationException

readAssembly

public Assembly readAssembly(Reader reader,
                             String locationDescription,
                             File assemblyDir,
                             AssemblerConfigurationSource configSource)
                      throws AssemblyReadException,
                             InvalidAssemblerConfigurationException

Throws:: AssemblyReadException; InvalidAssemblerConfigurationException

createProjectInterpolator

public static org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator createProjectInterpolator(MavenProject project)

mergeComponentsWithMainAssembly

protected void mergeComponentsWithMainAssembly(Assembly assembly,
                                               File assemblyDir,
                                               AssemblerConfigurationSource configSource,
                                               ComponentXpp3Reader.ContentTransformer transformer)
                                        throws AssemblyReadException

Add the contents of all included components to main assembly

Parameters:: assembly - The assembly; assemblyDir - The assembly directory; transformer - The component interpolator
Throws:: AssemblyReadException - .

mergeComponentWithAssembly

protected void mergeComponentWithAssembly(Component component,
                                          Assembly assembly)

Add the content of a single Component to main assembly

Parameters:: component - The component; assembly - The assembly

includeSiteInAssembly

public void includeSiteInAssembly(Assembly assembly,
                                  AssemblerConfigurationSource configSource)
                           throws InvalidAssemblerConfigurationException

Specified by:: includeSiteInAssembly in interface AssemblyReader

Throws:: InvalidAssemblerConfigurationException

getLogger

protected org.codehaus.plexus.logging.Logger getLogger()

Overrides:: getLogger in class org.codehaus.plexus.logging.AbstractLogEnabled