com.android.ide.common.resources.configuration

Class FolderConfiguration

java.lang.Object

com.android.ide.common.resources.configuration.FolderConfiguration

All Implemented Interfaces:

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

public final class FolderConfiguration
extends java.lang.Object
implements java.lang.Comparable<FolderConfiguration>, java.io.Serializable

Represents the configuration for Resource Folders. All the properties have a default value which means that the property is not set.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.base.Splitter	QUALIFIER_SPLITTER Splitter which can be used to split qualifiers.

Constructor Summary

Constructors

Constructor and Description
FolderConfiguration()

Method Summary

Modifier and Type	Method and Description
void	add(FolderConfiguration config) Adds the non-qualifiers from the given config.
void	addQualifier(ResourceQualifier qualifier) Adds a qualifier to the FolderConfiguration
int	compareTo(FolderConfiguration folderConfig)
static FolderConfiguration	copyOf(FolderConfiguration original) Creates a copy of the given FolderConfiguration, that can be modified without affecting the original.
static FolderConfiguration	createDefault() Creates a FolderConfiguration with default qualifiers with no values for all indices.
boolean	equals(java.lang.Object obj)
<T extends Configurable> T	findMatchingConfigurable(java.util.List<T> configurables) Returns the best matching Configurable for this configuration.
<T extends Configurable> java.util.List<T>	findMatchingConfigurables(java.util.List<T> configurables) Tries to eliminate as many Configurables as possible.
static FolderConfiguration	getConfig(java.lang.Iterable<java.lang.String> folderSegments) Creates a FolderConfiguration matching the folder segments.
static FolderConfiguration	getConfig(java.lang.String[] folderSegments) Creates a FolderConfiguration matching the folder segments.
static FolderConfiguration	getConfigForFolder(java.lang.String folderName) Creates a FolderConfiguration matching the given folder name.
static FolderConfiguration	getConfigForQualifierString(java.lang.String qualifierString) Creates a FolderConfiguration matching the given qualifier string (just the qualifiers; e.g.
static FolderConfiguration	getConfigFromQualifiers(java.lang.Iterable<java.lang.String> qualifiers) Creates a FolderConfiguration matching the qualifiers.
static FolderConfiguration	getConfigFromQualifiers(java.util.Iterator<java.lang.String> qualifiers) Creates a FolderConfiguration matching the qualifiers.
CountryCodeQualifier	getCountryCodeQualifier()
DensityQualifier	getDensityQualifier()
java.lang.String	getFolderName(com.android.resources.ResourceFolderType folder) Returns the name of a folder with the configuration.
HighDynamicRangeQualifier	getHighDynamicRangeQualifier()
int	getHighestPriorityQualifier(int startIndex) Returns the index of the first non null ResourceQualifier starting at index startIndex
ResourceQualifier	getInvalidQualifier() Returns the first invalid qualifier, or null if they are all valid (or if none exists).
KeyboardStateQualifier	getKeyboardStateQualifier()
LayoutDirectionQualifier	getLayoutDirectionQualifier()
LocaleQualifier	getLocaleQualifier()
NavigationMethodQualifier	getNavigationMethodQualifier()
NavigationStateQualifier	getNavigationStateQualifier()
NetworkCodeQualifier	getNetworkCodeQualifier()
NightModeQualifier	getNightModeQualifier()
ResourceQualifier	getQualifier(int index) Returns a qualifier by its index.
static int	getQualifierCount() Returns the number of ResourceQualifier that make up a Folder configuration.
ResourceQualifier[]	getQualifiers() Returns an array of all the non null qualifiers.
java.lang.String	getQualifierString() Returns the folder configuration as a qualifier string, e.g.
ScreenDimensionQualifier	getScreenDimensionQualifier()
ScreenHeightQualifier	getScreenHeightQualifier()
ScreenOrientationQualifier	getScreenOrientationQualifier()
ScreenRatioQualifier	getScreenRatioQualifier()
ScreenRoundQualifier	getScreenRoundQualifier()
ScreenSizeQualifier	getScreenSizeQualifier()
ScreenWidthQualifier	getScreenWidthQualifier()
SmallestScreenWidthQualifier	getSmallestScreenWidthQualifier()
TextInputMethodQualifier	getTextInputMethodQualifier()
TouchScreenQualifier	getTouchTypeQualifier()
UiModeQualifier	getUiModeQualifier()
java.lang.String	getUniqueKey() Deprecated. Use getQualifierString() instead.
VersionQualifier	getVersionQualifier()
WideGamutColorQualifier	getWideColorGamutQualifier()
int	hashCode()
boolean	isDefault() Returns whether the configuration has only default values.
boolean	isMatchFor(FolderConfiguration referenceConfig) Returns whether the configuration is a match for the given reference config.
void	normalize() Normalize a folder configuration based on the API level of its qualifiers.
void	removeQualifier(ResourceQualifier qualifier) Removes a given qualifier from the FolderConfiguration.
void	reset() Resets the config setting qualifiers at all indices to null.
void	set(FolderConfiguration config) Sets the config from the qualifiers of a given config.
void	set(FolderConfiguration config, boolean nonFakeValuesOnly) Sets the config from the qualifiers of a given config.
void	setCountryCodeQualifier(CountryCodeQualifier qualifier)
void	setDensityQualifier(DensityQualifier qualifier)
void	setHighDynamicRangeQualifier(HighDynamicRangeQualifier qualifier)
void	setKeyboardStateQualifier(KeyboardStateQualifier qualifier)
void	setLayoutDirectionQualifier(LayoutDirectionQualifier qualifier)
void	setLocaleQualifier(LocaleQualifier qualifier)
void	setNavigationMethodQualifier(NavigationMethodQualifier qualifier)
void	setNavigationStateQualifier(NavigationStateQualifier qualifier)
void	setNetworkCodeQualifier(NetworkCodeQualifier qualifier)
void	setNightModeQualifier(NightModeQualifier qualifier)
void	setScreenDimensionQualifier(ScreenDimensionQualifier qualifier)
void	setScreenHeightQualifier(ScreenHeightQualifier qualifier)
void	setScreenOrientationQualifier(ScreenOrientationQualifier qualifier)
void	setScreenRatioQualifier(ScreenRatioQualifier qualifier)
void	setScreenRoundQualifier(ScreenRoundQualifier qualifier)
void	setScreenSizeQualifier(ScreenSizeQualifier qualifier)
void	setScreenWidthQualifier(ScreenWidthQualifier qualifier)
void	setSmallestScreenWidthQualifier(SmallestScreenWidthQualifier qualifier)
void	setTextInputMethodQualifier(TextInputMethodQualifier qualifier)
void	setTouchTypeQualifier(TouchScreenQualifier qualifier)
void	setUiModeQualifier(UiModeQualifier qualifier)
void	setVersionQualifier(VersionQualifier qualifier)
void	setWideColorGamutQualifier(WideGamutColorQualifier qualifier)
void	substract(FolderConfiguration config) Removes the qualifiers from the receiver if they are present (and valid) in the given configuration.
java.lang.String	toDisplayString() Returns a string valid for display purpose.
java.lang.String	toShortDisplayString() Returns a string for display purposes which uses only the short names of the qualifiers
java.lang.String	toString() Returns toDisplayString().
void	updateScreenWidthAndHeight() Updates the SmallestScreenWidthQualifier, ScreenWidthQualifier, and ScreenHeightQualifier based on the (required) values of ScreenDimensionQualifier DensityQualifier, and ScreenOrientationQualifier.

Methods inherited from class java.lang.Object

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

Field Detail

QUALIFIER_SPLITTER

public static final com.google.common.base.Splitter QUALIFIER_SPLITTER

Splitter which can be used to split qualifiers.

Constructor Detail

FolderConfiguration

public FolderConfiguration()

Method Detail

getConfig

@Nullable
public static FolderConfiguration getConfig(@NonNull
                                                      java.lang.String[] folderSegments)

Creates a FolderConfiguration matching the folder segments.

Parameters:

folderSegments - The segments of the folder name. The first segments should contain the name of the folder

Returns:

a FolderConfiguration object, or null if the folder name isn't valid

getConfig

@Nullable
public static FolderConfiguration getConfig(@NonNull
                                                      java.lang.Iterable<java.lang.String> folderSegments)

Creates a FolderConfiguration matching the folder segments.

Parameters:

folderSegments - The segments of the folder name. The first segments should contain the name of the folder

Returns:

a FolderConfiguration object, or null if the folder name isn't valid

See Also:

getConfig(String[])

getConfigFromQualifiers

@Nullable
public static FolderConfiguration getConfigFromQualifiers(@NonNull
                                                                    java.lang.Iterable<java.lang.String> qualifiers)

Creates a FolderConfiguration matching the qualifiers.

Parameters:

qualifiers - the qualifiers.

Returns:

a FolderConfiguration object, or null if the folder name isn't valid

getConfigFromQualifiers

@Nullable
public static FolderConfiguration getConfigFromQualifiers(@NonNull
                                                                    java.util.Iterator<java.lang.String> qualifiers)

Creates a FolderConfiguration matching the qualifiers.

Parameters:

qualifiers - An iterator on the qualifiers.

Returns:

a FolderConfiguration object, or null if the folder name isn't valid

getConfigForFolder

@Nullable
public static FolderConfiguration getConfigForFolder(@NonNull
                                                               java.lang.String folderName)

Creates a FolderConfiguration matching the given folder name.

Parameters:

folderName - the folder name

Returns:

a FolderConfiguration object, or null if the folder name isn't valid

copyOf

@NonNull
public static FolderConfiguration copyOf(@NonNull
                                                  FolderConfiguration original)

Creates a copy of the given FolderConfiguration, that can be modified without affecting the original.

getConfigForQualifierString

@Nullable
public static FolderConfiguration getConfigForQualifierString(@NonNull
                                                                        java.lang.String qualifierString)

Creates a FolderConfiguration matching the given qualifier string (just the qualifiers; e.g. for a folder like "values-en-rUS" this would be "en-rUS").

Parameters:

qualifierString - the qualifier string

Returns:

a FolderConfiguration object, or null if the qualifier string isn't valid

getQualifierCount

public static int getQualifierCount()

Returns the number of ResourceQualifier that make up a Folder configuration.

set

public void set(@Nullable
                FolderConfiguration config)

Sets the config from the qualifiers of a given config.

This is equivalent to set(config, false)

Parameters:

config - the configuration to set

See Also:

set(FolderConfiguration, boolean)

set

public void set(@Nullable
                FolderConfiguration config,
                boolean nonFakeValuesOnly)

Sets the config from the qualifiers of a given config.

Parameters:

config - the configuration to set

nonFakeValuesOnly - if set to true this ignore qualifiers for which the current value is a fake value.

See Also:

ResourceQualifier.hasFakeValue()

reset

public void reset()

Resets the config setting qualifiers at all indices to null.

substract

public void substract(@NonNull
                      FolderConfiguration config)

Removes the qualifiers from the receiver if they are present (and valid) in the given configuration.

add

public void add(@NonNull
                FolderConfiguration config)

Adds the non-qualifiers from the given config. Qualifiers that are null in the given config do not change in the receiver.

getInvalidQualifier

@Nullable
public ResourceQualifier getInvalidQualifier()

Returns the first invalid qualifier, or null if they are all valid (or if none exists).

addQualifier

public void addQualifier(@Nullable
                         ResourceQualifier qualifier)

Adds a qualifier to the FolderConfiguration

Parameters:

qualifier - the ResourceQualifier to add.

removeQualifier

public void removeQualifier(@NonNull
                            ResourceQualifier qualifier)

Removes a given qualifier from the FolderConfiguration.

Parameters:

qualifier - the ResourceQualifier to remove.

getQualifier

@Nullable
public ResourceQualifier getQualifier(int index)

Returns a qualifier by its index. The total number of qualifiers can be accessed by getQualifierCount().

Parameters:

index - the index of the qualifier to return.

Returns:

the qualifier or null if there are none at the index.

setCountryCodeQualifier

public void setCountryCodeQualifier(CountryCodeQualifier qualifier)

getCountryCodeQualifier

@Nullable
public CountryCodeQualifier getCountryCodeQualifier()

setNetworkCodeQualifier

public void setNetworkCodeQualifier(NetworkCodeQualifier qualifier)

getNetworkCodeQualifier

@Nullable
public NetworkCodeQualifier getNetworkCodeQualifier()

setLocaleQualifier

public void setLocaleQualifier(LocaleQualifier qualifier)

getLocaleQualifier

@Nullable
public LocaleQualifier getLocaleQualifier()

setLayoutDirectionQualifier

public void setLayoutDirectionQualifier(LayoutDirectionQualifier qualifier)

getLayoutDirectionQualifier

@Nullable
public LayoutDirectionQualifier getLayoutDirectionQualifier()

setSmallestScreenWidthQualifier

public void setSmallestScreenWidthQualifier(SmallestScreenWidthQualifier qualifier)

getSmallestScreenWidthQualifier

@Nullable
public SmallestScreenWidthQualifier getSmallestScreenWidthQualifier()

setScreenWidthQualifier

public void setScreenWidthQualifier(ScreenWidthQualifier qualifier)

getScreenWidthQualifier

@Nullable
public ScreenWidthQualifier getScreenWidthQualifier()

setScreenHeightQualifier

public void setScreenHeightQualifier(ScreenHeightQualifier qualifier)

getScreenHeightQualifier

@Nullable
public ScreenHeightQualifier getScreenHeightQualifier()

setScreenSizeQualifier

public void setScreenSizeQualifier(ScreenSizeQualifier qualifier)

getScreenSizeQualifier

@Nullable
public ScreenSizeQualifier getScreenSizeQualifier()

setScreenRatioQualifier

public void setScreenRatioQualifier(ScreenRatioQualifier qualifier)

getScreenRatioQualifier

@Nullable
public ScreenRatioQualifier getScreenRatioQualifier()

setScreenRoundQualifier

public void setScreenRoundQualifier(ScreenRoundQualifier qualifier)

getScreenRoundQualifier

@Nullable
public ScreenRoundQualifier getScreenRoundQualifier()

setWideColorGamutQualifier

public void setWideColorGamutQualifier(WideGamutColorQualifier qualifier)

getWideColorGamutQualifier

@Nullable
public WideGamutColorQualifier getWideColorGamutQualifier()

setHighDynamicRangeQualifier

public void setHighDynamicRangeQualifier(HighDynamicRangeQualifier qualifier)

getHighDynamicRangeQualifier

@Nullable
public HighDynamicRangeQualifier getHighDynamicRangeQualifier()

setScreenOrientationQualifier

public void setScreenOrientationQualifier(ScreenOrientationQualifier qualifier)

getScreenOrientationQualifier

@Nullable
public ScreenOrientationQualifier getScreenOrientationQualifier()

setUiModeQualifier

public void setUiModeQualifier(UiModeQualifier qualifier)

getUiModeQualifier

@Nullable
public UiModeQualifier getUiModeQualifier()

setNightModeQualifier

public void setNightModeQualifier(NightModeQualifier qualifier)

getNightModeQualifier

@Nullable
public NightModeQualifier getNightModeQualifier()

setDensityQualifier

public void setDensityQualifier(DensityQualifier qualifier)

getDensityQualifier

@Nullable
public DensityQualifier getDensityQualifier()

setTouchTypeQualifier

public void setTouchTypeQualifier(TouchScreenQualifier qualifier)

getTouchTypeQualifier

@Nullable
public TouchScreenQualifier getTouchTypeQualifier()

setKeyboardStateQualifier

public void setKeyboardStateQualifier(KeyboardStateQualifier qualifier)

getKeyboardStateQualifier

@Nullable
public KeyboardStateQualifier getKeyboardStateQualifier()

setTextInputMethodQualifier

public void setTextInputMethodQualifier(TextInputMethodQualifier qualifier)

getTextInputMethodQualifier

@Nullable
public TextInputMethodQualifier getTextInputMethodQualifier()

setNavigationStateQualifier

public void setNavigationStateQualifier(NavigationStateQualifier qualifier)

getNavigationStateQualifier

@Nullable
public NavigationStateQualifier getNavigationStateQualifier()

setNavigationMethodQualifier

public void setNavigationMethodQualifier(NavigationMethodQualifier qualifier)

getNavigationMethodQualifier

@Nullable
public NavigationMethodQualifier getNavigationMethodQualifier()

setScreenDimensionQualifier

public void setScreenDimensionQualifier(ScreenDimensionQualifier qualifier)

getScreenDimensionQualifier

@Nullable
public ScreenDimensionQualifier getScreenDimensionQualifier()

setVersionQualifier

public void setVersionQualifier(VersionQualifier qualifier)

getVersionQualifier

@Nullable
public VersionQualifier getVersionQualifier()

normalize

public void normalize()

Normalize a folder configuration based on the API level of its qualifiers.

updateScreenWidthAndHeight

public void updateScreenWidthAndHeight()

Updates the SmallestScreenWidthQualifier, ScreenWidthQualifier, and ScreenHeightQualifier based on the (required) values of ScreenDimensionQualifier DensityQualifier, and ScreenOrientationQualifier. Also the density cannot be Density.NODPI as it's not valid on a device.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isDefault

public boolean isDefault()

Returns whether the configuration has only default values.

getFolderName

@NonNull
public java.lang.String getFolderName(@NonNull
                                               com.android.resources.ResourceFolderType folder)

Returns the name of a folder with the configuration.

getUniqueKey

@Deprecated
 @NonNull
public java.lang.String getUniqueKey()

Deprecated. Use getQualifierString() instead.

getQualifierString

@NonNull
public java.lang.String getQualifierString()

Returns the folder configuration as a qualifier string, e.g. for the folder values-en-rUS this returns "en-rUS". For the default configuration it returns "".

toString

@NonNull
public java.lang.String toString()

Returns toDisplayString().

Overrides:

toString in class java.lang.Object

toDisplayString

@NonNull
public java.lang.String toDisplayString()

Returns a string valid for display purpose.

toShortDisplayString

@NonNull
public java.lang.String toShortDisplayString()

Returns a string for display purposes which uses only the short names of the qualifiers

compareTo

public int compareTo(@NonNull
                     FolderConfiguration folderConfig)

Specified by:

compareTo in interface java.lang.Comparable<FolderConfiguration>

findMatchingConfigurable

@Nullable
public <T extends Configurable> T findMatchingConfigurable(@Nullable
                                                                     java.util.List<T> configurables)

Returns the best matching Configurable for this configuration.

Parameters:

configurables - the list of Configurable to choose from.

Returns:

an item from the given list of Configurable or null. See http://d.android.com/guide/topics/resources/resources-i18n.html#best-match

findMatchingConfigurables

@NonNull
public <T extends Configurable> java.util.List<T> findMatchingConfigurables(@Nullable
                                                                                     java.util.List<T> configurables)

Tries to eliminate as many Configurables as possible. It skips the ResourceQualifier if it's not valid and assumes that all resources match it.

Parameters:

configurables - the list of Configurable to choose from.

Returns:

a list of items from the above list. This may be empty.

isMatchFor

public boolean isMatchFor(@Nullable
                          FolderConfiguration referenceConfig)

Returns whether the configuration is a match for the given reference config.

A match means that, for each qualifier of this config

• The reference config has no value set
• or, the qualifier of the reference config is a match. Depending on the qualifier type this does not mean the same exact value.

Parameters:

referenceConfig - The reference configuration to test against.

Returns:

true if the configuration matches.

getHighestPriorityQualifier

public int getHighestPriorityQualifier(int startIndex)

Returns the index of the first non null ResourceQualifier starting at index startIndex

Returns:

-1 if no qualifier was found.

createDefault

public static FolderConfiguration createDefault()

Creates a FolderConfiguration with default qualifiers with no values for all indices.

getQualifiers

@NonNull
public ResourceQualifier[] getQualifiers()

Returns an array of all the non null qualifiers.