com.android.ide.common.resources

Class GeneratedResourceSet

java.lang.Object

com.android.ide.common.resources.ResourceSet

com.android.ide.common.resources.GeneratedResourceSet

All Implemented Interfaces:

SourceSet

public class GeneratedResourceSet
extends ResourceSet

A ResourceSet that contains only generated files (e.g. PNGs generated from a vector drawable XML). It is always a mirror of a normal ResourceSet which delegates to this set when it encounters a file that needs to be replaced by generated files.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_GENERATED

Fields inherited from class com.android.ide.common.resources.ResourceSet

ATTR_AAPT_NAMESPACE, ATTR_FROM_DEPENDENCY, ATTR_GENERATED_SET

Constructor Summary

Constructors

Constructor and Description
GeneratedResourceSet(ResourceSet originalSet)
GeneratedResourceSet(java.lang.String name, com.android.ide.common.rendering.api.ResourceNamespace namespace, java.lang.String libraryName)

Method Summary

Modifier and Type	Method and Description
protected void	addItem(I item, java.lang.String key)
void	addSource(java.io.File file) Adds a new source file
void	addSources(java.util.Collection<java.io.File> files) Adds a collection of source files.
protected boolean	checkFileForAndroidRes(java.io.File file) Checks a file to make sure it is a valid file in the android res/asset folders.
protected void	checkItems() Checks for duplicate items across all source files.
protected com.android.ide.common.resources.DataSet<ResourceMergerItem,ResourceFile>	createSet(java.lang.String name)
java.io.File	findMatchingSourceFile(java.io.File file) Returns the longest path matching Source file that contains a given file.
java.lang.String	getConfigName() Returns the config name.
protected F	getDataFile(java.io.File file)
com.google.common.collect.ListMultimap<java.lang.String,I>	getDataMap() Returns a map of the items.
java.util.List<java.io.File>	getSourceFiles() Returns the list of source files.
protected boolean	getValidateEnabled()
boolean	isEmpty() Returns whether the set is empty of items.
boolean	isIgnored(java.io.File file) Returns whether the given file should be ignored.
F	loadFile(java.io.File sourceFolder, java.io.File dataFile, com.android.utils.ILogger logger) Loads a single dataFile from the given source folder (rather than load / parse from all source folders).
void	loadFromFiles(com.android.utils.ILogger logger) Loads the DataSet from the files its source folders contain.
protected void	processNewDataFile(java.io.File sourceFolder, F dataFile, boolean setTouched)
void	setIgnoredPatterns(java.lang.String aaptStylePattern)
int	size() Returns the number of items.
java.lang.String	toString()
boolean	updateWith(java.io.File sourceFolder, java.io.File changedFile, FileStatus fileStatus, com.android.utils.ILogger logger) Update the DataSet with a given file.

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

createFileAndItems, createFileAndItemsFromXml, equals, getLibraryName, getNamespace, handleChangedFile, handleNewFile, handleRemovedFile, hashCode, isFromDependency, isValidSourceFile, readSourceFolder, setCheckDuplicates, setDontNormalizeQualifiers, setFromDependency, setGeneratedSet, setPreprocessor, setShouldParseResourceIds, setTrackSourcePositions

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ATTR_GENERATED

public static final java.lang.String ATTR_GENERATED

See Also:

Constant Field Values

Constructor Detail

GeneratedResourceSet

public GeneratedResourceSet(ResourceSet originalSet)

GeneratedResourceSet

public GeneratedResourceSet(java.lang.String name,
                            com.android.ide.common.rendering.api.ResourceNamespace namespace,
                            java.lang.String libraryName)

Method Detail

createSet

protected com.android.ide.common.resources.DataSet<ResourceMergerItem,ResourceFile> createSet(java.lang.String name)

Overrides:

createSet in class ResourceSet

loadFromFiles

public void loadFromFiles(com.android.utils.ILogger logger)
                   throws MergingException

Loads the DataSet from the files its source folders contain. All loaded items are set to TOUCHED. This is so that after loading the resources from the files, they can be written directly (since touched force them to be written). This also checks for duplicates items.

Throws:

MergingException - if something goes wrong

findMatchingSourceFile

public java.io.File findMatchingSourceFile(java.io.File file)

Returns the longest path matching Source file that contains a given file. "contains" means that the source file/folder is the root folder of this file. The folder and/or file doesn't have to exist. "longest" means that if two source folder satisfy the contains predicate above, the longest absolute path will be returned.

Specified by:

findMatchingSourceFile in interface SourceSet

Parameters:

file - the file to search for

Returns:

the Source file or null if no match is found.

addSources

public void addSources(java.util.Collection<java.io.File> files)

Adds a collection of source files.

Parameters:

files - the source files to add.

addSource

public void addSource(java.io.File file)

Adds a new source file

Parameters:

file - the source file.

getSourceFiles

@NonNull
public java.util.List<java.io.File> getSourceFiles()

Returns the list of source files.

Specified by:

getSourceFiles in interface SourceSet

Returns:

a non null list.

getConfigName

public java.lang.String getConfigName()

Returns the config name.

Returns:

the config name.

size

public int size()

Returns the number of items.

Returns:

the number of items.

See Also:

DataMap

isEmpty

public boolean isEmpty()

Returns whether the set is empty of items.

Returns:

true if the set contains no items.

getDataMap

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

Returns a map of the items.

Returns:

a map of items.

See Also:

DataMap

loadFile

@Nullable
public F loadFile(@NonNull
                            java.io.File sourceFolder,
                            @NonNull
                            java.io.File dataFile,
                            @NonNull
                            com.android.utils.ILogger logger)
                     throws MergingException

Loads a single dataFile from the given source folder (rather than load / parse from all source folders).

Like loadFromFiles, all loaded items are set to TOUCHED.

Parameters:

sourceFolder - the source folder

dataFile - the data file within source folder

logger - logs errors

Returns:

a DataFile if successfully loaded, and null otherwise

Throws:

MergingException

checkItems

protected void checkItems()
                   throws DuplicateDataException

Checks for duplicate items across all source files.

Throws:

DuplicateDataException - if a duplicated item is found.

updateWith

public boolean updateWith(java.io.File sourceFolder,
                          java.io.File changedFile,
                          FileStatus fileStatus,
                          com.android.utils.ILogger logger)
                   throws MergingException

Update the DataSet with a given file.

Parameters:

sourceFolder - the sourceFile containing the changedFile

changedFile - The changed file

fileStatus - the change state

Returns:

true if the set was properly updated, false otherwise

Throws:

MergingException - if something goes wrong

processNewDataFile

protected void processNewDataFile(@NonNull
                                  java.io.File sourceFolder,
                                  @NonNull
                                  F dataFile,
                                  boolean setTouched)
                           throws MergingException

Throws:

MergingException

addItem

protected void addItem(@NonNull
                       I item,
                       @Nullable
                       java.lang.String key)
                throws MergingException

Throws:

MergingException

getDataFile

protected F getDataFile(@NonNull
                        java.io.File file)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

checkFileForAndroidRes

protected boolean checkFileForAndroidRes(@NonNull
                                         java.io.File file)

Checks a file to make sure it is a valid file in the android res/asset folders.

Parameters:

file - the file to check

Returns:

true if it is a valid file, false if it should be ignored.

setIgnoredPatterns

public void setIgnoredPatterns(java.lang.String aaptStylePattern)

isIgnored

public boolean isIgnored(@NonNull
                         java.io.File file)

Returns whether the given file should be ignored.

Parameters:

file - the file to check

Returns:

true if the file is hidden

getValidateEnabled

protected boolean getValidateEnabled()