sirius.db.mixing

Interface PropertyFactory

All Superinterfaces:

sirius.kernel.di.std.Priorized

All Known Implementing Classes:

AmountProperty.Factory, BaseEntityRefListProperty.Factory, BooleanProperty.Factory, CompositePropertyFactory, ElasticRefProperty.Factory, EnumProperty.Factory, InstantProperty.Factory, IntegerProperty.Factory, LocalDateProperty.Factory, LocalDateTimeProperty.Factory, LocalTimeProperty.Factory, LongProperty.Factory, MongoRefProperty.Factory, MultiPointLocationProperty.Factory, NestedListProperty.Factory, SQLEntityRefProperty.Factory, StringIntMapProperty.Factory, StringListMapProperty.Factory, StringListProperty.Factory, StringLocalDateTimeMapProperty.Factory, StringMapProperty.Factory, StringNestedMapProperty.Factory, StringProperty.Factory

public interface PropertyFactory
extends sirius.kernel.di.std.Priorized

Describes a property factory which generates a Property for a given Field.

When scanning a class to compute its EntityDescriptor, for each field each PropertyFactory is queried. The first to return true as result of accepts(EntityDescriptor, Field) will be used to compute the property for a field by calling create(EntityDescriptor, AccessPath, Field, Consumer).

Field Summary

Fields inherited from interface sirius.kernel.di.std.Priorized

DEFAULT_PRIORITY

Method Summary

Modifier and Type	Method and Description
boolean	accepts(EntityDescriptor descriptor, Field field) Determines if the given field is handled by this property factory.
void	create(EntityDescriptor descriptor, AccessPath accessPath, Field field, Consumer<Property> propertyConsumer) Computes a Property for the given field.
default int	getPriority()

Method Detail

getPriority

default int getPriority()

Specified by:

getPriority in interface sirius.kernel.di.std.Priorized

accepts

boolean accepts(EntityDescriptor descriptor,
                @Nonnull
                Field field)

Determines if the given field is handled by this property factory.

Parameters:

descriptor - the current descriptor

field - the field to create a property from

Returns:

true if the factory can create a property for the given field, false otherwise

create

void create(@Nonnull
            EntityDescriptor descriptor,
            @Nonnull
            AccessPath accessPath,
            @Nonnull
            Field field,
            @Nonnull
            Consumer<Property> propertyConsumer)

Computes a Property for the given field.

Parameters:

descriptor - the descriptor to which the property will belong

accessPath - the accesspath used to reach the given property

field - the field to create a property from

propertyConsumer - the consumer which is used to process created properties