com.mathworks.mps.client.internal

Class MWStructToBeanFactory

java.lang.Object

com.mathworks.mps.client.internal.MWStructToBeanFactory

Direct Known Subclasses:

MWStructToBeanFactoryConstructor, MWStructToBeanFactorySetter

public abstract class MWStructToBeanFactory
extends Object

Abstract factory that will create instances of a user defined class corresponding to a MATLAB structure. There are 2 concrete implementations of this class based on following 2 strategies: 1. Create user defined class instances using the default constructor of the class and public setXXX methods for its properties 2. Create user defined class instances using a constructor that uses @ConstructorProperties annotation These concrete implementations are used while marshaling a MATLAB structure to Java

Field Summary

Fields

Modifier and Type	Field and Description
protected Class	beanType
protected Map<String,Class>	beanTypeMap
protected List<String>	propNames

Constructor Summary

Constructors

Constructor and Description
MWStructToBeanFactory(Class beanType, List<String> propNames, Map<String,Class> beanTypeMap) Initialize the common properties of the bean factory

Method Summary

Modifier and Type	Method and Description
Collection<Class>	getAllPropTypes() A collection of types of all the fields of the user defined class that can act as target for a MATLAB struct
Class	getBeanType() Get the underlying user defined class that will be used as target for a MATLAB structure
Class	getJavaClassForStructField(String fieldName) Returns type of the field referred to by fieldName
List<String>	getPropNames() Get a list containing all names of the fields of the user defined class.
abstract Object	newInstance(List<String> structFieldNames, Object... args) Create instance of user defined class referred to by beanType and assign the values to its fields from the passed in args array.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

beanType

protected final Class beanType

propNames

protected final List<String> propNames

beanTypeMap

protected final Map<String,Class> beanTypeMap

Constructor Detail

MWStructToBeanFactory

public MWStructToBeanFactory(Class beanType,
                             List<String> propNames,
                             Map<String,Class> beanTypeMap)

Initialize the common properties of the bean factory

Parameters:

beanType - user defined Java class that will be used as the target for a MATLAB struct

propNames - List of strings containing the names of the fields of beanType

beanTypeMap - A Map containing field names of beanType as keys and their types as values

Method Detail

getJavaClassForStructField

public Class getJavaClassForStructField(String fieldName)

Returns type of the field referred to by fieldName

Parameters:

fieldName - Name of the field

Returns:

type of the field

getBeanType

public Class getBeanType()

Get the underlying user defined class that will be used as target for a MATLAB structure

Returns:

underlying user defined class that will be used as target for a MATLAB structure

getPropNames

public List<String> getPropNames()

Get a list containing all names of the fields of the user defined class. These field names also represent the names of fields of a MATLAB structure

Returns:

list containing all names of the fields of the user defined class

getAllPropTypes

public Collection<Class> getAllPropTypes()

A collection of types of all the fields of the user defined class that can act as target for a MATLAB struct

Returns:

collection of types of all the fields of the user defined class

newInstance

public abstract Object newInstance(List<String> structFieldNames,
                                   Object... args)

Create instance of user defined class referred to by beanType and assign the values to its fields from the passed in args array. Every value in the args array is assignable to the field in the corresponding location in the list of field names

Parameters:

structFieldNames - names of fields of beanType. The index of a field in this list is used to get the value from args array

args - values of fields

Returns:

an instance of user defined class that has all its fields assigned the passed in values