Package com.vaadin.flow.data.binder
Interface PropertyDefinition<T,V>
-
- Type Parameters:
T- the type of the property setV- the property type
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
AbstractBeanPropertyDefinition,BeanPropertySet.NestedBeanPropertyDefinition
public interface PropertyDefinition<T,V> extends Serializable
A property from aPropertySet.- Since:
- 1.0
- Author:
- Vaadin Ltd
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description StringgetCaption()Gets the human readable caption to show for this property.ValueProvider<T,V>getGetter()Gets the value provider that is used for finding the value of this property for a bean.StringgetName()Gets the full name of this property.PropertyDefinition<T,?>getParent()Gets the parent property of this property if this is a sub-property of the property set.Class<?>getPropertyHolderType()Gets the type of the class containing this property.PropertySet<T>getPropertySet()Gets thePropertySetthat this property belongs to.Optional<Setter<T,V>>getSetter()Gets an optional setter for storing a property value in a bean.default StringgetTopLevelName()Gets the top level name of this property.Class<V>getType()Gets the type of this property.default booleanisSubProperty()Gets whether this property belongs to some other property in the property set, or directly to the property set.
-
-
-
Method Detail
-
getGetter
ValueProvider<T,V> getGetter()
Gets the value provider that is used for finding the value of this property for a bean.- Returns:
- the getter, not
null
-
getSetter
Optional<Setter<T,V>> getSetter()
Gets an optional setter for storing a property value in a bean.- Returns:
- the setter, or an empty optional if this property is read-only
-
getPropertyHolderType
Class<?> getPropertyHolderType()
Gets the type of the class containing this property.- Returns:
- the property type. not
null
-
getName
String getName()
Gets the full name of this property.- Returns:
- the property name, not
null
-
getTopLevelName
default String getTopLevelName()
Gets the top level name of this property.- Returns:
- the top level property name, not
null
-
getCaption
String getCaption()
Gets the human readable caption to show for this property.- Returns:
- the caption to show, not
null
-
getPropertySet
PropertySet<T> getPropertySet()
Gets thePropertySetthat this property belongs to.- Returns:
- the property set, not
null
-
getParent
PropertyDefinition<T,?> getParent()
Gets the parent property of this property if this is a sub-property of the property set. If this property belongs directly to the property set, it doesn't have a parent and this method returnsnull.- Returns:
- the parent property, may be
null
-
isSubProperty
default boolean isSubProperty()
Gets whether this property belongs to some other property in the property set, or directly to the property set.- Returns:
trueif this property is a sub-property of the property set it belongs to,falseotherwise
-
-