BindingProperty (GWT 2.8.2)

java.lang.Object
- com.google.gwt.dev.cfg.Property
- - com.google.gwt.dev.cfg.BindingProperty

All Implemented Interfaces:

Serializable, Comparable<Property>
```
public class BindingProperty
extends Property
```
Represents a single named deferred binding or configuration property that can answer with its value. The BindingProperty maintains two sets of values, the "defined" set and the "allowed" set. The allowed set must always be a subset of the defined set.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String GLOB_STAR
- Fields inherited from class com.google.gwt.dev.cfg.Property
  name

Fields
Modifier and Type	Field and Description
`static String`	`GLOB_STAR`

Constructor Summary

Constructors
Constructor and Description

BindingProperty(String name)

Constructors
Constructor and Description
`BindingProperty(String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCollapsedValues(String... values)` Add an equivalence set of property values.
`void`	`addDefinedValue(Condition condition, String definedValue)`
`void`	`addFallbackValue(String value, String fallbackValue)` Adds fall back value to given property name.
`boolean`	`equals(Object object)`
`String[]`	`getAllowedValues(Condition condition)` Returns the set of values defined in the module file.
`List<SortedSet<String>>`	`getCollapsedValuesSets()`
`com.google.gwt.thirdparty.guava.common.collect.ImmutableMap<Condition,SortedSet<String>>`	`getConditionalValues()` Returns a map containing the generated values for each condition, in the order they were added to the module files.
`String`	`getConstrainedValue()` If the BindingProperty has exactly one generated value across all conditions and permutations, return that value otherwise return `null`.
`String[]`	`getDefinedValues()` Returns the set of defined values in sorted order.
`String`	`getFallback()` Returns the fallback value for this property, or the empty string if none.
`Map<String,? extends List<? extends Set<String>>>`	`getFallbackValuesMap()` Returns the map of values to fall back values.
`String`	`getFirstAllowedValue()` Returns the first value from the list of defined values that is that is also allowed.
`String`	`getFirstGeneratedValue()` Returns the first value from the list of defined values that is actually generated.
`String[]`	`getGeneratedValues(Condition condition)` Returns the set of values for which the GWT compiler must generate permutations.
`PropertyProvider`	`getProvider()`
`Class<? extends PropertyProviderGenerator>`	`getProviderGenerator()`
`Set<String>`	`getRequiredProperties()`
`ConditionAll`	`getRootCondition()`
`int`	`hashCode()`
`boolean`	`isAllowedValue(String value)` Returns true if the supplied value is used based on the module file.
`boolean`	`isDefinedValue(String value)` Returns `true` if the value was previously provided to `addDefinedValue(Condition,String)`.
`boolean`	`isDerived()` Returns `true` if the value of this BindingProperty is always derived from other BindingProperties.
`boolean`	`isGeneratedValue(String value)` Returns true if the supplied value will be used during code generation.
`void`	`resetGeneratedValues()` Undo any value restrictions that have been put in place specifically on the set of values used for code generation as opposed to being present in the actual module definition.
`void`	`setFallback(String token)`
`void`	`setProvider(PropertyProvider provider)`
`void`	`setProviderGenerator(Class<? extends PropertyProviderGenerator> generator)` Set a provider generator for this property.
`void`	`setRootGeneratedValues(String... values)` Overrides the generated values for the root condition and clears the generated values for other conditions.
`void`	`setValues(Condition bindingPropertyCondition, String... values)` Replaces the allowed and generated values for a condition.

Methods inherited from class com.google.gwt.dev.cfg.Property
compareTo, getName, toString

Methods inherited from class java.lang.Object
finalize, getClass

Methods inherited from interface java.lang.Comparable
$isInstance

- Field Detail
  - GLOB_STAR
```
public static final String GLOB_STAR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BindingProperty
```
public BindingProperty(String name)
```
- Method Detail
  - addCollapsedValues
```
public void addCollapsedValues(String... values)
```
    Add an equivalence set of property values.
  - addDefinedValue
```
public void addDefinedValue(Condition condition,
                            String definedValue)
```
  - addFallbackValue
```
public void addFallbackValue(String value,
                             String fallbackValue)
```
    Adds fall back value to given property name.
    
    Parameters:
    
    value - the property value.
    
    fallbackValue - the fall back value for given property value.
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - getAllowedValues
```
public String[] getAllowedValues(Condition condition)
```
    Returns the set of values defined in the module file. (For code generation, use getGeneratedValues(com.google.gwt.dev.cfg.Condition) because this might be overridden.)
  - getGeneratedValues
```
public String[] getGeneratedValues(Condition condition)
```
    Returns the set of values for which the GWT compiler must generate permutations.
  - getCollapsedValuesSets
```
public List<SortedSet<String>> getCollapsedValuesSets()
```
  - getConditionalValues
```
public com.google.gwt.thirdparty.guava.common.collect.ImmutableMap<Condition,SortedSet<String>> getConditionalValues()
```
    Returns a map containing the generated values for each condition, in the order they were added to the module files.
  - getConstrainedValue
```
public String getConstrainedValue()
```
    If the BindingProperty has exactly one generated value across all conditions and permutations, return that value otherwise return null.
  - getDefinedValues
```
public String[] getDefinedValues()
```
    Returns the set of defined values in sorted order.
  - getFallback
```
public String getFallback()
```
    Returns the fallback value for this property, or the empty string if none.
    
    Returns:
    
    the fallback value
  - getFallbackValuesMap
```
public Map<String,? extends List<? extends Set<String>>> getFallbackValuesMap()
```
    Returns the map of values to fall back values. the list of fall back values is in decreasing order of preference.
    
    Returns:
    
    map of property value to fall back values.
  - getFirstAllowedValue
```
public String getFirstAllowedValue()
```
    Returns the first value from the list of defined values that is that is also allowed.
    
    Throws:
    
    IllegalStateException - if there is not at least one value that's both defined and allowed.
  - getFirstGeneratedValue
```
public String getFirstGeneratedValue()
```
    Returns the first value from the list of defined values that is actually generated.
    
    Throws:
    
    IllegalStateException - if there is not at least one value that's both defined and generated.
  - getProvider
```
public PropertyProvider getProvider()
```
  - getProviderGenerator
```
public Class<? extends PropertyProviderGenerator> getProviderGenerator()
```
    Returns:
    
    the provider generator class, or null if none.
  - getRequiredProperties
```
public Set<String> getRequiredProperties()
```
  - getRootCondition
```
public ConditionAll getRootCondition()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isDefinedValue
```
public boolean isDefinedValue(String value)
```
    Returns true if the value was previously provided to addDefinedValue(Condition,String).
  - isAllowedValue
```
public boolean isAllowedValue(String value)
```
    Returns true if the supplied value is used based on the module file.
  - isGeneratedValue
```
public boolean isGeneratedValue(String value)
```
    Returns true if the supplied value will be used during code generation.
  - isDerived
```
public boolean isDerived()
```
    Returns true if the value of this BindingProperty is always derived from other BindingProperties. That is, for each Condition in the BindingProperty, there is exactly one generated value.
  - resetGeneratedValues
```
public void resetGeneratedValues()
```
    Undo any value restrictions that have been put in place specifically on the set of values used for code generation as opposed to being present in the actual module definition.
  - setFallback
```
public void setFallback(String token)
```
  - setProvider
```
public void setProvider(PropertyProvider provider)
```
  - setProviderGenerator
```
public void setProviderGenerator(Class<? extends PropertyProviderGenerator> generator)
```
    Set a provider generator for this property.
  - setValues
```
public void setValues(Condition bindingPropertyCondition,
                      String... values)
```
    Replaces the allowed and generated values for a condition. If it is the root condition, clears all other conditions.
    
    Throws:
    
    IllegalArgumentException - if any value isn't currently defined.
  - setRootGeneratedValues
```
public void setRootGeneratedValues(String... values)
```
    Overrides the generated values for the root condition and clears the generated values for other conditions. This has no effect on the allowed values and ignores them. It's intended for artificially restricting permutations in special modes like Super Dev Mode and the GWTTestCase runner.
    
    Throws:
    
    IllegalArgumentException - if any value isn't currently defined.

Class BindingProperty

Field Summary

Fields inherited from class com.google.gwt.dev.cfg.Property

Constructor Summary

Method Summary

Methods inherited from class com.google.gwt.dev.cfg.Property

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Comparable

Field Detail

GLOB_STAR

Constructor Detail

BindingProperty

Method Detail

addCollapsedValues

addDefinedValue

addFallbackValue

equals

getAllowedValues

getGeneratedValues

getCollapsedValuesSets

getConditionalValues

getConstrainedValue

getDefinedValues

getFallback

getFallbackValuesMap

getFirstAllowedValue

getFirstGeneratedValue

getProvider

getProviderGenerator

getRequiredProperties

getRootCondition

hashCode

isDefinedValue

isAllowedValue

isGeneratedValue

isDerived

resetGeneratedValues

setFallback

setProvider

setProviderGenerator

setValues

setRootGeneratedValues