Index (Apache Sling Scripting HTL Runtime 1.2.6-1.4.0 API)

A C F G I J N O P R S T U W X
All Classes All Packages

A

AbstractRuntimeObjectModel - Class in org.apache.sling.scripting.sightly.render: Default abstract implementation of RuntimeObjectModel.
AbstractRuntimeObjectModel() - Constructor for class org.apache.sling.scripting.sightly.render.AbstractRuntimeObjectModel
addSubTemplate(String, RenderUnit) - Method in class org.apache.sling.scripting.sightly.render.RenderUnit

C

call(String, Object...) - Method in interface org.apache.sling.scripting.sightly.render.RenderContext: Call one of the registered RuntimeExtensions.
call(RenderContext, Object...) - Method in interface org.apache.sling.scripting.sightly.extension.RuntimeExtension: Call the RuntimeExtension
callUnit(PrintWriter, RenderContext, Object, Object) - Method in class org.apache.sling.scripting.sightly.render.RenderUnit
collectionToString(Collection<?>) - Static method in class org.apache.sling.scripting.sightly.render.ObjectModel: Converts the passed collection to a comma separated values String representation.

F

failure() - Static method in class org.apache.sling.scripting.sightly.use.ProviderOutcome: Create a failed outcome without a specific cause.
failure(Throwable) - Static method in class org.apache.sling.scripting.sightly.use.ProviderOutcome: Create a failed outcome with the given cause.
findBeanMethod(Class<?>, String) - Static method in class org.apache.sling.scripting.sightly.render.ObjectModel: Given a bean class and a base method name, this method will try to find a public method without parameters that is named: baseName get + BaseName is + BaseName
FluentMap() - Constructor for class org.apache.sling.scripting.sightly.render.RenderUnit.FluentMap
FORMAT - Static variable in interface org.apache.sling.scripting.sightly.extension.RuntimeExtension: The name of the runtime function that will process string formatting.
fromIterator(Iterator<Object>) - Static method in class org.apache.sling.scripting.sightly.render.ObjectModel: Given an iterator, this method will return a Collection.

G

getBindings() - Method in interface org.apache.sling.scripting.sightly.render.RenderContext: Returns the map of script bindings available to HTL scripts.
getCause() - Method in class org.apache.sling.scripting.sightly.use.ProviderOutcome: Returns the cause for this failure outcome or null if this outcome is a success or no cause has been defined with the ProviderOutcome.failure(Throwable) method.
getEnumValue(Object, String) - Static method in class org.apache.sling.scripting.sightly.render.ObjectModel: Given an object, this method will return the value of the enum value identified by valueName.
getField(Object, String) - Static method in class org.apache.sling.scripting.sightly.render.ObjectModel: Given an object, this method will return the value of the public field identified by fieldName.
getIndex(Object, int) - Static method in class org.apache.sling.scripting.sightly.render.ObjectModel: Given an indexable object (i.e.
getObjectModel() - Method in interface org.apache.sling.scripting.sightly.render.RenderContext: Provides the RuntimeObjectModel that will be used for resolving objects' properties or type conversion / coercion.
getProperty(Object, Object) - Method in class org.apache.sling.scripting.sightly.render.AbstractRuntimeObjectModel
getProperty(String) - Method in interface org.apache.sling.scripting.sightly.Record: Gets the value of a specified property.
getProperty(String) - Method in class org.apache.sling.scripting.sightly.render.RenderUnit
getPropertyNames() - Method in interface org.apache.sling.scripting.sightly.Record: Gets the set of names for this record's properties.
getPropertyNames() - Method in class org.apache.sling.scripting.sightly.render.RenderUnit
getResult() - Method in class org.apache.sling.scripting.sightly.use.ProviderOutcome: Get the result in this outcome.

I

I18N - Static variable in interface org.apache.sling.scripting.sightly.extension.RuntimeExtension: The name of the runtime function that will process i18n.
INCLUDE - Static variable in interface org.apache.sling.scripting.sightly.extension.RuntimeExtension: The name of the runtime function that will perform script execution delegation.
init(Bindings) - Method in interface org.apache.sling.scripting.sightly.pojo.Use: Called to initialize the Java object with the current Java Scripting API bindings.
invokeBeanMethod(Object, String) - Static method in class org.apache.sling.scripting.sightly.render.ObjectModel: Given a bean object, this method will invoke the public method without parameters identified by methodName and return the invocation's result.
isCollection(Object) - Method in class org.apache.sling.scripting.sightly.render.AbstractRuntimeObjectModel
isCollection(Object) - Method in interface org.apache.sling.scripting.sightly.render.RuntimeObjectModel: Checks if an object is a Collection or is backed by one.
isDate(Object) - Method in class org.apache.sling.scripting.sightly.render.AbstractRuntimeObjectModel
isDate(Object) - Method in interface org.apache.sling.scripting.sightly.render.RuntimeObjectModel: Checks if the provided object represents a date or calendar.
isFailure() - Method in class org.apache.sling.scripting.sightly.use.ProviderOutcome: Check whether the outcome is a failure
isMethodAllowed(Method) - Static method in class org.apache.sling.scripting.sightly.render.ObjectModel: Returns true if the method is not one of the Object's class declared methods, with the exception of Object.toString().
isNumber(Object) - Method in class org.apache.sling.scripting.sightly.render.AbstractRuntimeObjectModel
isNumber(Object) - Method in interface org.apache.sling.scripting.sightly.render.RuntimeObjectModel: Checks if the provided object represents a number or not.
isPrimitive(Object) - Method in class org.apache.sling.scripting.sightly.render.AbstractRuntimeObjectModel
isPrimitive(Object) - Static method in class org.apache.sling.scripting.sightly.render.ObjectModel: Checks if the provided object is an instance of a primitive class.
isPrimitive(Object) - Method in interface org.apache.sling.scripting.sightly.render.RuntimeObjectModel: Checks if the provided object represents a primitive data type or not.
isSuccess() - Method in class org.apache.sling.scripting.sightly.use.ProviderOutcome: Check if the outcome has been successful

J

JOIN - Static variable in interface org.apache.sling.scripting.sightly.extension.RuntimeExtension: The name of the runtime function that will process join operations on arrays.

N

NAME - Static variable in interface org.apache.sling.scripting.sightly.extension.RuntimeExtension: For OSGi environments this is the name of the service registration property indicating the RuntimeExtension name.
notNullOrFailure(Object) - Static method in class org.apache.sling.scripting.sightly.use.ProviderOutcome: If the given obj is not null return a successful outcome, with the given result.

O

obj() - Method in class org.apache.sling.scripting.sightly.render.RenderUnit
ObjectModel - Class in org.apache.sling.scripting.sightly.render: The ObjectModel class provides various static models for object conversion and object property resolution.
org.apache.sling.scripting.sightly - package org.apache.sling.scripting.sightly: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
org.apache.sling.scripting.sightly.extension - package org.apache.sling.scripting.sightly.extension: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
org.apache.sling.scripting.sightly.pojo - package org.apache.sling.scripting.sightly.pojo: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
org.apache.sling.scripting.sightly.render - package org.apache.sling.scripting.sightly.render: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
org.apache.sling.scripting.sightly.use - package org.apache.sling.scripting.sightly.use: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.

P

provide(String, RenderContext, Bindings) - Method in interface org.apache.sling.scripting.sightly.use.UseProvider: Provide an instance based on the given identifier
ProviderOutcome - Class in org.apache.sling.scripting.sightly.use: Result returned by a UseProvider.

R

Record<T> - Interface in org.apache.sling.scripting.sightly: A Record is a key-value immutable object understood by the HTL runtime, used for abstracting complex objects like Sightly templates (declared with the data-sly-template block element) or objects that need to be translated from Java to JavaScript and back.
render(PrintWriter, Bindings, Bindings, RenderContext) - Method in class org.apache.sling.scripting.sightly.render.RenderUnit
render(PrintWriter, RenderContext, Bindings) - Method in class org.apache.sling.scripting.sightly.render.RenderUnit: Render the main script template
RenderContext - Interface in org.apache.sling.scripting.sightly.render: The RenderContext defines the context for executing HTL scripts.
RenderUnit - Class in org.apache.sling.scripting.sightly.render: Basic unit of rendering.
RenderUnit() - Constructor for class org.apache.sling.scripting.sightly.render.RenderUnit
RenderUnit.FluentMap - Class in org.apache.sling.scripting.sightly.render
resolveProperty(Object, Object) - Method in class org.apache.sling.scripting.sightly.render.AbstractRuntimeObjectModel
resolveProperty(Object, Object) - Static method in class org.apache.sling.scripting.sightly.render.ObjectModel: Given the target object, this method attempts to resolve and return the value of the passed property.
resolveProperty(Object, Object) - Method in interface org.apache.sling.scripting.sightly.render.RuntimeObjectModel: Resolve a property of a target object and return its value.
RESOURCE - Static variable in interface org.apache.sling.scripting.sightly.extension.RuntimeExtension: The name of the runtime function that will perform resource inclusion in the rendering process.
RuntimeExtension - Interface in org.apache.sling.scripting.sightly.extension: A RuntimeExtension represents a HTL runtime construct that provides some processing capabilities for the various data-sly-* block elements.
RuntimeObjectModel - Interface in org.apache.sling.scripting.sightly.render: The RuntimeObjectModel provides various utility object inspection & conversion methods that can be applied to runtime objects when executing HTL scripts.

S

SightlyException - Exception in org.apache.sling.scripting.sightly: Exceptions caused by the HTL engine.
SightlyException() - Constructor for exception org.apache.sling.scripting.sightly.SightlyException
SightlyException(String) - Constructor for exception org.apache.sling.scripting.sightly.SightlyException
SightlyException(String, Throwable) - Constructor for exception org.apache.sling.scripting.sightly.SightlyException
SightlyException(Throwable) - Constructor for exception org.apache.sling.scripting.sightly.SightlyException
success(Object) - Static method in class org.apache.sling.scripting.sightly.use.ProviderOutcome: Create a successful outcome

T

toBoolean(Object) - Method in class org.apache.sling.scripting.sightly.render.AbstractRuntimeObjectModel
toBoolean(Object) - Static method in class org.apache.sling.scripting.sightly.render.ObjectModel: Converts the given object to a boolean value, applying the following rules: if the object is null the returned value is false if the object is a Number the method will return false only if the number's value is 0 if the String representation of the object is equal irrespective of its casing to "true", the method will return true if the object is a Collection or a Map, the method will return true only if the collection / map is not empty if the object is an array, the method will return true only if the array is not empty
toBoolean(Object) - Method in interface org.apache.sling.scripting.sightly.render.RuntimeObjectModel: Convert the given object to a boolean value
toCollection(Object) - Method in class org.apache.sling.scripting.sightly.render.AbstractRuntimeObjectModel
toCollection(Object) - Static method in class org.apache.sling.scripting.sightly.render.ObjectModel: Forces the conversion of the passed object to an immutable collection, according to the following rules: if the object is null an empty collection will be returned if the object is an array a list transformation of the array will be returned if the object is a Collection the object itself will be returned if the object is an instance of a Map the map's key set will be returned (see Map.keySet()) if the object is an instance of an Enumeration a list transformation will be returned if the object is an instance of an Iterator or Iterable the result of ObjectModel.fromIterator(Iterator) will be returned otherwise the object is wrapped in a single item list
toCollection(Object) - Method in interface org.apache.sling.scripting.sightly.render.RuntimeObjectModel: Force the conversion of the object to a collection
toDate(Object) - Method in class org.apache.sling.scripting.sightly.render.AbstractRuntimeObjectModel
toDate(Object) - Method in interface org.apache.sling.scripting.sightly.render.RuntimeObjectModel: Convert the given object to a Date object
toInstant(Object) - Method in class org.apache.sling.scripting.sightly.render.AbstractRuntimeObjectModel
toInstant(Object) - Method in interface org.apache.sling.scripting.sightly.render.RuntimeObjectModel: Convert the given object to an Instant object
toMap(Object) - Method in class org.apache.sling.scripting.sightly.render.AbstractRuntimeObjectModel
toMap(Object) - Method in interface org.apache.sling.scripting.sightly.render.RuntimeObjectModel: Force the conversion of the target object to a map
toNumber(Object) - Method in class org.apache.sling.scripting.sightly.render.AbstractRuntimeObjectModel
toNumber(Object) - Static method in class org.apache.sling.scripting.sightly.render.ObjectModel: Coerces the passed object to a numeric value.
toNumber(Object) - Method in interface org.apache.sling.scripting.sightly.render.RuntimeObjectModel: Coerce the object to a numeric value
toString(Object) - Method in class org.apache.sling.scripting.sightly.render.AbstractRuntimeObjectModel
toString(Object) - Static method in class org.apache.sling.scripting.sightly.render.ObjectModel: Converts the passed object to a String.
toString(Object) - Method in interface org.apache.sling.scripting.sightly.render.RuntimeObjectModel: Convert the given object to a string.

U

URI_MANIPULATION - Static variable in interface org.apache.sling.scripting.sightly.extension.RuntimeExtension: The name of the runtime function that will provide URI manipulation support.
Use - Interface in org.apache.sling.scripting.sightly.pojo: The Use interface can be implemented by Java objects which are instantiated as part of processing data-sly-use attributes.
USE - Static variable in interface org.apache.sling.scripting.sightly.extension.RuntimeExtension: The name of the runtime function that will provide the support for loading Use-API objects.
UseProvider - Interface in org.apache.sling.scripting.sightly.use: A UseProvider instantiates objects for the Use-API.

W

with(String, Object) - Method in class org.apache.sling.scripting.sightly.render.RenderUnit.FluentMap: Fluent variant of put.

X

XSS - Static variable in interface org.apache.sling.scripting.sightly.extension.RuntimeExtension: The name of the runtime function that will provide XSS escaping and filtering support.

A C F G I J N O P R S T U W X
All Classes All Packages