com.android.ide.common.resources.configuration

Class UiModeQualifier

java.lang.Object

com.android.ide.common.resources.configuration.ResourceQualifier

com.android.ide.common.resources.configuration.EnumBasedResourceQualifier

com.android.ide.common.resources.configuration.UiModeQualifier

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ResourceQualifier>

public final class UiModeQualifier
extends EnumBasedResourceQualifier

Resource Qualifier for UI Mode.

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
UiModeQualifier()
UiModeQualifier(com.android.resources.UiMode value)

Method Summary

Modifier and Type	Method and Description
boolean	checkAndSet(java.lang.String value, FolderConfiguration config) Check if the value is valid for this qualifier, and if so sets the value into a Folder Configuration.
com.android.resources.ResourceEnum	getEnumValue()
java.lang.String	getName() Returns the human readable name of the qualifier.
java.lang.String	getShortName() Returns a shorter human readable name for the qualifier.
com.android.resources.UiMode	getValue()
boolean	isBetterMatchThan(ResourceQualifier compareTo, ResourceQualifier reference) Returns true if the receiver (this) is a better match for the given reference than the given compareTo comparable.
boolean	isMatchFor(ResourceQualifier qualifier) Returns whether the given qualifier is a match for the receiver.
int	since() Returns the API level when this qualifier was added to Android.

Methods inherited from class com.android.ide.common.resources.configuration.EnumBasedResourceQualifier

equals, getFolderSegment, getLongDisplayValue, getShortDisplayValue, hasFakeValue, hashCode, isValid

Methods inherited from class com.android.ide.common.resources.configuration.ResourceQualifier

compareTo, deprecated, getNullQualifier, isValid, toString

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

UiModeQualifier

public UiModeQualifier()

UiModeQualifier

public UiModeQualifier(com.android.resources.UiMode value)

Method Detail

getValue

public com.android.resources.UiMode getValue()

getEnumValue

public com.android.resources.ResourceEnum getEnumValue()

Specified by:

getEnumValue in class EnumBasedResourceQualifier

getName

public java.lang.String getName()

Description copied from class: ResourceQualifier

Returns the human readable name of the qualifier.

Specified by:

getName in class ResourceQualifier

getShortName

public java.lang.String getShortName()

Description copied from class: ResourceQualifier

Returns a shorter human readable name for the qualifier.

Specified by:

getShortName in class ResourceQualifier

See Also:

ResourceQualifier.getName()

since

public int since()

Description copied from class: ResourceQualifier

Returns the API level when this qualifier was added to Android.

Specified by:

since in class ResourceQualifier

checkAndSet

public boolean checkAndSet(java.lang.String value,
                           FolderConfiguration config)

Description copied from class: ResourceQualifier

Check if the value is valid for this qualifier, and if so sets the value into a Folder Configuration.

Specified by:

checkAndSet in class ResourceQualifier

Parameters:

value - The value to check and set. Must not be null.

config - The folder configuration to receive the value. Must not be null.

Returns:

true if the value was valid and was set.

isMatchFor

public boolean isMatchFor(ResourceQualifier qualifier)

Description copied from class: ResourceQualifier

Returns whether the given qualifier is a match for the receiver. The default implementation returns the result of ResourceQualifier.equals(Object). Children class that re-implements this must implement (ResourceQualifier, ResourceQualifier) too.

Overrides:

isMatchFor in class ResourceQualifier

Parameters:

qualifier - the reference qualifier

Returns:

true if the receiver is a match.

isBetterMatchThan

public boolean isBetterMatchThan(@Nullable
                                 ResourceQualifier compareTo,
                                 @NonNull
                                 ResourceQualifier reference)

Description copied from class: ResourceQualifier

Returns true if the receiver (this) is a better match for the given reference than the given compareTo comparable.

Overrides:

isBetterMatchThan in class ResourceQualifier

Parameters:

compareTo - The ResourceQualifier to compare to.

reference - The reference qualifier value for which the match is (from phone's folderConfig).