Package org.apache.sling.scripting.sightly.render

Interface RuntimeObjectModel

  • All Known Implementing Classes:
    AbstractRuntimeObjectModel
    @ProviderType
public interface RuntimeObjectModel
    The RuntimeObjectModel provides various utility object inspection & conversion methods that can be applied to runtime objects when executing HTL scripts.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean isCollection​(java.lang.Object target)
      Checks if an object is a Collection or is backed by one.
      boolean isDate​(java.lang.Object target)
      Checks if the provided object represents a date or calendar.
      boolean isNumber​(java.lang.Object target)
      Checks if the provided object represents a number or not.
      boolean isPrimitive​(java.lang.Object obj)
      Checks if the provided object represents a primitive data type or not.
      java.lang.Object resolveProperty​(java.lang.Object target, java.lang.Object property)
      Resolve a property of a target object and return its value.
      boolean toBoolean​(java.lang.Object object)
      Convert the given object to a boolean value
      java.util.Collection<java.lang.Object> toCollection​(java.lang.Object object)
      Force the conversion of the object to a collection
      java.util.Date toDate​(java.lang.Object object)
      Convert the given object to a Date object
      java.time.Instant toInstant​(java.lang.Object object)
      Convert the given object to an Instant object
      java.util.Map toMap​(java.lang.Object object)
      Force the conversion of the target object to a map
      java.lang.Number toNumber​(java.lang.Object object)
      Coerce the object to a numeric value
      java.lang.String toString​(java.lang.Object target)
      Convert the given object to a string.

    • Method Detail

      • isPrimitive

        boolean isPrimitive​(java.lang.Object obj)
        Checks if the provided object represents a primitive data type or not.
        Parameters:
        obj - the target object
        Returns:
        true if the target is a primitive, false otherwise

      • isCollection

        boolean isCollection​(java.lang.Object target)
        Checks if an object is a Collection or is backed by one.
        Parameters:
        target - the target object
        Returns:
        true if the target is a collection or is backed by one, false otherwise

      • isNumber

        boolean isNumber​(java.lang.Object target)
        Checks if the provided object represents a number or not.
        Parameters:
        target - the target object
        Returns:
        true if the target is a number, false otherwise

      • isDate

        boolean isDate​(java.lang.Object target)
        Checks if the provided object represents a date or calendar.
        Parameters:
        target - the target object
        Returns:
        true if the target is a date or calendar, false otherwise

      • resolveProperty

        java.lang.Object resolveProperty​(java.lang.Object target,
                                 java.lang.Object property)
        Resolve a property of a target object and return its value. The property can be either an index or a name
        Parameters:
        target - the target object
        property - the property to be resolved
        Returns:
        the value of the property

      • toBoolean

        boolean toBoolean​(java.lang.Object object)
        Convert the given object to a boolean value
        Parameters:
        object - the target object
        Returns:
        the boolean representation of that object

      • toNumber

        java.lang.Number toNumber​(java.lang.Object object)
        Coerce the object to a numeric value
        Parameters:
        object - the target object
        Returns:
        the numeric representation

      • toDate

        java.util.Date toDate​(java.lang.Object object)
        Convert the given object to a Date object
        Parameters:
        object - the target object
        Returns:
        the date represented by the object

      • toInstant

        java.time.Instant toInstant​(java.lang.Object object)
        Convert the given object to an Instant object
        Parameters:
        object - the target object
        Returns:
        the date represented by the object

      • toString

        java.lang.String toString​(java.lang.Object target)
        Convert the given object to a string.
        Parameters:
        target - the target object
        Returns:
        the string representation of the object

      • toCollection

        java.util.Collection<java.lang.Object> toCollection​(java.lang.Object object)
        Force the conversion of the object to a collection
        Parameters:
        object - the target object
        Returns:
        the collection representation of the object

      • toMap

        java.util.Map toMap​(java.lang.Object object)
        Force the conversion of the target object to a map
        Parameters:
        object - the target object
        Returns:
        a map representation of the object. Default is an empty map