ch.jalu.configme.beanmapper.propertydescription

Interface BeanPropertyDescription

All Known Implementing Classes:

BeanPropertyDescriptionImpl

public interface BeanPropertyDescription

Represents a property within a bean class, as used in MapperImpl. There, for instance, there is a BeanDescriptionFactory field responsible for creating bean descriptions.

Default implementation is BeanPropertyDescriptionImpl.

Method Summary

Modifier and Type	Method and Description
@NotNull BeanPropertyComments	getComments()
@NotNull String	getName()
@NotNull TypeInformation	getTypeInformation()
@Nullable Object	getValue(@NotNull Object bean) Returns the value of the property for the given bean.
void	setValue(@NotNull Object bean, @NotNull Object value) Sets the given value on the provided bean for this property.

Method Detail

getName

@NotNull
@NotNull String getName()

Returns:

the name of the property in the configuration file

getTypeInformation

@NotNull
@NotNull TypeInformation getTypeInformation()

Returns:

property type

setValue

void setValue(@NotNull
              @NotNull Object bean,
              @NotNull
              @NotNull Object value)

Sets the given value on the provided bean for this property. The value should correspond to the property type.

Parameters:

bean - the bean to set the property on

value - the value to set

getValue

@Nullable
@Nullable Object getValue(@NotNull
                                    @NotNull Object bean)

Returns the value of the property for the given bean.

Parameters:

bean - the bean to read the property from

Returns:

the value of the property (can be null)

getComments

@NotNull
@NotNull BeanPropertyComments getComments()

Returns:

the comments associated with this property