3.2.9.3.2. Property Types

The following property types are supported in the platform out-of-the-box:

  • String, primitive types and their object wrappers (boolean, Boolean, int, Integer, etc.)

  • enum. The property value is stored in a file or in the database as the value name of the enumeration.

    If the enum implements the EnumClass interface and has the static fromId() method for getting a value by an identifier, you can specify that the enum identifier should be stored instead of value with the @EnumStore annotation. For example:

    @Property("myapp.defaultCustomerGrade")
@DefaultInteger(10)
@EnumStore(EnumStoreMode.ID)
CustomerGrade getDefaultCustomerGrade();

@EnumStore(EnumStoreMode.ID)
void setDefaultCustomerGrade(CustomerGrade grade);

  • Persistent entity classes. When accessing a property of the entity type, the instance defined by the property value is loaded from the database.

To support arbitrary types, use TypeStringify and TypeFactory classes to convert the value to/from a string and specify these classes for the property with @Stringify and @Factory annotations.

Let us consider this process using the UUID type as an example.

  1. Create class com.haulmont.cuba.core.config.type.UuidTypeFactory inherited from com.haulmont.cuba.core.config.type.TypeFactory and implement the following method in it:

    public Object build(String string) {
    if (string == null) {
        return null;
    }
    return UUID.fromString(string);
}

  2. There is no need to create TypeStringify as toString() method is sufficient in this case.

  3. Annotate the property in the configuration interface:

    @Factory(factory = UuidTypeFactory.class)
UUID getUuidProp();
void setUuidProp(UUID value);

The platform provides TypeFactory and Stringify implementations for the following types:

  • UUID – UuidTypeFactory, as described above. TypeStringify is redundant here, you can easily use toString() method for UUID.

  • java.util.Date – DateFactory and DateStringify. Date value must be specified in yyyy-MM-dd HH:mm:ss.SSS format, for example:

    cuba.test.dateProp = 2013-12-12 00:00:00.000

    Example of describing a date property in the configuration interface:

    @Property("cuba.test.dateProp")
@Factory(factory = DateFactory.class)
@Stringify(stringify = DateStringify.class)
Date getDateProp();

void setDateProp(Date date);

  • List<Integer> (the list of integers) – IntegerListTypeFactory and IntegerListStringify. The property value must be specified in the form of numbers, separated by spaces, for example:

    cuba.test.integerListProp = 1 2 3

    Example of describing a List<Integer> property in the configuration interface:

    @Property("cuba.test.integerListProp")
@Factory(factory = IntegerListTypeFactory.class)
@Stringify(stringify = IntegerListStringify.class)
List<Integer> getIntegerListProp();

void setIntegerListProp(List<Integer> list);

  • List<String> (the list of strings) – StringListTypeFactory and StringListStringify. The property value must be specified as a list of strings separated by "|" sign, for example:

    cuba.test.stringListProp = aaa|bbb|ccc

    Example of describing a List<String> property in the configuration interface:

    @Property("cuba.test.stringListProp")
@Factory(factory = StringListTypeFactory.class)
@Stringify(stringify = StringListStringify.class)
List<String> getStringListProp();

void setStringListProp(List<String> list);