Package com.inductiveautomation.perspective.common.property

Enum Origin

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Origin>
    public enum Origin
extends java.lang.Enum<Origin>
    Enum representing the origin of a property value.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      Binding
      Writes that come from a binding/transform generating a new value.
      BindingWriteback
      Writes that come from a binding writing back to its target because of a source change
      Browser
      Writes that come from the browser UI.
      Delegate
      Writes that are originated by server-side component delegate implementations
      Project
      Indicates a value that originated from the saved version of the view or session props.
      Script
      Writes that originate from a script call
      Session
      Writes that are originated automatically by the session itself.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.util.Set<Origin> ANY
      A set of all Origins

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.util.Set<Origin> allBut​(Origin origin)
      Returns a set of all Origins except the given one
      static Origin valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Origin[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • Browser

        public static final Origin Browser
        Writes that come from the browser UI.

      • Binding

        public static final Origin Binding
        Writes that come from a binding/transform generating a new value.

      • BindingWriteback

        public static final Origin BindingWriteback
        Writes that come from a binding writing back to its target because of a source change

      • Script

        public static final Origin Script
        Writes that originate from a script call

      • Delegate

        public static final Origin Delegate
        Writes that are originated by server-side component delegate implementations

      • Session

        public static final Origin Session
        Writes that are originated automatically by the session itself.

      • Project

        public static final Origin Project
        Indicates a value that originated from the saved version of the view or session props.

    • Field Detail

      • ANY

        public static final java.util.Set<Origin> ANY
        A set of all Origins

    • Method Detail

      • values

        public static Origin[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Origin c : Origin.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Origin valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • allBut

        public static java.util.Set<Origin> allBut​(Origin origin)
        Returns a set of all Origins except the given one