Package org.activiti.engine.impl.variable

Class CustomObjectType

  • All Implemented Interfaces:
    VariableType
    public class CustomObjectType
extends java.lang.Object
implements VariableType
    Custom object type

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.Class<?> theClass  
      protected java.lang.String typeName  

    • Constructor Summary

      Constructors 
      Constructor Description
      CustomObjectType​(java.lang.String typeName, java.lang.Class<?> theClass)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getTypeName()
      name of variable type (limited to 100 characters length)
      java.lang.Object getValue​(ValueFields valueFields)  
      boolean isAbleToStore​(java.lang.Object value)  
      boolean isCachable()
      Indicates if this variable type supports caching.
      void setValue​(java.lang.Object value, ValueFields valueFields)
      Stores the specified value in the supplied ValueFields.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • typeName

        protected java.lang.String typeName

      • theClass

        protected java.lang.Class<?> theClass

    • Constructor Detail

      • CustomObjectType

        public CustomObjectType​(java.lang.String typeName,
                        java.lang.Class<?> theClass)

    • Method Detail

      • getTypeName

        public java.lang.String getTypeName()
        Description copied from interface: VariableType
        name of variable type (limited to 100 characters length)
        Specified by:
        getTypeName in interface VariableType

      • isAbleToStore

        public boolean isAbleToStore​(java.lang.Object value)
        Specified by:
        isAbleToStore in interface VariableType
        Returns:
        whether this variable type can store the specified value.

      • isCachable

        public boolean isCachable()
        Description copied from interface: VariableType

        Indicates if this variable type supports caching.

        If caching is supported, the result of VariableType.getValue(ValueFields) is saved for the duration of the session and used for subsequent reads of the variable's value.

        If caching is not supported, all reads of a variable's value require a fresh call to VariableType.getValue(ValueFields).

        Specified by:
        isCachable in interface VariableType
        Returns:
        whether variables of this type are cacheable.