com.android.ide.common.resources

Class ResourceSet

java.lang.Object

com.android.ide.common.resources.ResourceSet

All Implemented Interfaces:

SourceSet

Direct Known Subclasses:

GeneratedResourceSet

public class ResourceSet
extends java.lang.Object

Implementation of DataSet for ResourceMergerItem and ResourceFile.

This is able to detect duplicates from the same source folders (same resource coming from the values folder in same or different files).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_AAPT_NAMESPACE
static java.lang.String	ATTR_FROM_DEPENDENCY
static java.lang.String	ATTR_GENERATED_SET

Constructor Summary

Constructors

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

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 ResourceFile	createFileAndItems(java.io.File sourceFolder, java.io.File file, com.android.utils.ILogger logger)
protected ResourceFile	createFileAndItemsFromXml(java.io.File file, org.w3c.dom.Node fileNode) Creates a DataFile and associated DataItems from an XML node from a file created with DataSet.appendToXml(Node, Document, MergeConsumer, boolean)
protected com.android.ide.common.resources.DataSet<ResourceMergerItem,ResourceFile>	createSet(java.lang.String name)
boolean	equals(java.lang.Object o)
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.lang.String	getLibraryName()
com.android.ide.common.rendering.api.ResourceNamespace	getNamespace()
java.util.List<java.io.File>	getSourceFiles() Returns the list of source files.
protected boolean	getValidateEnabled()
protected boolean	handleChangedFile(java.io.File sourceFolder, java.io.File changedFile, com.android.utils.ILogger logger)
protected ResourceFile	handleNewFile(java.io.File sourceFolder, java.io.File file, com.android.utils.ILogger logger)
protected boolean	handleRemovedFile(java.io.File removedFile)
int	hashCode()
boolean	isEmpty() Returns whether the set is empty of items.
boolean	isFromDependency()
boolean	isIgnored(java.io.File file) Returns whether the given file should be ignored.
protected boolean	isValidSourceFile(java.io.File sourceFolder, java.io.File file)
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)
protected void	readSourceFolder(java.io.File sourceFolder, com.android.utils.ILogger logger) Reads the content of a data folders and loads the DataItem.
void	setCheckDuplicates(boolean value) Tells the resource set whether to check for duplicate resource items or not.
void	setDontNormalizeQualifiers(boolean dontNormalizeQualifiers)
void	setFromDependency(boolean fromDependency)
void	setGeneratedSet(ResourceSet generatedSet)
void	setIgnoredPatterns(java.lang.String aaptStylePattern)
void	setPreprocessor(ResourcePreprocessor preprocessor)
void	setResourcesWhitelist(com.google.common.collect.ImmutableSet<com.android.resources.ResourceFolderType> whitelist)
void	setShouldParseResourceIds(boolean shouldParse)
void	setTrackSourcePositions(boolean shouldTrack)
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 java.lang.Object

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

Field Detail

ATTR_GENERATED_SET

public static final java.lang.String ATTR_GENERATED_SET

See Also:

Constant Field Values

ATTR_FROM_DEPENDENCY

public static final java.lang.String ATTR_FROM_DEPENDENCY

See Also:

Constant Field Values

ATTR_AAPT_NAMESPACE

public static final java.lang.String ATTR_AAPT_NAMESPACE

See Also:

Constant Field Values

Constructor Detail

ResourceSet

public ResourceSet(@NonNull
                   java.lang.String name,
                   @NonNull
                   com.android.ide.common.rendering.api.ResourceNamespace namespace,
                   java.lang.String libraryName,
                   boolean validateEnabled)

Method Detail

getLibraryName

public java.lang.String getLibraryName()

setGeneratedSet

public void setGeneratedSet(ResourceSet generatedSet)

setPreprocessor

public void setPreprocessor(@NonNull
                            ResourcePreprocessor preprocessor)

setShouldParseResourceIds

public void setShouldParseResourceIds(boolean shouldParse)

setDontNormalizeQualifiers

public void setDontNormalizeQualifiers(boolean dontNormalizeQualifiers)

setTrackSourcePositions

public void setTrackSourcePositions(boolean shouldTrack)

setCheckDuplicates

public void setCheckDuplicates(boolean value)

Tells the resource set whether to check for duplicate resource items or not.

Checking for duplicate items has to be turned off when loading resources of the Android framework to avoid bogus errors. See, for example, prebuilts/studio/layoutlib/data/res/values/attrs.xml.

createSet

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

createFileAndItems

protected ResourceFile createFileAndItems(java.io.File sourceFolder,
                                          java.io.File file,
                                          com.android.utils.ILogger logger)
                                   throws MergingException

Throws:

MergingException

createFileAndItemsFromXml

protected ResourceFile createFileAndItemsFromXml(@NonNull
                                                 java.io.File file,
                                                 @NonNull
                                                 org.w3c.dom.Node fileNode)
                                          throws MergingException

Creates a DataFile and associated DataItems from an XML node from a file created with DataSet.appendToXml(Node, Document, MergeConsumer, boolean)

Parameters:

file - the file represented by the DataFile

fileNode - the XML node.

Returns:

a DataFile

Throws:

MergingException

setResourcesWhitelist

public void setResourcesWhitelist(@NonNull
                                  com.google.common.collect.ImmutableSet<com.android.resources.ResourceFolderType> whitelist)

readSourceFolder

protected void readSourceFolder(java.io.File sourceFolder,
                                com.android.utils.ILogger logger)
                         throws MergingException

Reads the content of a data folders and loads the DataItem. This should generate DataFiles, and process them with processNewDataFile(java.io.File, DataFile, boolean).

Parameters:

sourceFolder - the source folder to load the resources from.

Throws:

MergingException - if something goes wrong

isValidSourceFile

protected boolean isValidSourceFile(@NonNull
                                    java.io.File sourceFolder,
                                    @NonNull
                                    java.io.File file)

handleNewFile

@Nullable
protected ResourceFile handleNewFile(java.io.File sourceFolder,
                                               java.io.File file,
                                               com.android.utils.ILogger logger)
                                        throws MergingException

Throws:

MergingException

handleRemovedFile

protected boolean handleRemovedFile(java.io.File removedFile)

handleChangedFile

protected boolean handleChangedFile(@NonNull
                                    java.io.File sourceFolder,
                                    @NonNull
                                    java.io.File changedFile,
                                    @NonNull
                                    com.android.utils.ILogger logger)
                             throws MergingException

Throws:

MergingException

isFromDependency

public boolean isFromDependency()

setFromDependency

public void setFromDependency(boolean fromDependency)

getNamespace

@NonNull
public com.android.ide.common.rendering.api.ResourceNamespace getNamespace()

equals

public boolean equals(java.lang.Object o)

hashCode

public int hashCode()

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.

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.

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

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

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 should be ignored

getValidateEnabled

protected boolean getValidateEnabled()