org.jage.platform.component.descriptor
Interface IComponentDescriptor

All Known Implementing Classes:

ComponentDescriptor

public interface IComponentDescriptor

An interface which describes a single component. It contains information about component type, its available properties and more.

A component descriptor provides information about the real implementation of the component, whilst a component definition describes its configuration.

Author:

AGH AgE Team

Method Summary

boolean	containsProperty(String name) Checks if described component contains a property with a given name.
Class<?>	getComponentType() Returns the component type.
List<List<Class<?>>>	getConstructorParametersTypes() Returns list containing sequences of parameters types of available constructors.
Collection<MetaProperty>	getOptionalProperties() Returns optional properties descriptions (meta-properties) of this component.
Collection<MetaProperty>	getProperties() Returns all properties descriptions (meta-properties) of this component.
Collection<MetaProperty>	getRequriedProperties() Returns required properties descriptions (meta-properties) of this component.

Method Detail

getComponentType

Class<?> getComponentType()

Returns the component type.

Returns:

class of the described component

getProperties

Collection<MetaProperty> getProperties()

Returns all properties descriptions (meta-properties) of this component.

Returns:

list of meta properties

getRequriedProperties

Collection<MetaProperty> getRequriedProperties()

Returns required properties descriptions (meta-properties) of this component. These properties are required to proper component initialization.

Returns:

list of required meta properties

getOptionalProperties

Collection<MetaProperty> getOptionalProperties()

Returns optional properties descriptions (meta-properties) of this component. These properties are not required for proper component initialization.

Returns:

list of optional meta properties

getConstructorParametersTypes

List<List<Class<?>>> getConstructorParametersTypes()

Returns list containing sequences of parameters types of available constructors.

Returns:

list of available constructor parameters

containsProperty

boolean containsProperty(String name)

Checks if described component contains a property with a given name.

Parameters:

name - name of a property

Returns:

true if this described component contains a needed property