com.android.ide.common.resources

Class ResourceFile

java.lang.Object

com.android.ide.common.resources.DataFile<ResourceMergerItem>

com.android.ide.common.resources.ResourceFile

All Implemented Interfaces:

java.io.Serializable

public class ResourceFile
extends DataFile<ResourceMergerItem>

Represents a file in a resource folders.

It contains a link to the File, the qualifier string (which is the name of the folder after the first '-' character), a list of ResourceMergerItems and a type.

The type of the file is based on whether the file is located in a values folder (FileType#XML_VALUES) or in another folder (FileType#SINGLE_FILE or FileType#GENERATED_FILES).

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.android.ide.common.resources.DataFile

DataFile.FileType

Field Summary

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

mFile, mItems

Constructor Summary

Constructors

Constructor and Description
ResourceFile(java.io.File file, java.util.List<ResourceMergerItem> items, FolderConfiguration folderConfiguration) Creates a resource file with a list of resource items.
ResourceFile(java.io.File file, ResourceMergerItem item, FolderConfiguration folderConfiguration) Creates a resource file with a single resource item.

Method Summary

Modifier and Type	Method and Description
static ResourceFile	createSingle(java.io.File file, ResourceMergerItem item, java.lang.String qualifiers) Creates a resource file with a single resource item.
static ResourceFile	generatedFiles(java.io.File file, java.util.List<ResourceMergerItem> items, FolderConfiguration folderConfiguration)
FolderConfiguration	getFolderConfiguration()
java.lang.String	getQualifiers()
void	setQualifiers(java.lang.String qualifiers)
java.lang.String	toString()

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

addItem, addItems, getFile, getItemMap, getItems, init, init, removeItem, replace

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceFile

public ResourceFile(@NonNull
                    java.io.File file,
                    @NonNull
                    ResourceMergerItem item,
                    @NonNull
                    FolderConfiguration folderConfiguration)

Creates a resource file with a single resource item.

The source file is set on the item with DataItem.setSourceFile(DataFile)

The type of the ResourceFile will be FileType#SINGLE_FILE.

Parameters:

file - the File

item - the resource item

folderConfiguration - the folder configuration

ResourceFile

public ResourceFile(@NonNull
                    java.io.File file,
                    @NonNull
                    java.util.List<ResourceMergerItem> items,
                    @NonNull
                    FolderConfiguration folderConfiguration)

Creates a resource file with a list of resource items.

The source file is set on the items with DataItem.setSourceFile(DataFile)

The type of the ResourceFile will be FileType#XML_VALUES.

Parameters:

file - the File

items - the resource items

folderConfiguration - the folder configuration

Method Detail

generatedFiles

public static ResourceFile generatedFiles(@NonNull
                                          java.io.File file,
                                          @NonNull
                                          java.util.List<ResourceMergerItem> items,
                                          @NonNull
                                          FolderConfiguration folderConfiguration)

createSingle

public static ResourceFile createSingle(@NonNull
                                        java.io.File file,
                                        @NonNull
                                        ResourceMergerItem item,
                                        @NonNull
                                        java.lang.String qualifiers)

Creates a resource file with a single resource item.

This method parses the folder configuration from qualifiers for each file independently (which may be less performant than parsing it once for all files in a folder and supplying the parsed configuration).

getQualifiers

@NonNull
public java.lang.String getQualifiers()

setQualifiers

public void setQualifiers(@NonNull
                          java.lang.String qualifiers)

getFolderConfiguration

@NonNull
public FolderConfiguration getFolderConfiguration()

toString

public java.lang.String toString()

Overrides:

toString in class DataFile<ResourceMergerItem>