com.android.ide.common.resources

Class ResourceSet

java.lang.Object

com.android.ide.common.resources.DataSet<ResourceMergerItem,ResourceFile>

com.android.ide.common.resources.ResourceSet

All Implemented Interfaces:

SourceSet

Direct Known Subclasses:

GeneratedResourceSet

public class ResourceSet
extends DataSet<ResourceMergerItem,ResourceFile>

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 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 DataSet<ResourceMergerItem,ResourceFile>	createSet(java.lang.String name)
boolean	equals(java.lang.Object o)
java.lang.String	getLibraryName()
com.android.ide.common.rendering.api.ResourceNamespace	getNamespace()
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	isFromDependency()
protected boolean	isValidSourceFile(java.io.File sourceFolder, java.io.File file)
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	setPreprocessor(ResourcePreprocessor preprocessor)
void	setResourcesWhitelist(com.google.common.collect.ImmutableSet<com.android.resources.ResourceFolderType> whitelist)
void	setShouldParseResourceIds(boolean shouldParse)
void	setTrackSourcePositions(boolean shouldTrack)

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

addItem, addSource, addSources, checkFileForAndroidRes, checkItems, findMatchingSourceFile, getConfigName, getDataFile, getDataMap, getSourceFiles, getValidateEnabled, isEmpty, isIgnored, loadFile, loadFromFiles, processNewDataFile, setFolderFilter, setIgnoredPatterns, size, toString, updateWith

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 DataSet<ResourceMergerItem,ResourceFile> createSet(@NonNull
                                                                      java.lang.String name)

Specified by:

createSet in class DataSet<ResourceMergerItem,ResourceFile>

createFileAndItems

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

Specified by:

createFileAndItems in class DataSet<ResourceMergerItem,ResourceFile>

Throws:

MergingException

createFileAndItemsFromXml

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

Description copied from class: DataSet

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

Specified by:

createFileAndItemsFromXml in class DataSet<ResourceMergerItem,ResourceFile>

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

Description copied from class: DataSet

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

Specified by:

readSourceFolder in class DataSet<ResourceMergerItem,ResourceFile>

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)

Overrides:

isValidSourceFile in class DataSet<ResourceMergerItem,ResourceFile>

handleNewFile

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

Overrides:

handleNewFile in class DataSet<ResourceMergerItem,ResourceFile>

Throws:

MergingException

handleRemovedFile

protected boolean handleRemovedFile(java.io.File removedFile)

Overrides:

handleRemovedFile in class DataSet<ResourceMergerItem,ResourceFile>

handleChangedFile

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

Overrides:

handleChangedFile in class DataSet<ResourceMergerItem,ResourceFile>

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)

Overrides:

equals in class DataSet<ResourceMergerItem,ResourceFile>

hashCode

public int hashCode()

Overrides:

hashCode in class DataSet<ResourceMergerItem,ResourceFile>