act.util

Interface ActContext<CTX_TYPE extends ActContext>

All Superinterfaces:

org.osgl.mvc.util.ParamValueProvider

All Known Implementing Classes:

ActContext.Base, ActionContext, CliContext, CliOverHttpContext, JobContext, MailerContext

public interface ActContext<CTX_TYPE extends ActContext>
extends org.osgl.mvc.util.ParamValueProvider

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ActContext.Base<CTX extends ActContext.Base>
static interface	ActContext.Listener

Method Summary

Modifier and Type	Method and Description
String	_act_i18n(String msgId, Object... args)
org.osgl.http.H.Format	accept()
CTX_TYPE	accept(org.osgl.http.H.Format fmt)
CTX_TYPE	addDestroyable(Destroyable resource)
CTX_TYPE	addListener(ActContext.Listener listener)
CTX_TYPE	addViolation(String property, javax.validation.ConstraintViolation violation)
CTX_TYPE	addViolations(Map<String,javax.validation.ConstraintViolation> violations)
App	app()
<T> T	attribute(String name)
CTX_TYPE	attribute(String name, Object attr)
Map<String,Object>	attributes()
Template	cachedTemplate()
CTX_TYPE	cacheTemplate(Template template)
AppConfig	config()
boolean	hasViolation()
String	i18n(boolean ignoreError, Class<?> bundleSpec, String msgId, Object... args)
String	i18n(boolean ignoreError, String msgId, Object... args)
Map<String,Object>	i18n(Class<?> bundleSpec, Class<? extends Enum> enumClass)
Map<String,Object>	i18n(Class<?> bundleSpec, Class<? extends Enum> enumClass, boolean outputProperties)
String	i18n(Class<?> bundleSpec, Enum<?> msgId)
String	i18n(Class<?> bundleSpec, String msgId, Object... args)
Map<String,Object>	i18n(Class<? extends Enum> enumClass)
Map<String,Object>	i18n(Class<? extends Enum> enumClass, boolean outputProperties)
String	i18n(Enum<?> msgId)
String	i18n(String msgId, Object... args)
Locale	locale()
Locale	locale(boolean required)
CTX_TYPE	locale(Locale locale)
String	methodPath()
CTX_TYPE	removeAttribute(String name)
<T> T	renderArg(String name)
CTX_TYPE	renderArg(String name, Object val)
Map<String,Object>	renderArgs() Returns all render arguments
org.osgl.util.S.Buffer	strBuf() Returns a reusable S.Buffer instance
String	templateContext() Returns the template context
CTX_TYPE	templateContext(String context) Set template context
String	templatePath() If template path has been set before then return the template path
CTX_TYPE	templatePath(String path) Set path to template file
boolean	templatePathIsImplicit() Check if the template path is implicit i.e.
javax.validation.ConstraintViolation	violation(String property)
Map<String,javax.validation.ConstraintViolation>	violations()

Methods inherited from interface org.osgl.mvc.util.ParamValueProvider

paramKeys, paramVal, paramVals

Method Detail

app

App app()

config

AppConfig config()

accept

CTX_TYPE accept(org.osgl.http.H.Format fmt)

accept

org.osgl.http.H.Format accept()

locale

CTX_TYPE locale(Locale locale)

locale

Locale locale()

locale

Locale locale(boolean required)

templatePath

String templatePath()

If template path has been set before then return the template path

templatePath

CTX_TYPE templatePath(String path)

Set path to template file

Parameters:

path - the path to template file

Returns:

this AppContext

templateContext

String templateContext()

Returns the template context

Returns:

template context

templateContext

CTX_TYPE templateContext(String context)

Set template context

Parameters:

context - the path to template context

Returns:

this ActContext

templatePathIsImplicit

boolean templatePathIsImplicit()

Check if the template path is implicit i.e. derived from methodPath()

Returns:

true if template path is implicit; false otherwise

cachedTemplate

Template cachedTemplate()

cacheTemplate

CTX_TYPE cacheTemplate(Template template)

renderArg

<T> T renderArg(String name)

renderArgs

Map<String,Object> renderArgs()

Returns all render arguments

renderArg

CTX_TYPE renderArg(String name,
                   Object val)

addListener

CTX_TYPE addListener(ActContext.Listener listener)

addDestroyable

CTX_TYPE addDestroyable(Destroyable resource)

attribute

CTX_TYPE attribute(String name,
                   Object attr)

attribute

<T> T attribute(String name)

attributes

Map<String,Object> attributes()

removeAttribute

CTX_TYPE removeAttribute(String name)

addViolations

CTX_TYPE addViolations(Map<String,javax.validation.ConstraintViolation> violations)

addViolation

CTX_TYPE addViolation(String property,
                      javax.validation.ConstraintViolation violation)

hasViolation

boolean hasViolation()

violations

Map<String,javax.validation.ConstraintViolation> violations()

violation

javax.validation.ConstraintViolation violation(String property)

_act_i18n

String _act_i18n(String msgId,
                 Object... args)

i18n

String i18n(boolean ignoreError,
            String msgId,
            Object... args)

i18n

String i18n(String msgId,
            Object... args)

i18n

String i18n(Class<?> bundleSpec,
            String msgId,
            Object... args)

i18n

String i18n(boolean ignoreError,
            Class<?> bundleSpec,
            String msgId,
            Object... args)

i18n

String i18n(Enum<?> msgId)

i18n

String i18n(Class<?> bundleSpec,
            Enum<?> msgId)

i18n

Map<String,Object> i18n(Class<? extends Enum> enumClass)

i18n

Map<String,Object> i18n(Class<?> bundleSpec,
                        Class<? extends Enum> enumClass)

i18n

Map<String,Object> i18n(Class<? extends Enum> enumClass,
                        boolean outputProperties)

i18n

Map<String,Object> i18n(Class<?> bundleSpec,
                        Class<? extends Enum> enumClass,
                        boolean outputProperties)

methodPath

String methodPath()

strBuf

org.osgl.util.S.Buffer strBuf()

Returns a reusable S.Buffer instance

Returns:

an S.Buffer instance that can be reused