com.android.ide.common.resources

Class ResourceMergerItem

java.lang.Object

com.android.ide.common.resources.ResourceMergerItem

All Implemented Interfaces:

Configurable, ResourceItem, java.io.Serializable, java.lang.Comparable<ResourceMergerItem>

Direct Known Subclasses:

SourcelessResourceMergerItem

public class ResourceMergerItem
extends java.lang.Object
implements java.lang.Comparable<ResourceMergerItem>, ResourceItem

A resource.

Includes the name, type, source file as a ResourceFile and an optional Node in case of a resource coming from a value file.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_DESCRIPTION The name of the synthetic XML attribute used for storing ATTR description.
static java.lang.String	ATTR_GROUP_NAME The name of the synthetic XML attribute used for storing ATTR group name.
protected com.android.ide.common.rendering.api.ResourceValue	mResourceValue

Fields inherited from interface com.android.ide.common.resources.ResourceItem

ATTR_EXAMPLE, BY_KEY, XLIFF_G_TAG, XLIFF_NAMESPACE_PREFIX

Constructor Summary

Constructors

Constructor and Description
ResourceMergerItem(java.lang.String name, com.android.ide.common.rendering.api.ResourceNamespace namespace, com.android.resources.ResourceType type, org.w3c.dom.Node value, java.lang.String libraryName) Constructs the object with a name, type and optional value.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ResourceMergerItem other)
boolean	compareValueWith(ResourceMergerItem resource) Compares the ResourceItem getValue() together and returns true if they are the same.
boolean	equals(java.lang.Object o)
FolderConfiguration	getConfiguration() Returns the FolderConfiguration for this object.
java.io.File	getFile() Returns the File from which this DataItem was created, if known.
boolean	getIgnoredFromDiskMerge()
java.lang.String	getKey() Returns a key for this resource.
java.lang.String	getLibraryName() Returns name of the library which defines this resource, or null for app resources.
java.lang.String	getName() Returns the name of the item.
com.android.ide.common.rendering.api.ResourceNamespace	getNamespace() Returns the of this resource.
java.lang.String	getQualifiers() Returns the resource item qualifiers.
com.android.ide.common.rendering.api.ResourceReference	getReferenceToSelf() Returns a ResourceReference that points to this resource.
com.android.ide.common.rendering.api.ResourceValue	getResourceValue() Returns a ResourceValue built from parsing the XML for this resource.
com.android.ide.common.util.PathString	getSource() Returns the PathString for the file from which this ResourceItem was created, or null if the resource is not associated with a file.
F	getSourceFile() Returns the DataFile the item is coming from.
DataFile.FileType	getSourceType()
protected int	getStatus() Obtains the full status of the data item; should not generally be used except for debug purposes.
com.android.resources.ResourceType	getType() Returns the type of this resource.
org.w3c.dom.Node	getValue() Returns the optional value of the resource.
java.lang.String	getValueText() Returns the optional string value of the resource.
java.lang.String	getXmlString(com.android.resources.ResourceType type, boolean system) Returns a formatted string usable in an XML to use for the ResourceMergerItem.
int	hashCode()
boolean	isFileBased() Returns true if the ResourceItem represents a whole file or a whole zip file entry, not an XML tag within a values XML file.
void	setIgnoredFromDiskMerge(boolean ignored)
void	setSourceFile(F sourceFile) Sets the DataFile.
java.lang.String	toString()
protected void	wasTouched() Hook invoked when the data item has been touched.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.android.ide.common.resources.ResourceItem

getName

Field Detail

ATTR_DESCRIPTION

public static final java.lang.String ATTR_DESCRIPTION

The name of the synthetic XML attribute used for storing ATTR description.

See Also:

Constant Field Values

ATTR_GROUP_NAME

public static final java.lang.String ATTR_GROUP_NAME

The name of the synthetic XML attribute used for storing ATTR group name.

See Also:

Constant Field Values

mResourceValue

@Nullable
protected com.android.ide.common.rendering.api.ResourceValue mResourceValue

Constructor Detail

ResourceMergerItem

public ResourceMergerItem(@NonNull
                          java.lang.String name,
                          @NonNull
                          com.android.ide.common.rendering.api.ResourceNamespace namespace,
                          @NonNull
                          com.android.resources.ResourceType type,
                          @Nullable
                          org.w3c.dom.Node value,
                          @Nullable
                          java.lang.String libraryName)

Constructs the object with a name, type and optional value.

Note that the object is not fully usable as-is. It must be added to a ResourceFile first.

Parameters:

name - the name of the resource

namespace - the namespace of the resource

type - the type of the resource

value - an optional Node that represents the resource value.

libraryName - the name of the library the resource belongs to, or null if the resource does not belong to a library

Method Detail

getType

@NonNull
public com.android.resources.ResourceType getType()

Description copied from interface: ResourceItem

Returns the type of this resource.

Specified by:

getType in interface ResourceItem

getValue

@Nullable
public org.w3c.dom.Node getValue()

Returns the optional value of the resource. Can be null

Returns:

the value or null.

getValueText

@Nullable
public java.lang.String getValueText()

Returns the optional string value of the resource.

Returns:

the value or null.

getLibraryName

@Nullable
public java.lang.String getLibraryName()

Description copied from interface: ResourceItem

Returns name of the library which defines this resource, or null for app resources.

The contents of the string depend on the build system used to create the ResourceItems.

Specified by:

getLibraryName in interface ResourceItem

getNamespace

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

Description copied from interface: ResourceItem

Returns the of this resource.

Specified by:

getNamespace in interface ResourceItem

getQualifiers

@NonNull
public java.lang.String getQualifiers()

Returns the resource item qualifiers.

Returns:

the qualifiers

getSourceType

@NonNull
public DataFile.FileType getSourceType()

getReferenceToSelf

@NonNull
public com.android.ide.common.rendering.api.ResourceReference getReferenceToSelf()

Description copied from interface: ResourceItem

Returns a ResourceReference that points to this resource.

Specified by:

getReferenceToSelf in interface ResourceItem

getConfiguration

@NonNull
public FolderConfiguration getConfiguration()

Description copied from interface: Configurable

Returns the FolderConfiguration for this object.

Specified by:

getConfiguration in interface Configurable

getKey

@NonNull
public java.lang.String getKey()

Returns a key for this resource. They key uniquely identifies this resource by combining resource type, qualifiers, namespace and name.

If the resource has not been added to a ResourceFile, this will throw an IllegalStateException.

Specified by:

getKey in interface ResourceItem

Returns:

the key for this resource.

Throws:

java.lang.IllegalStateException - if the resource is not added to a ResourceFile

wasTouched

protected void wasTouched()

Hook invoked when the data item has been touched. The default implementation does nothing.

getResourceValue

@NonNull
public com.android.ide.common.rendering.api.ResourceValue getResourceValue()

Description copied from interface: ResourceItem

Returns a ResourceValue built from parsing the XML for this resource. This can be used to inspect the value of the resource.

The concrete type of the returned object depends on ResourceItem.getType().

Specified by:

getResourceValue in interface ResourceItem

Returns:

the parsed ResourceValue or null if there was an error parsing the XML or the XML is no longer accessible (this may be the case in the IDE, when the item is based on old PSI).

getSource

@Nullable
public com.android.ide.common.util.PathString getSource()

Description copied from interface: ResourceItem

Returns the PathString for the file from which this ResourceItem was created, or null if the resource is not associated with a file. The returned PathString may point to a file on the local file system, or to a zip file entry as possible for AAR resources.

Specified by:

getSource in interface ResourceItem

isFileBased

public boolean isFileBased()

Description copied from interface: ResourceItem

Returns true if the ResourceItem represents a whole file or a whole zip file entry, not an XML tag within a values XML file. This is the case for e.g. layouts or colors defined as state lists.

Specified by:

isFileBased in interface ResourceItem

getXmlString

public java.lang.String getXmlString(com.android.resources.ResourceType type,
                                     boolean system)

Returns a formatted string usable in an XML to use for the ResourceMergerItem.

Parameters:

system - Whether this is a system resource or a project resource.

Returns:

a string in the format @[type]/[name]

compareValueWith

public boolean compareValueWith(ResourceMergerItem resource)

Compares the ResourceItem getValue() together and returns true if they are the same.

Parameters:

resource - The ResourceItem object to compare to.

Returns:

true if equal

toString

public java.lang.String toString()

equals

public boolean equals(java.lang.Object o)

hashCode

public int hashCode()

compareTo

public int compareTo(@NonNull
                     ResourceMergerItem other)

Specified by:

compareTo in interface java.lang.Comparable<ResourceMergerItem>

setIgnoredFromDiskMerge

public void setIgnoredFromDiskMerge(boolean ignored)

getIgnoredFromDiskMerge

public boolean getIgnoredFromDiskMerge()

getName

@NonNull
public java.lang.String getName()

Returns the name of the item.

getSourceFile

@Nullable
public F getSourceFile()

Returns the DataFile the item is coming from.

setSourceFile

public void setSourceFile(@Nullable
                          F sourceFile)

Sets the DataFile. The item must not belong to a data file.

Parameters:

sourceFile - the data file, if null then the item is marked as being removed from the data file

getStatus

protected int getStatus()

Obtains the full status of the data item; should not generally be used except for debug purposes.

Returns:

the internal representation

getFile

@Nullable
public java.io.File getFile()

Returns the File from which this DataItem was created, if known. For some subclasses of DataItem, the file is known even if getSourceFile() returns null.