com.opensymphony.module.sitemesh.parser: abstract public class: AbstractPage

com.opensymphony.module.sitemesh.parser
abstract public class: AbstractPage [javadoc | source]

java.lang.Object
   com.opensymphony.module.sitemesh.parser.AbstractPage

All Implemented Interfaces:
Page

Direct Known Subclasses:
TokenizedHTMLPage, AbstractHTMLPage, FastPage

Abstract implementation of com.opensymphony.module.sitemesh.Page .

Contains base methods for storing and accessing page properties. Also stores #pageData as byte[] and implements write???() methods.

Concrete implementations need only set the #pageData and call #addProperty(java.lang.String,java.lang.String) to add all the required information.

Also see:

com.opensymphony.module.sitemesh.Page

author: < - a href="joe@truemesh.com">Joe Walnes

version: $ - Revision: 1.4 $

Field Summary
protected char[]	pageData	Date of page contents.

Method from com.opensymphony.module.sitemesh.parser.AbstractPage Summary:
addProperty, getBody, getBooleanProperty, getContentLength, getIntProperty, getLongProperty, getPage, getProperties, getProperty, getPropertyKeys, getRequest, getTitle, isPropertySet, noNull, setRequest, writeBody, writePage

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from com.opensymphony.module.sitemesh.parser.AbstractPage Detail:
public void addProperty(String name, String value) { properties.put(name, value); } Add a property to the properties list.
public String getBody() { try { StringWriter writer = new StringWriter(); writeBody(writer); return writer.toString(); } catch (IOException e) { throw new IllegalStateException("Could not get body " + e.getMessage()); } }
public boolean getBooleanProperty(String name) { String property = getProperty(name); if (property == null \|\| property.trim().length() == 0) return false; switch (property.charAt(0)) { case '1": case 't": case 'T": case 'y": case 'Y": return true; default: return false; } }
public int getContentLength() { return pageData.length; }
public int getIntProperty(String name) { try { return Integer.parseInt(noNull(getProperty(name))); } catch (NumberFormatException e) { return 0; } }
public long getLongProperty(String name) { try { return Long.parseLong(noNull(getProperty(name))); } catch (NumberFormatException e) { return 0; } }
public String getPage() { try { StringWriter writer = new StringWriter(); writePage(writer); return writer.toString(); } catch (IOException e) { throw new IllegalStateException("Could not get page " + e.getMessage()); } }
public Map getProperties() { return properties; }
public String getProperty(String name) { if (!isPropertySet(name)) return null; return (String)properties.get(name); }
public String[] getPropertyKeys() { synchronized(properties) { Set keys = properties.keySet(); return (String[])keys.toArray(new String[keys.size()]); } }
public HttpServletRequest getRequest() { return request; }
public String getTitle() { return noNull(getProperty("title")); } Return title of from "title" property. Never returns null.
public boolean isPropertySet(String name) { return properties.containsKey(name); }
protected static String noNull(String in) { return in == null ? "" : in; } Return String as is, or "" if null. (Prevents NullPointerExceptions)
public void setRequest(HttpServletRequest request) { this.request = new PageRequest(request); } Create snapshot of Request.
abstract public void writeBody(Writer out) throws IOException Write data of html `<body>` tag. Must be implemented. Data written should not actually contain the body tags, but all the data in between.
public void writePage(Writer out) throws IOException { out.write(pageData); }