/*******************************************************************************
* Copyright (c) 2008, 2015 Matthew Hall and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Matthew Hall - initial API and implementation (bug 195222)
******************************************************************************/
package org.eclipse.core.databinding.beans;
import org.eclipse.core.databinding.property.list.IListProperty;
/**
* An {@link IListProperty} extension interface with convenience methods for
* creating nested bean properties.
*
* @since 1.2
*/
public interface IBeanListProperty extends IBeanProperty, IListProperty {
/**
* Returns a master-detail combination of this property and the specified
* value property.
*
* @param propertyName
* the value property to observe. May be nested e.g.
* "parent.name"
* @return a nested combination of this property and the specified value
* property.
* @see #values(IBeanValueProperty)
*/
public IBeanListProperty values(String propertyName);
/**
* Returns a master-detail combination of this property and the specified
* value property.
*
* @param propertyName
* the value property to observe. May be nested e.g.
* "parent.name"
* @param valueType
* the value type of the named property
* @return a master-detail combination of this property and the specified
* value property.
* @see #values(IBeanValueProperty)
*/
public IBeanListProperty values(String propertyName, Class valueType);
/**
* Returns a master-detail combination of this property and the specified
* value property. The returned property will observe the specified value
* property for all elements observed by this list property.
* <p>
* Example:
*
* <pre>
* // Observes the list-typed "children" property of a Person object,
* // where the elements are Person objects
* IBeanListProperty children = BeanProperties.list(Person.class, "children",
* Person.class);
* // Observes the string-typed "name" property of a Person object
* IBeanValueProperty name = BeanProperties.value(Person.class, "name");
* // Observes the names of children of a Person object.
* IBeanListProperty childrenNames = children.values(name);
* </pre>
*
* @param property
* the detail property to observe
* @return a master-detail combination of this property and the specified
* value property.
*/
public IBeanListProperty values(IBeanValueProperty property);
}