com.yahoo.prelude.templates

Class Context

java.lang.Object

com.yahoo.prelude.templates.Context

Direct Known Subclasses:

HitContext, MapContext

Deprecated.

use a Renderer instead

@Deprecated
public abstract class Context
extends Object

A set of variable bindings for template rendering

Author:

bratseth

Method Summary

Modifier and Type	Method and Description
abstract Object	get(String key) Deprecated. Returns a value by looking it up in the primary, and thereafter in secondary sources.
String	getBoldCloseTag() Deprecated.
String	getBoldOpenTag() Deprecated.
abstract Collection<? extends Object>	getKeys() Deprecated.
String	getSeparatorTag() Deprecated.
boolean	getXmlEscape() Deprecated. Returns whether this context xml-escapes returned values.
boolean	isUtf8Output() Deprecated. Used by the template to decide whether to use UTF-8 optimizations.
protected Object	normalizeValue(Object value) Deprecated.
abstract Object	put(String key, Object value) Deprecated. Makes a secondary binding
abstract Object	remove(Object key) Deprecated. Removes a secondary binding
void	setBoldCloseTag(String boldCloseTag) Deprecated.
void	setBoldOpenTag(String boldOpenTag) Deprecated.
void	setSeparatorTag(String separatorTag) Deprecated.
void	setUtf8Output(boolean utf8Output) Deprecated. Used by the template to decide whether to use UTF-8 optimizations.
void	setXmlEscape(boolean xmlEscape) Deprecated. Sets whether this context should xml-escape returned values

Methods inherited from class java.lang.Object

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

Method Detail

setXmlEscape

public void setXmlEscape(boolean xmlEscape)

Deprecated.

Sets whether this context should xml-escape returned values

getXmlEscape

public boolean getXmlEscape()

Deprecated.

Returns whether this context xml-escapes returned values. Default is true

put

public abstract Object put(String key,
                           Object value)

Deprecated.

Makes a secondary binding

Returns:

the old value bound to this key, or null it the key was previously unbound

get

public abstract Object get(String key)

Deprecated.

Returns a value by looking it up in the primary, and thereafter in secondary sources.

If xml escaping is on and this is a string, xml attribute escaping is done

remove

public abstract Object remove(Object key)

Deprecated.

Removes a secondary binding

Returns:

the removed value, or null if it wasn't bound

setBoldOpenTag

public void setBoldOpenTag(String boldOpenTag)

Deprecated.

setBoldCloseTag

public void setBoldCloseTag(String boldCloseTag)

Deprecated.

setSeparatorTag

public void setSeparatorTag(String separatorTag)

Deprecated.

normalizeValue

protected Object normalizeValue(Object value)

Deprecated.

getBoldOpenTag

public String getBoldOpenTag()

Deprecated.

getBoldCloseTag

public String getBoldCloseTag()

Deprecated.

getSeparatorTag

public String getSeparatorTag()

Deprecated.

getKeys

public abstract Collection<? extends Object> getKeys()

Deprecated.

isUtf8Output

public boolean isUtf8Output()

Deprecated.

Used by the template to decide whether to use UTF-8 optimizations.

Returns:

whether the result encoding is UTF-8

setUtf8Output

public void setUtf8Output(boolean utf8Output)

Deprecated.

Used by the template to decide whether to use UTF-8 optimizations. TODO: TVT: Make this package private again

Parameters:

utf8Output - whether the output encoding is UTF-8