com.android.ide.common.resources

Class MergedResourceWriter

java.lang.Object

com.android.ide.common.resources.MergeWriter<ResourceMergerItem,MergedResourceWriter.FileGenerationParameters>

com.android.ide.common.resources.MergedResourceWriter

All Implemented Interfaces:

MergeConsumer<ResourceMergerItem>

public class MergedResourceWriter
extends MergeWriter<ResourceMergerItem,MergedResourceWriter.FileGenerationParameters>

A MergeWriter for assets, using ResourceMergerItem. Also takes care of compiling resources and stripping data binding from layout files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MergedResourceWriter.FileGenerationParameters
static class	MergedResourceWriter.FileGenerationWorkAction

Nested classes/interfaces inherited from interface com.android.ide.common.resources.MergeConsumer

MergeConsumer.ConsumerException

Constructor Summary

Constructors

Constructor and Description

MergedResourceWriter(com.android.ide.common.workers.WorkerExecutorFacade workerExecutor, java.io.File rootFolder, java.io.File publicFile, MergingLog blameLog, ResourcePreprocessor preprocessor, com.android.ide.common.resources.ResourceCompilationService resourceCompilationService, java.io.File temporaryDirectory, SingleFileProcessor dataBindingExpressionRemover, java.io.File notCompiledOutputDirectory, boolean pseudoLocalesEnabled, boolean crunchPng) A MergeWriter for resources, using ResourceMergerItem.

Method Summary

Modifier and Type	Method and Description
void	addItem(ResourceMergerItem item) Adds an item.
static MergedResourceWriter	createWriterWithoutPngCruncher(com.android.ide.common.workers.ExecutorServiceAdapter executorServiceAdapter, java.io.File rootFolder, java.io.File publicFile, java.io.File blameLogFolder, ResourcePreprocessor preprocessor, java.io.File temporaryDirectory) Used in tests
static MergedResourceWriter	createWriterWithoutPngCruncher(java.io.File rootFolder, java.io.File publicFile, java.io.File blameLogFolder, ResourcePreprocessor preprocessor, java.io.File temporaryDirectory) Used in tools/idea.
void	end() Called after the merge ends.
boolean	ignoreItemInMerge(ResourceMergerItem item)
protected void	postWriteAction() Called after all the items have been added/removed.
void	removeItem(ResourceMergerItem removedItem, ResourceMergerItem replacedBy) Removes an item.
void	start(javax.xml.parsers.DocumentBuilderFactory factory) Called before the merge starts.

Methods inherited from class com.android.ide.common.resources.MergeWriter

getExecutor, getRootFolder

Methods inherited from class java.lang.Object

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

Constructor Detail

MergedResourceWriter

public MergedResourceWriter(@NonNull
                            com.android.ide.common.workers.WorkerExecutorFacade workerExecutor,
                            @NonNull
                            java.io.File rootFolder,
                            @Nullable
                            java.io.File publicFile,
                            @Nullable
                            MergingLog blameLog,
                            @NonNull
                            ResourcePreprocessor preprocessor,
                            @NonNull
                            com.android.ide.common.resources.ResourceCompilationService resourceCompilationService,
                            @NonNull
                            java.io.File temporaryDirectory,
                            @Nullable
                            SingleFileProcessor dataBindingExpressionRemover,
                            @Nullable
                            java.io.File notCompiledOutputDirectory,
                            boolean pseudoLocalesEnabled,
                            boolean crunchPng)

A MergeWriter for resources, using ResourceMergerItem. Also takes care of compiling resources and stripping data binding from layout files.

Parameters:

rootFolder - merged resources directory to write to (e.g. intermediates/res/merged/debug)

publicFile - File that we should write public.txt to

blameLog - merging log for rewriting error messages

preprocessor - preprocessor for merged resources, such as vector drawable rendering

resourceCompilationService - such as AAPT. The service is responsible for ensuring all compilation is complete before the task execution ends.

temporaryDirectory - temporary directory for intermediate merged files

dataBindingExpressionRemover - removes data binding expressions from layout files

notCompiledOutputDirectory - for saved uncompiled resources for the resource shrinking transform and for unit testing with resources.

pseudoLocalesEnabled - generate resources for pseudo-locales (en-XA and ar-XB)

crunchPng - should we crunch PNG files

Method Detail

createWriterWithoutPngCruncher

public static MergedResourceWriter createWriterWithoutPngCruncher(@NonNull
                                                                  java.io.File rootFolder,
                                                                  @Nullable
                                                                  java.io.File publicFile,
                                                                  @Nullable
                                                                  java.io.File blameLogFolder,
                                                                  @NonNull
                                                                  ResourcePreprocessor preprocessor,
                                                                  @NonNull
                                                                  java.io.File temporaryDirectory)

Used in tools/idea.

createWriterWithoutPngCruncher

public static MergedResourceWriter createWriterWithoutPngCruncher(@Nullable
                                                                  com.android.ide.common.workers.ExecutorServiceAdapter executorServiceAdapter,
                                                                  @NonNull
                                                                  java.io.File rootFolder,
                                                                  @Nullable
                                                                  java.io.File publicFile,
                                                                  @Nullable
                                                                  java.io.File blameLogFolder,
                                                                  @NonNull
                                                                  ResourcePreprocessor preprocessor,
                                                                  @NonNull
                                                                  java.io.File temporaryDirectory)

Used in tests

start

public void start(@NonNull
                  javax.xml.parsers.DocumentBuilderFactory factory)
           throws MergeConsumer.ConsumerException

Description copied from interface: MergeConsumer

Called before the merge starts.

Specified by:

start in interface MergeConsumer<ResourceMergerItem>

Overrides:

start in class MergeWriter<ResourceMergerItem,MergedResourceWriter.FileGenerationParameters>

Throws:

MergeConsumer.ConsumerException

end

public void end()
         throws MergeConsumer.ConsumerException

Description copied from interface: MergeConsumer

Called after the merge ends.

Specified by:

end in interface MergeConsumer<ResourceMergerItem>

Overrides:

end in class MergeWriter<ResourceMergerItem,MergedResourceWriter.FileGenerationParameters>

Throws:

MergeConsumer.ConsumerException

ignoreItemInMerge

public boolean ignoreItemInMerge(ResourceMergerItem item)

addItem

public void addItem(@NonNull
                    ResourceMergerItem item)
             throws MergeConsumer.ConsumerException

Description copied from interface: MergeConsumer

Adds an item. The item may already be existing. Calling DataItem.isTouched() will indicate whether the item actually changed.

Parameters:

item - the new item.

Throws:

MergeConsumer.ConsumerException

removeItem

public void removeItem(@NonNull
                       ResourceMergerItem removedItem,
                       @Nullable
                       ResourceMergerItem replacedBy)
                throws MergeConsumer.ConsumerException

Description copied from interface: MergeConsumer

Removes an item. Optionally pass the item that will replace this one. This methods does not do the replacement. The replaced item is just there in case the removal can be optimized when it's a replacement vs. a removal.

Parameters:

removedItem - the removed item.

replacedBy - the optional item that replaces the removed item.

Throws:

MergeConsumer.ConsumerException

postWriteAction

protected void postWriteAction()
                        throws MergeConsumer.ConsumerException

Description copied from class: MergeWriter

Called after all the items have been added/removed. This is called by MergeWriter.end().

Overrides:

postWriteAction in class MergeWriter<ResourceMergerItem,MergedResourceWriter.FileGenerationParameters>

Throws:

MergeConsumer.ConsumerException