All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.vaadin.data.util.NestedPropertyDescriptor Maven / Gradle / Ivy

There is a newer version: 8.27.3
Show newest version
/*
 * Vaadin Framework 7
 *
 * Copyright (C) 2000-2024 Vaadin Ltd
 *
 * This program is available under Vaadin Commercial License and Service Terms.
 *
 * See  for the full
 * license.
 */
package com.vaadin.data.util;

import com.vaadin.data.Property;

/**
 * Property descriptor that is able to create nested property instances for a
 * bean.
 *
 * The property is specified in the dotted notation, e.g. "address.street", and
 * can contain multiple levels of nesting.
 *
 * @param 
 *            bean type
 *
 * @since 6.6
 */
public class NestedPropertyDescriptor
        implements VaadinPropertyDescriptor {

    private final String name;
    private final Class propertyType;

    /**
     * Creates a property descriptor that can create MethodProperty instances to
     * access the underlying bean property.
     *
     * @param name
     *            of the property in a dotted path format, e.g. "address.street"
     * @param beanType
     *            type (class) of the top-level bean
     * @throws IllegalArgumentException
     *             if the property name is invalid
     */
    public NestedPropertyDescriptor(String name, Class beanType)
            throws IllegalArgumentException {
        this.name = name;
        NestedMethodProperty property = new NestedMethodProperty(
                beanType, name);
        this.propertyType = property.getType();
    }

    @Override
    public String getName() {
        return name;
    }

    @Override
    public Class getPropertyType() {
        return propertyType;
    }

    @Override
    public Property createProperty(BT bean) {
        return new NestedMethodProperty(bean, name);
    }

}