com.inductiveautomation.ignition.common.config

Class PropertyUtils

java.lang.Object

com.inductiveautomation.ignition.common.config.PropertyUtils

public class PropertyUtils
extends java.lang.Object

Some basic functions that aide our use of properties, or help consolidate logic.

Constructor Summary

Constructors

Constructor and Description
PropertyUtils()

Method Summary

Modifier and Type	Method and Description
static <T> T	coerce(Property<T> target, java.lang.Object value) Attempts to coerce the provided value into the type expected by the provided property.
static java.lang.Object	coerceUnchecked(Property<?> target, java.lang.Object value) This version of coerce does not return a generic type, and also will return a string if the incoming value appears to be a reference.
static boolean	isDefault(Property<?> property, java.lang.Object value) Returns true if the value is *essentially* equal to the default value of the property.
static boolean	isReference(java.lang.Object value)
static <T extends Property<?>> T[]	values(java.lang.Class<?> classToSearch, java.lang.Class<? extends T> propType) Searches the provided class for static Property values and returns them as an array.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyUtils

public PropertyUtils()

Method Detail

coerce

public static <T> T coerce(Property<T> target,
                           java.lang.Object value)
                    throws PropertyTypeException

Attempts to coerce the provided value into the type expected by the provided property.

Throws:

PropertyTypeException

coerceUnchecked

public static java.lang.Object coerceUnchecked(Property<?> target,
                                               java.lang.Object value)
                                        throws PropertyTypeException

This version of coerce does not return a generic type, and also will return a string if the incoming value appears to be a reference.

Throws:

PropertyTypeException

isDefault

public static boolean isDefault(Property<?> property,
                                java.lang.Object value)

Returns true if the value is *essentially* equal to the default value of the property. "Essentially" means normal equality, but also, Empty List or PropertySet to null and vice versa.

values

public static <T extends Property<?>> T[] values(java.lang.Class<?> classToSearch,
                                                 java.lang.Class<? extends T> propType)

Searches the provided class for static Property values and returns them as an array. Does not return null.

Parameters:

classToSearch - the class that has static property definitions

propType - the class type of the properties.

isReference

public static boolean isReference(java.lang.Object value)