com.android.ide.common.resources

Class ResourceMerger

java.lang.Object

com.android.ide.common.resources.ResourceMerger

public class ResourceMerger
extends java.lang.Object

Implementation of DataMerger for ResourceSet, ResourceMergerItem, and ResourceFile.

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.xml.parsers.DocumentBuilderFactory	mFactory
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,ResourceMergerItem>>	mMergedItems Map of items that are purely results of merges (ie item that made up of several original items).

Constructor Summary

Constructors

Constructor and Description
ResourceMerger(int minSdk) Creates a new resource merger.

Method Summary

Modifier and Type	Method and Description
void	addDataSet(ResourceSet resourceSet) Adds a new DataSet and overlays it on top of the existing DataSet.
boolean	checkValidUpdate(java.util.List<S> dataSets) Checks that a loaded merger can be updated with a given list of DataSet.
void	cleanBlob(java.io.File blobRootFolder)
protected void	createDir(java.io.File folder)
protected ResourceSet	createFromXml(org.w3c.dom.Node node) Reads the ResourceSet from the blob XML.
protected boolean	filterAccept(ResourceMergerItem dataItem) Method that implements data filters.
FileValidity<S>	findDataSetContaining(java.io.File file) Finds the DataSet that contains the given file.
FileValidity<S>	findDataSetContaining(java.io.File file, FileValidity<S> fileValidity) Finds the DataSet that contains the given file.
protected java.lang.String	getAdditionalDataTagName()
com.google.common.collect.ListMultimap<java.lang.String,I>	getDataMap() Returns a map of the data items.
java.util.List<S>	getDataSets() Returns the list of ResourceSet objects.
protected void	loadAdditionalData(org.w3c.dom.Node mergedItemsNode, boolean incrementalState)
boolean	loadFromBlob(java.io.File blobRootFolder, boolean incrementalState) Loads the merger state from a blob file.
void	mergeData(MergeConsumer<ResourceMergerItem> consumer, boolean doCleanUp) Merges the data into a given consumer.
protected void	mergeItems(java.lang.String dataItemKey, java.util.List<ResourceMergerItem> items, MergeConsumer<ResourceMergerItem> consumer) Merge items together, and register the merged items with the given consumer.
protected boolean	requiresMerge(java.lang.String dataItemKey)
int	size() Returns the number of items.
java.lang.String	toString()
protected void	writeAdditionalData(org.w3c.dom.Document document, org.w3c.dom.Node rootNode)
void	writeBlobTo(java.io.File blobRootFolder, MergeConsumer<I> consumer, boolean includeTimestamps) Writes a single blob file to store all that the DataMerger knows about.
void	writeBlobToWithTimestamps(java.io.File blobRootFolder, MergeConsumer<I> consumer) Writes a single blob file to store all that the DataMerger knows about, and tag file entries with lastModified timestamps.

Methods inherited from class java.lang.Object

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

Field Detail

mMergedItems

protected final java.util.Map<java.lang.String,java.util.Map<java.lang.String,ResourceMergerItem>> mMergedItems

Map of items that are purely results of merges (ie item that made up of several original items). The first map key is the associated qualifier for the items, the second map key is the item name.

mFactory

@NonNull
protected final javax.xml.parsers.DocumentBuilderFactory mFactory

Constructor Detail

ResourceMerger

public ResourceMerger(int minSdk)

Creates a new resource merger.

Parameters:

minSdk - the minimum SDK, used for filtering.

Method Detail

createFromXml

protected ResourceSet createFromXml(org.w3c.dom.Node node)
                             throws MergingException

Reads the ResourceSet from the blob XML. ResourceMerger deals with two kinds of sets - GeneratedResourceSet and "plain" ResourceSet . Instances of the former are marked with generated="true" attribute. Instances of the latter have a generated-set attribute that references the corresponding generated set by name. For any variant, the generated set has a lower priority, so it comes in the XML first. This means we will find it by name at this stage.

Throws:

MergingException

requiresMerge

protected boolean requiresMerge(@NonNull
                                java.lang.String dataItemKey)

mergeItems

protected void mergeItems(@NonNull
                          java.lang.String dataItemKey,
                          @NonNull
                          java.util.List<ResourceMergerItem> items,
                          @NonNull
                          MergeConsumer<ResourceMergerItem> consumer)
                   throws MergingException

Merge items together, and register the merged items with the given consumer.

Parameters:

dataItemKey - the key for the items

items - the items, from lower priority to higher priority.

consumer - the consumer to receive the merged items.

Throws:

MergingException

getAdditionalDataTagName

@NonNull
protected java.lang.String getAdditionalDataTagName()

loadAdditionalData

protected void loadAdditionalData(@NonNull
                                  org.w3c.dom.Node mergedItemsNode,
                                  boolean incrementalState)
                           throws MergingException

Throws:

MergingException

writeAdditionalData

protected void writeAdditionalData(org.w3c.dom.Document document,
                                   org.w3c.dom.Node rootNode)

addDataSet

public void addDataSet(ResourceSet resourceSet)

Adds a new DataSet and overlays it on top of the existing DataSet.

Parameters:

resourceSet - the ResourceSet to add.

mergeData

public void mergeData(@NonNull
                      MergeConsumer<ResourceMergerItem> consumer,
                      boolean doCleanUp)
               throws MergingException

Merges the data into a given consumer.

Parameters:

consumer - the consumer of the merge.

doCleanUp - clean up the state to be able to do further incremental merges. If this is a one-shot merge, this can be false to improve performance.

Throws:

MergingException - such as a DuplicateDataException or a MergeConsumer.ConsumerException if something goes wrong

filterAccept

protected boolean filterAccept(@NonNull
                               ResourceMergerItem dataItem)

Method that implements data filters. A data filter will accept or reject a data item. The default implementation will accept all items but subclasses may override this.

Parameters:

dataItem - the data item to filter

Returns:

should this data item be accepted?

getDataSets

@NonNull
public java.util.List<S> getDataSets()

Returns the list of ResourceSet objects.

Returns:

the resource sets.

size

public int size()

Returns the number of items.

Returns:

the number of items.

See Also:

DataMap

getDataMap

@NonNull
public com.google.common.collect.ListMultimap<java.lang.String,I> getDataMap()

Returns a map of the data items.

Returns:

a map of items.

See Also:

DataMap

writeBlobTo

public void writeBlobTo(@NonNull
                        java.io.File blobRootFolder,
                        @NonNull
                        MergeConsumer<I> consumer,
                        boolean includeTimestamps)
                 throws MergingException

Writes a single blob file to store all that the DataMerger knows about.

Parameters:

blobRootFolder - the root folder where blobs are store.

consumer - the merge consumer that was used by the merge.

includeTimestamps - true if the files should be tagged with lastModified timestamps

Throws:

MergingException - if something goes wrong

See Also:

loadFromBlob(File, boolean)

writeBlobToWithTimestamps

public void writeBlobToWithTimestamps(@NonNull
                                      java.io.File blobRootFolder,
                                      @NonNull
                                      MergeConsumer<I> consumer)
                               throws MergingException

Writes a single blob file to store all that the DataMerger knows about, and tag file entries with lastModified timestamps.

Parameters:

blobRootFolder - the root folder where blobs are store.

consumer - the merge consumer that was used by the merge.

Throws:

MergingException - if something goes wrong

See Also:

loadFromBlob(File, boolean)

loadFromBlob

public boolean loadFromBlob(@NonNull
                            java.io.File blobRootFolder,
                            boolean incrementalState)
                     throws MergingException

Loads the merger state from a blob file.

This can be loaded into two different ways that differ only by the state on the DataItem objects.

If incrementalState is true then the items that are on disk are marked as written (DataItem.isWritten() returning true. This is to be used by MergeWriter to update a merged res folder.

If false, the items are marked as touched, and this can be used to feed a new ResourceRepository object.

Parameters:

blobRootFolder - the folder containing the blob.

incrementalState - whether to load into an incremental state or a new state.

Returns:

true if the blob was loaded.

Throws:

MergingException - if something goes wrong

See Also:

writeBlobTo(File, MergeConsumer, boolean)

cleanBlob

public void cleanBlob(@NonNull
                      java.io.File blobRootFolder)

checkValidUpdate

public boolean checkValidUpdate(java.util.List<S> dataSets)

Checks that a loaded merger can be updated with a given list of DataSet. For now this means the sets haven't changed.

Parameters:

dataSets - the resource sets.

Returns:

true if the update can be performed. false if a full merge should be done.

findDataSetContaining

public FileValidity<S> findDataSetContaining(@NonNull
                                             java.io.File file)

Finds the DataSet that contains the given file. This methods will also performs some checks to make sure the given file is a valid file in the data set. All the information is set in a FileValidity object that is returned. FileValidity contains information about the changed file including: - is it from an known set, is it an ignored file, or is it unknown? - what data set does it belong to - what source folder in the data set does it belong to. "belong" means that the DataSet has a source file/folder that is the root folder of this file. The folder and/or file doesn't have to exist.

Parameters:

file - the file to check

Returns:

a new FileValidity.

findDataSetContaining

public FileValidity<S> findDataSetContaining(@NonNull
                                             java.io.File file,
                                             @Nullable
                                             FileValidity<S> fileValidity)

Finds the DataSet that contains the given file. This methods will also performs some checks to make sure the given file is a valid file in the data set. All the information is set in a FileValidity object that is returned. If an instance is passed, then this object is filled instead, and returned. FileValidity contains information about the changed file including: - is it from an known set, is it an ignored file, or is it unknown? - what data set does it belong to - what source folder in the data set does it belong to. "belong" means that the DataSet has a source file/folder that is the root folder of this file. The folder and/or file doesn't have to exist.

Parameters:

file - the file to check

fileValidity - an optional FileValidity to fill. If null a new one is returned.

Returns:

a new FileValidity or the one given as a parameter.

createDir

protected void createDir(java.io.File folder)
                  throws java.io.IOException

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object