ParameterUtilities

java.lang.Object

com.inductiveautomation.ignition.common.tags.config.ParameterUtilities

public class ParameterUtilities extends Object

This is a utility function to help deal with changes we've made to parameters over time (re-introduction of data types through ParameterValue).

Constructor Summary

Constructors

Constructor

Description

ParameterUtilities()
Method Summary

Modifier and Type

Method

Description

static BoundPropertySet

downgrade(BoundPropertySet ps)

Converts a modern parameter set back to the old style- used for version compatibility between remote systems.

static BoundPropertySet

ensureUpgraded(BoundPropertySet ps)

Like upgrade, but only copies set if changes are needed.

static BoundPropertySet

upgrade(BoundPropertySet ps)

Ensures the property set conforms to the new Parameters standard- keys are Parameters, values are ParameterValues.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- ParameterUtilities
  
  public ParameterUtilities()
Method Details
- ensureUpgraded
  
  public static BoundPropertySet ensureUpgraded(BoundPropertySet ps)
  
  Like upgrade, but only copies set if changes are needed.
- upgrade
  
  public static BoundPropertySet upgrade(BoundPropertySet ps)
  
  Ensures the property set conforms to the new Parameters standard- keys are Parameters, values are ParameterValues. Since this returns a new BoundPropertySet, be careful using it too liberally, in situations where the prop set might be extended and such.
- downgrade
  
  public static BoundPropertySet downgrade(BoundPropertySet ps)
  
  Converts a modern parameter set back to the old style- used for version compatibility between remote systems.