com.android.manifmerger

Class ManifestMerger2.Invoker<T extends ManifestMerger2.Invoker<T>>

java.lang.Object

com.android.manifmerger.ManifestMerger2.Invoker<T>

Enclosing class:

ManifestMerger2

public static class ManifestMerger2.Invoker<T extends ManifestMerger2.Invoker<T>>
extends java.lang.Object

This class will hold all invocation parameters for the manifest merging tool. There are broadly three types of input to the merging tool :

• Build types and flavors overriding manifests
• Application main manifest
• Library manifest files

Only the main manifest file is a mandatory parameter. High level description of the merging will be as follow :

1. Build type and flavors will be merged first in the order they were added. Highest priority file added first, lowest added last.
2. Resulting document is merged with lower priority application main manifest file.
3. Resulting document is merged with each library file manifest file in the order they were added. Highest priority added first, lowest added last.
4. Resulting document is returned as results of the merging process.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ManifestMerger2.Invoker.Feature Optional behavior of the merging tool can be turned on by setting these Feature.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.android.utils.ILogger	mLogger
protected java.io.File	mMainManifestFile
protected com.google.common.collect.ImmutableMap.Builder<java.lang.String,java.lang.Object>	mPlaceholders
protected com.google.common.collect.ImmutableMap.Builder<ManifestSystemProperty,java.lang.Object>	mSystemProperties

Method Summary

Modifier and Type	Method and Description
ManifestMerger2.Invoker	addBundleManifests(java.util.List<com.android.utils.Pair<java.lang.String,java.io.File>> namesAndFiles) Deprecated. use addLibraryManifest or addAndroidBundleManifests
ManifestMerger2.Invoker	addFlavorAndBuildTypeManifest(java.io.File file) Add a flavor or build type manifest file last in the list.
ManifestMerger2.Invoker	addFlavorAndBuildTypeManifests(java.io.File... files) Add several flavor or build type manifest files last in the list.
ManifestMerger2.Invoker	addLibraryManifest(java.io.File file) Add one library file manifest, will be added last in the list of library files which will make the parameter the lowest priority library manifest file.
ManifestMerger2.Invoker	addLibraryManifest(java.lang.String name, java.io.File file) Add one library file manifest, will be added last in the list of library files which will make the parameter the lowest priority library manifest file.
ManifestMerger2.Invoker	addLibraryManifests(java.io.File... files) Add several library file manifests at then end of the list which will make them the lowest priority manifest files.
ManifestMerger2.Invoker	addManifestProviders(java.lang.Iterable<? extends ManifestProvider> providers) Sets manifest providers for this merging activity.
ManifestMerger2.Invoker	addNavigationFile(java.io.File file) Add one navigation file.
ManifestMerger2.Invoker	addNavigationFiles(java.lang.Iterable<java.io.File> files) Add several navigation files last in the list.
ManifestMerger2.Invoker	asType(XmlDocument.Type type) Specify if the file being merged is an overlay (flavor).
MergingReport	merge() Perform the merging and return the result.
ManifestMerger2.Invoker	setFeatureName(java.lang.String featureName) Specify the feature name for feature merging.
ManifestMerger2.Invoker	setMergeReportFile(java.io.File mergeReport) Sets the file to use to write the merging report.
ManifestMerger2.Invoker	setOverride(ManifestSystemProperty override, java.lang.String value) Sets a value for a ManifestSystemProperty
ManifestMerger2.Invoker	setPlaceHolderValue(java.lang.String placeHolderName, java.lang.String value) Adds a new placeholder name and value for substitution.
ManifestMerger2.Invoker	setPlaceHolderValues(java.util.Map<java.lang.String,java.lang.Object> keyValuePairs) Adds placeholders names and associated values for substitution.
ManifestMerger2.Invoker	withFeatures(ManifestMerger2.Invoker.Feature... features) Sets some optional features for the merge tool.
ManifestMerger2.Invoker	withFileStreamProvider(ManifestMerger2.FileStreamProvider provider) Sets a file stream provider which allows the client of the manifest merger to provide arbitrary content lookup for files.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mMainManifestFile

protected final java.io.File mMainManifestFile

mSystemProperties

protected final com.google.common.collect.ImmutableMap.Builder<ManifestSystemProperty,java.lang.Object> mSystemProperties

mLogger

@NonNull
protected final com.android.utils.ILogger mLogger

mPlaceholders

@NonNull
protected final com.google.common.collect.ImmutableMap.Builder<java.lang.String,java.lang.Object> mPlaceholders

Method Detail

setOverride

@NonNull
public ManifestMerger2.Invoker setOverride(@NonNull
                                                    ManifestSystemProperty override,
                                                    @NonNull
                                                    java.lang.String value)

Sets a value for a ManifestSystemProperty

Parameters:

override - the property to set

value - the value for the property

Returns:

itself.

setPlaceHolderValues

@NonNull
public ManifestMerger2.Invoker setPlaceHolderValues(@NonNull
                                                             java.util.Map<java.lang.String,java.lang.Object> keyValuePairs)

Adds placeholders names and associated values for substitution.

Returns:

itself.

setPlaceHolderValue

@NonNull
public ManifestMerger2.Invoker setPlaceHolderValue(@NonNull
                                                            java.lang.String placeHolderName,
                                                            @NonNull
                                                            java.lang.String value)

Adds a new placeholder name and value for substitution.

Returns:

itself.

setMergeReportFile

@NonNull
public ManifestMerger2.Invoker setMergeReportFile(@Nullable
                                                           java.io.File mergeReport)

Sets the file to use to write the merging report. If not called, the merging process will not write a report.

Parameters:

mergeReport - the file to write the report in.

Returns:

itself.

addLibraryManifest

@NonNull
public ManifestMerger2.Invoker addLibraryManifest(@NonNull
                                                           java.io.File file)

Add one library file manifest, will be added last in the list of library files which will make the parameter the lowest priority library manifest file.

Parameters:

file - the library manifest file to add.

Returns:

itself.

addLibraryManifest

@NonNull
public ManifestMerger2.Invoker addLibraryManifest(@NonNull
                                                           java.lang.String name,
                                                           @NonNull
                                                           java.io.File file)

Add one library file manifest, will be added last in the list of library files which will make the parameter the lowest priority library manifest file.

Parameters:

file - the library manifest file to add.

name - the library name.

Returns:

itself.

addBundleManifests

@NonNull
 @Deprecated
public ManifestMerger2.Invoker addBundleManifests(@NonNull
                                                                        java.util.List<com.android.utils.Pair<java.lang.String,java.io.File>> namesAndFiles)

Deprecated. use addLibraryManifest or addAndroidBundleManifests

Sets library dependencies for this merging activity.

Parameters:

namesAndFiles - the list of library dependencies.

Returns:

itself.

addManifestProviders

@NonNull
public ManifestMerger2.Invoker addManifestProviders(@NonNull
                                                             java.lang.Iterable<? extends ManifestProvider> providers)

Sets manifest providers for this merging activity.

Parameters:

providers - the list of manifest providers.

Returns:

itself.

addLibraryManifests

@NonNull
public ManifestMerger2.Invoker addLibraryManifests(@NonNull
                                                            java.io.File... files)

Add several library file manifests at then end of the list which will make them the lowest priority manifest files. The relative priority between all the files passed as parameters will be respected.

Parameters:

files - library manifest files to add last.

Returns:

itself.

addFlavorAndBuildTypeManifest

@NonNull
public ManifestMerger2.Invoker addFlavorAndBuildTypeManifest(@NonNull
                                                                      java.io.File file)

Add a flavor or build type manifest file last in the list.

Parameters:

file - build type or flavor manifest file

Returns:

itself.

addFlavorAndBuildTypeManifests

@NonNull
public ManifestMerger2.Invoker addFlavorAndBuildTypeManifests(java.io.File... files)

Add several flavor or build type manifest files last in the list. Relative priorities between the passed files as parameters will be respected.

Parameters:

files - build type of flavor manifest files to add.

Returns:

itself.

withFeatures

@NonNull
public ManifestMerger2.Invoker withFeatures(ManifestMerger2.Invoker.Feature... features)

Sets some optional features for the merge tool.

Parameters:

features - one to many features to set.

Returns:

itself.

withFileStreamProvider

@NonNull
public ManifestMerger2.Invoker withFileStreamProvider(@Nullable
                                                               ManifestMerger2.FileStreamProvider provider)

Sets a file stream provider which allows the client of the manifest merger to provide arbitrary content lookup for files.

NOTE: There should only be one.

Parameters:

provider - the provider to use

Returns:

itself.

setFeatureName

@NonNull
public ManifestMerger2.Invoker setFeatureName(@Nullable
                                                       java.lang.String featureName)

Specify the feature name for feature merging.

Parameters:

featureName - the feature name to use.

Returns:

itself.

addNavigationFile

@NonNull
public ManifestMerger2.Invoker addNavigationFile(@NonNull
                                                          java.io.File file)

Add one navigation file. It will be added last in the list of navigation files which will make it the lowest priority navigation file.

Parameters:

file - the navigation file to add.

Returns:

itself.

addNavigationFiles

@NonNull
public ManifestMerger2.Invoker addNavigationFiles(@NonNull
                                                           java.lang.Iterable<java.io.File> files)

Add several navigation files last in the list. Relative priorities between the passed files as parameters will be respected.

Parameters:

files - the navigation files to add.

Returns:

itself.

asType

@NonNull
public ManifestMerger2.Invoker asType(XmlDocument.Type type)

Specify if the file being merged is an overlay (flavor). If not called, the merging process will assume a master manifest merge. The master manifest needs to have a package and some other mandatory fields like "uses-sdk", etc.

Returns:

itself.

merge

@NonNull
public MergingReport merge()
                             throws ManifestMerger2.MergeFailureException

Perform the merging and return the result.

Returns:

an instance of MergingReport that will give access to all the logging and merging records. This method can be invoked several time and will re-do the file merges.

Throws:

ManifestMerger2.MergeFailureException - if the merging cannot be completed successfully.