org.rendersnake

Class StringResource

java.lang.Object

org.rendersnake.StringResource

All Implemented Interfaces:

Renderable

public class StringResource
extends Object
implements Renderable

StringResource holds a cache for text content such as Html snippets that is read from resources on the classpath.

A StringResource instance encapsulates such a content for rendering on a html canvas.

Examples

 html.text(StringResource.get("content/Introduction.html"), false);
 html.render(new StringResource("content/Introduction.html"));
 

Author:

e.micklei

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DO_NOT_CACHE Intention revealing constant to emphasize that caching for an item is not needed

Constructor Summary

Constructors

Constructor and Description
StringResource(String location) Create a StringResource with the cached value read from the resource location
StringResource(String location, boolean escapeNeeded) Create a StringResource with the cached value read from the resource location.

Method Summary

Modifier and Type	Method and Description
static void	flush() Forget about all cached resources.
static void	flush(String location) Forget about the cached resource at the location.
static String	get(String location) Access the String contents from the given resource location.
static String	get(String location, boolean doCache) Access the String contents from the given resource location.
void	renderOn(HtmlCanvas html) Write the content as text using the html.
static StringResource	valueOf(String location) Return a StringResource for rendering the text available at location

Methods inherited from class java.lang.Object

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

Field Detail

DO_NOT_CACHE

public static final boolean DO_NOT_CACHE

Intention revealing constant to emphasize that caching for an item is not needed

See Also:

Constant Field Values

Constructor Detail

StringResource

public StringResource(String location)

Create a StringResource with the cached value read from the resource location

Parameters:

location -

StringResource

public StringResource(String location,
                      boolean escapeNeeded)

Create a StringResource with the cached value read from the resource location.

Parameters:

location -

escapeNeeded -

Method Detail

get

public static String get(String location)

Access the String contents from the given resource location. The contents is cached by StringResource. Use get(location,false); for non-cached access.

Parameters:

location -

Returns:

resource contents , never null

flush

public static void flush(String location)

Forget about the cached resource at the location. Ignore if missing.

Parameters:

location -

flush

public static void flush()

Forget about all cached resources.

get

public static String get(String location,
                         boolean doCache)

Access the String contents from the given resource location.

Parameters:

location -

Returns:

resource contents , never null

valueOf

public static StringResource valueOf(String location)

Return a StringResource for rendering the text available at location

Parameters:

location - , the file on the classpath containing the resource text

Returns:

a new StringResource

renderOn

public void renderOn(HtmlCanvas html)
              throws IOException

Write the content as text using the html. Escape if needed.

Specified by:

renderOn in interface Renderable

Throws:

IOException