Package uk.ac.gda.client.properties.stage.position

Class ScannablePropertiesValue

java.lang.Object

uk.ac.gda.client.properties.stage.position.ScannablePropertiesValue

public class ScannablePropertiesValue
extends Object

Describes a scannable position in the client properties

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ScannablePropertiesValue.PositionType

Constructor Summary

Constructors

Constructor	Description
ScannablePropertiesValue()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Object	getPosition()	The type of this will depend on the scannable referred to by getScannableKeys().
ScannablePropertiesValue.PositionType	getPositionType()	A hint for interpreting getPosition().
ScannableKeys	getScannableKeys()	Identifies the scannable.
String	getScannableName()
int	hashCode()
void	setPosition(Object position)
void	setPositionType(ScannablePropertiesValue.PositionType positionType)
void	setScannableKeys(ScannableKeys scannableKeys)
void	setScannableName(String scannableName)

Methods inherited from class java.lang.Object

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

Constructor Details

ScannablePropertiesValue

public ScannablePropertiesValue()

Method Details

getScannableName

public String getScannableName()

setScannableName

public void setScannableName(String scannableName)

getScannableKeys

public ScannableKeys getScannableKeys()

Identifies the scannable. If null, get the scannable name directly via getScannableName()

setScannableKeys

public void setScannableKeys(ScannableKeys scannableKeys)

getPosition

public Object getPosition()

The type of this will depend on the scannable referred to by getScannableKeys().

May be null; see getPositionType() for a hint on handling.

setPosition

public void setPosition(Object position)

getPositionType

public ScannablePropertiesValue.PositionType getPositionType()

A hint for interpreting getPosition().

setPositionType

public void setPositionType(ScannablePropertiesValue.PositionType positionType)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object