org.apache.portals.gems.util
Class PortletContentImpl

java.lang.Object
  org.apache.portals.gems.util.PortletContentImpl

All Implemented Interfaces:

PortletContent

public class PortletContentImpl
extends java.lang.Object
implements PortletContent

Constructor Summary

PortletContentImpl()

Method Summary

void	complete() complete
void	completeWithError() Notify that this content is complete with error
ContentCacheKey	getCacheKey() Get the cache key used to cache this content
java.lang.String	getContent() Retrieve the actual content of a portlet as a string
int	getExpiration() Get the expiration setting for this content if it is cached.
java.lang.String	getStringCacheKey()
java.lang.String	getTitle() Get the title of the portlet, used during caching
java.io.PrintWriter	getWriter() Get a writer to the content to stream content into this object
void	init()
boolean	isComplete() Has the renderer completed rendering the content?
void	release()
void	setExpiration(int e)
void	setTitle(java.lang.String title) Set the title of this portlet, used during caching
char[]	toCharArray()
java.lang.String	toString()
void	writeTo(java.io.Writer out)

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletContentImpl

public PortletContentImpl()

Method Detail

getWriter

public java.io.PrintWriter getWriter()

Description copied from interface: PortletContent

Get a writer to the content to stream content into this object

Specified by:

getWriter in interface PortletContent

Returns:

init

public void init()

release

public void release()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

writeTo

public void writeTo(java.io.Writer out)
             throws java.io.IOException

Throws:

java.io.IOException

toCharArray

public char[] toCharArray()

isComplete

public boolean isComplete()

Description copied from interface: PortletContent

Has the renderer completed rendering the content?

Specified by:

isComplete in interface PortletContent

Returns:

completeWithError

public void completeWithError()

Description copied from interface: PortletContent

Notify that this content is complete with error

Specified by:

completeWithError in interface PortletContent

getContent

public java.lang.String getContent()

Description copied from interface: PortletContent

Retrieve the actual content of a portlet as a string

Specified by:

getContent in interface PortletContent

Returns:

complete

public void complete()

complete

Specified by:

complete in interface PortletContent

See Also:

PortletContent.complete()

getCacheKey

public ContentCacheKey getCacheKey()

Description copied from interface: PortletContent

Get the cache key used to cache this content

Specified by:

getCacheKey in interface PortletContent

Returns:

getStringCacheKey

public java.lang.String getStringCacheKey()

getExpiration

public int getExpiration()

Description copied from interface: PortletContent

Get the expiration setting for this content if it is cached.

Specified by:

getExpiration in interface PortletContent

Returns:

setExpiration

public void setExpiration(int e)

Specified by:

setExpiration in interface PortletContent

getTitle

public java.lang.String getTitle()

Description copied from interface: PortletContent

Get the title of the portlet, used during caching

Specified by:

getTitle in interface PortletContent

Returns:

setTitle

public void setTitle(java.lang.String title)

Description copied from interface: PortletContent

Set the title of this portlet, used during caching

Specified by:

setTitle in interface PortletContent