Package com.inductiveautomation.perspective.common.property

Enum PropertyAccess

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<PropertyAccess>
    public enum PropertyAccess
extends java.lang.Enum<PropertyAccess>

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      PRIVATE
      Property will only exist in session property tree, not in browser.
      PROTECTED
      Property will be synchronized from the session to the browser, but writes from browser ignored.
      PUBLIC
      Property will be synchronized bidirectionally between session and browser
      SYSTEM
      Property's value is provided by the system.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static PropertyAccess valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PropertyAccess[] 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

      • PUBLIC

        public static final PropertyAccess PUBLIC
        Property will be synchronized bidirectionally between session and browser

      • PRIVATE

        public static final PropertyAccess PRIVATE
        Property will only exist in session property tree, not in browser. Attempts to write from browser ignored.

      • PROTECTED

        public static final PropertyAccess PROTECTED
        Property will be synchronized from the session to the browser, but writes from browser ignored.

      • SYSTEM

        public static final PropertyAccess SYSTEM
        Property's value is provided by the system. Sync and write behavior is identical to protected

    • Method Detail

      • values

        public static PropertyAccess[] 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 (PropertyAccess c : PropertyAccess.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static PropertyAccess 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