Package org.eclipse.scanning.api.annotation.ui

Class FieldValue

java.lang.Object

org.eclipse.scanning.api.annotation.ui.FieldValue

public class FieldValue
extends Object

Class to be used for editing the field of a Model

Reads annotations used on the models field and provides discovery information about the field.

Constructor Summary

Constructors

Constructor	Description
FieldValue(Object model, String name)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Object	get()	Get fields value
Object	get(boolean create)
static Object	get(Object model, String name)	Tries to find the no-argument getter for this field, ignoring case so that camel case may be used in method names.
FieldDescriptor	getAnnotation()
String	getDisplayName()
Object	getModel()
String	getName()
Class<? extends Object>	getType()
int	hashCode()
boolean	isFileProperty()
static boolean	isModelField(Object model, String name)
void	set(Object value)	Set fields value
void	setModel(IScanPathModel model)
void	setName(String name)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

FieldValue

public FieldValue(Object model,
 String name)

Method Details

getModel

public Object getModel()

setModel

public void setModel(IScanPathModel model)

getName

public String getName()

setName

public void setName(String name)

getDisplayName

public String getDisplayName()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getType

public Class<? extends Object> getType()
                                throws NoSuchFieldException,
SecurityException

Throws:

NoSuchFieldException

SecurityException

getAnnotation

public FieldDescriptor getAnnotation()

isFileProperty

public boolean isFileProperty()

set

public void set(Object value)
         throws Exception

Set fields value

Parameters:

value -

Throws:

Exception

get

public Object get()

Get fields value

Returns:

value

get

public Object get(boolean create)
           throws IllegalAccessException,
IllegalArgumentException,
InvocationTargetException,
InstantiationException,
NoSuchMethodException,
SecurityException

Throws:

IllegalAccessException

IllegalArgumentException

InvocationTargetException

InstantiationException

NoSuchMethodException

SecurityException

get

public static Object get(Object model,
 String name)
                  throws IllegalAccessException,
IllegalArgumentException,
InvocationTargetException

Tries to find the no-argument getter for this field, ignoring case so that camel case may be used in method names. This means that this method is not particularly fast, so avoid calling in big loops!

Throws:

InvocationTargetException

IllegalArgumentException

IllegalAccessException

isModelField

public static boolean isModelField(Object model,
 String name)
                            throws SecurityException

Throws:

SecurityException

toString

public String toString()

Overrides:

toString in class Object