org.diirt.vtype.next

Class VType

java.lang.Object

org.diirt.vtype.next.VType

Direct Known Subclasses:

Array, Scalar

public abstract class VType
extends Object

Tag interface to mark all the members of the value classes.

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
VType()

Method Summary

Modifier and Type	Method and Description
static Alarm	alarmOf(Object value) Null and non-VType safe utility to extracts alarm information.
static Alarm	alarmOf(Object value, boolean connected) Null and non-VType safe utility to extracts alarm information for a connection.
static Alarm	highestAlarmOf(List<?> values, boolean ignoreNull) Returns the value with highest severity.
static VType	toVType(Object javaObject) Converts a standard java type to VTypes.
static VType	toVType(Object javaObject, Alarm alarm) Converts a standard java type to VTypes.
static VType	toVType(Object javaObject, Alarm alarm, Time time, Display display) Converts a standard java type to VTypes.
static Class<?>	typeOf(Object obj) Returns the type of the object by returning the class object of one of the VXxx interfaces.

Methods inherited from class java.lang.Object

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

Constructor Detail

VType

public VType()

Method Detail

typeOf

public static Class<?> typeOf(Object obj)

Returns the type of the object by returning the class object of one of the VXxx interfaces. The getClass() methods returns the concrete implementation type, which is of little use. If no super-interface is found, Object.class is used.

Parameters:

obj - an object implementing a standard type

Returns:

the type is implementing

highestAlarmOf

public static Alarm highestAlarmOf(List<?> values,
                                   boolean ignoreNull)

Returns the value with highest severity. null values can either be ignored or treated as disconnected/missing value (Alarm.noValue()).

Parameters:

values - a list of values

ignoreNull - true to simply skip null values

Returns:

the value with highest alarm; can't be null

toVType

public static VType toVType(Object javaObject)

Converts a standard java type to VTypes. Returns null if no conversion is possible. Calls toVType(java.lang.Object, org.diirt.vtype.next.Alarm, org.diirt.vtype.next.Time, org.diirt.vtype.next.Display) with no alarm, time now and no display.

Parameters:

javaObject - the value to wrap

Returns:

the new VType value

toVType

public static VType toVType(Object javaObject,
                            Alarm alarm)

Converts a standard java type to VTypes. Returns null if no conversion is possible. Calls toVType(java.lang.Object, org.diirt.vtype.next.Alarm, org.diirt.vtype.next.Time, org.diirt.vtype.next.Display) with the given alarm, time now and no display.

Parameters:

javaObject - the value to wrap

alarm - the alarm

Returns:

the new VType value

toVType

public static VType toVType(Object javaObject,
                            Alarm alarm,
                            Time time,
                            Display display)

Converts a standard java type to VTypes. Returns null if no conversion is possible.

Types are converted as follow:

• Boolean -> VBoolean
• Number -> corresponding VNumber
• String -> VString
• number array -> corresponding VNumberArray
• ListNumber -> corresponding VNumberArray
• List -> if all elements are String, VStringArray

Parameters:

javaObject - the value to wrap

alarm - the alarm

time - the time

display - the display

Returns:

the new VType value

alarmOf

public static Alarm alarmOf(Object value)

Null and non-VType safe utility to extracts alarm information.

• If the value is an AlarmProvider, the associate alarm is returned.
• If the value is not an AlarmProvider, Alarm.NONE is returned.
• If the value is null, Alarm.NO_VALUE is returned.

Parameters:

value - the value

Returns:

the alarm information for the value

alarmOf

public static Alarm alarmOf(Object value,
                            boolean connected)

Null and non-VType safe utility to extracts alarm information for a connection.

• If the value is an AlarmProvider, the associate alarm is returned.
• If the value is not an AlarmProvider, Alarm.NONE is returned.
• If the value is null and connected is true, Alarm.NO_VALUE is returned.
• If the value is null and disconnected is true, Alarm.DISCONNECTED is returned.

Parameters:

value - a value

connected - the connection status

Returns:

the alarm information