You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tiles.apache.org by ap...@apache.org on 2007/03/16 17:17:56 UTC
svn commit: r519037 [1/2] - in /tiles/framework/trunk:
tiles-api/src/main/java/org/apache/tiles/access/
tiles-api/src/test/java/org/apache/tiles/access/
tiles-core/src/main/java/org/apache/tiles/beans/
tiles-core/src/main/java/org/apache/tiles/context/...
Author: apetrelli
Date: Fri Mar 16 09:17:54 2007
New Revision: 519037
URL: http://svn.apache.org/viewvc?view=rev&rev=519037
Log:
TILES-86
Second run of JavaDocs added.
Modified:
tiles/framework/trunk/tiles-api/src/main/java/org/apache/tiles/access/TilesAccess.java
tiles/framework/trunk/tiles-api/src/test/java/org/apache/tiles/access/TilesAccessTest.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/beans/SimpleMenuItem.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/ChainedTilesContextFactory.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/TilesRequestContextWrapper.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/enhanced/EnhancedTilesApplicationContext.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletApplicationScopeMap.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletInitParamMap.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletParamMap.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletParamValuesMap.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletRequestScopeMap.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletSessionScopeMap.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletApplicationScopeMap.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletHeaderMap.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletHeaderValuesMap.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletInitParamMap.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletParamMap.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletParamValuesMap.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletRequestScopeMap.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletSessionScopeMap.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletTilesApplicationContext.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletTilesRequestContext.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/definition/ComponentDefinitionsImpl.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/definition/UrlDefinitionsFactory.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/factory/TilesContainerFactory.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/impl/BasicTilesContainer.java
Modified: tiles/framework/trunk/tiles-api/src/main/java/org/apache/tiles/access/TilesAccess.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-api/src/main/java/org/apache/tiles/access/TilesAccess.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-api/src/main/java/org/apache/tiles/access/TilesAccess.java (original)
+++ tiles/framework/trunk/tiles-api/src/main/java/org/apache/tiles/access/TilesAccess.java Fri Mar 16 09:17:54 2007
@@ -37,19 +37,46 @@
*/
public class TilesAccess {
+ /**
+ * The logging object.
+ */
private static final Log LOG =
LogFactory.getLog(TilesAccess.class);
+ /**
+ * The name of the attribute to use when getting and setting the container
+ * object in a context.
+ */
public static final String CONTAINER_ATTRIBUTE =
"org.apache.tiles.CONTAINER";
+ /**
+ * The name of the attribute to get the {@link TilesApplicationContext} from
+ * a context.
+ */
private static final String CONTEXT_ATTRIBUTE =
"org.apache.tiles.APPLICATION_CONTEXT";
+ /**
+ * Finds and returns a Tiles container object, if it was previously initialized.
+ *
+ * @param context The (application) context object to use.
+ * @return The container if it has been configured previously, otherwise
+ * <code>null</code>.
+ * @see #setContainer(Object, TilesContainer)
+ */
public static TilesContainer getContainer(Object context) {
return (TilesContainer) getAttribute(context, CONTAINER_ATTRIBUTE);
}
+ /**
+ * Configures the container to be used in the application.
+ *
+ * @param context The (application) context object to use.
+ * @param container The container object to set.
+ * @throws TilesException If something goes wrong during manipulation of the
+ * context.
+ */
public static void setContainer(Object context, TilesContainer container)
throws TilesException {
@@ -65,6 +92,12 @@
setAttribute(context, CONTAINER_ATTRIBUTE, container);
}
+ /**
+ * Returns the Tiles application context object.
+ *
+ * @param context The (application) context to use.
+ * @return The required Tiles application context.
+ */
public static TilesApplicationContext getApplicationContext(Object context) {
TilesContainer container = getContainer(context);
if (container != null) {
@@ -73,6 +106,13 @@
return (TilesApplicationContext) getAttribute(context, CONTEXT_ATTRIBUTE);
}
+ /**
+ * Returns an attribute from a context.
+ *
+ * @param context The context object to use.
+ * @param attributeName The name of the attribute to search for.
+ * @return The object, that is the value of the specified attribute.
+ */
private static Object getAttribute(Object context, String attributeName) {
try {
Class<?> contextClass = context.getClass();
@@ -84,6 +124,15 @@
}
}
+ /**
+ * Sets an attribute in a context.
+ *
+ * @param context The context object to use.
+ * @param name The name of the attribute to set.
+ * @param value The value of the attribute to set.
+ * @throws TilesException If something goes wrong during setting the
+ * attribute.
+ */
private static void setAttribute(Object context, String name, Object value)
throws TilesException {
try {
@@ -95,6 +144,13 @@
}
}
+ /**
+ * Removes an attribute from a context.
+ *
+ * @param context The context object to use.
+ * @param name The name of the attribute to remove.
+ * @throws TilesException If something goes wrong during removal.
+ */
private static void removeAttribute(Object context, String name)
throws TilesException {
try {
Modified: tiles/framework/trunk/tiles-api/src/test/java/org/apache/tiles/access/TilesAccessTest.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-api/src/test/java/org/apache/tiles/access/TilesAccessTest.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-api/src/test/java/org/apache/tiles/access/TilesAccessTest.java (original)
+++ tiles/framework/trunk/tiles-api/src/test/java/org/apache/tiles/access/TilesAccessTest.java Fri Mar 16 09:17:54 2007
@@ -34,12 +34,21 @@
*/
public class TilesAccessTest extends TestCase {
+ /**
+ * The servlet context to use.
+ */
private ServletContext context;
+ /** {@inheritDoc} */
public void setUp() {
context = EasyMock.createMock(ServletContext.class);
}
+ /**
+ * Tests the setting of the context.
+ *
+ * @throws TilesException If something goes wrong.
+ */
public void testSetContext() throws TilesException {
TilesContainer container = EasyMock.createMock(TilesContainer.class);
context.setAttribute(TilesAccess.CONTAINER_ATTRIBUTE,container);
@@ -48,6 +57,11 @@
EasyMock.verify(context);
}
+ /**
+ * Tests the getting of the context.
+ *
+ * @throws TilesException If something goes wrong.
+ */
public void testGetContext() throws TilesException {
TilesContainer container = EasyMock.createMock(TilesContainer.class);
EasyMock.expect(context.getAttribute(TilesAccess.CONTAINER_ATTRIBUTE)).andReturn(container);
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/beans/SimpleMenuItem.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/beans/SimpleMenuItem.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/beans/SimpleMenuItem.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/beans/SimpleMenuItem.java Fri Mar 16 09:17:54 2007
@@ -31,12 +31,24 @@
*/
public class SimpleMenuItem implements MenuItem, Serializable {
+ /**
+ * The value of the item, i.e. what is really visible to the user.
+ */
private String value = null;
+ /**
+ * The link where the menu item points to.
+ */
private String link = null;
+ /**
+ * The (optional) icon image URL.
+ */
private String icon = null;
+ /**
+ * The (optional) tooltip text.
+ */
private String tooltip = null;
/**
@@ -47,64 +59,78 @@
}
/**
- * Set value property.
+ * Sets the value of the item, i.e. what is really visible to the user.
+ *
+ * @param value The value of the item.
*/
public void setValue(String value) {
this.value = value;
}
/**
- * Get value property.
+ * Returns the value of the item, i.e. what is really visible to the user.
+ *
+ * @return The value of the item.
*/
public String getValue() {
return value;
}
/**
- * Set link property.
+ * Sets the link where the menu item points to.
+ *
+ * @param link The link.
*/
public void setLink(String link) {
this.link = link;
}
/**
- * Get link property.
+ * Returns the link where the menu item points to.
+ *
+ * @return The link.
*/
public String getLink() {
return link;
}
/**
- * Set icon property.
+ * Sets the (optional) icon image URL.
+ *
+ * @param icon The icon URL.
*/
public void setIcon(String icon) {
this.icon = icon;
}
/**
- * Get icon property.
+ * Returns the (optional) icon image URL.
+ *
+ * @return The icon URL.
*/
public String getIcon() {
return icon;
}
/**
- * Set tooltip property.
+ * Sets the (optional) tooltip text.
+ *
+ * @param tooltip The tooltip text.
*/
public void setTooltip(String tooltip) {
this.tooltip = tooltip;
}
/**
- * Get tooltip property.
+ * Returns the (optional) tooltip text.
+ *
+ * @return The tooltip text.
*/
public String getTooltip() {
return tooltip;
}
- /**
- * Return String representation.
- */
+ /** {@inheritDoc} */
public String toString() {
StringBuffer buff = new StringBuffer("SimpleMenuItem[");
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/ChainedTilesContextFactory.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/ChainedTilesContextFactory.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/ChainedTilesContextFactory.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/ChainedTilesContextFactory.java Fri Mar 16 09:17:54 2007
@@ -37,17 +37,30 @@
*/
public class ChainedTilesContextFactory implements TilesContextFactory {
+ /**
+ * Factory class names initialization parameter to use.
+ */
public static final String FACTORY_CLASS_NAMES = "org.apache.tiles.context.ChainTilesContextFactory.FACTORY_CLASS_NAMES";
+ /**
+ * The default class names to instantiate that compose the chain..
+ */
public static final String[] DEFAULT_FACTORY_CLASS_NAMES = {
"org.apache.tiles.context.servlet.ServletTilesContextFactory",
"org.apache.tiles.context.portlet.PortletTilesContextFactory",
"org.apache.tiles.jsp.context.JspTilesContextFactory" };
+ /**
+ * The logging object.
+ */
private static Log LOG = LogFactory.getLog(ChainedTilesContextFactory.class);
+ /**
+ * The Tiles context factories composing the chain.
+ */
private TilesContextFactory[] factories;
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public void init(Map<String, String> configParameters) {
String[] classNames = null;
@@ -87,9 +100,7 @@
}
}
- /**
- * Creates a TilesApplicationContext from the given context.
- */
+ /** {@inheritDoc} */
public TilesApplicationContext createApplicationContext(Object context) {
TilesApplicationContext retValue = null;
@@ -105,6 +116,7 @@
return retValue;
}
+ /** {@inheritDoc} */
public TilesRequestContext createRequestContext(
TilesApplicationContext context, Object... requestItems) {
TilesRequestContext retValue = null;
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/TilesRequestContextWrapper.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/TilesRequestContextWrapper.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/TilesRequestContextWrapper.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/TilesRequestContextWrapper.java Fri Mar 16 09:17:54 2007
@@ -33,58 +33,78 @@
*/
public class TilesRequestContextWrapper implements TilesRequestContext {
+ /**
+ * The wrapper request context object.
+ */
private TilesRequestContext context;
+ /**
+ * Constructor.
+ *
+ * @param context The request context to wrap.
+ */
public TilesRequestContextWrapper(TilesRequestContext context) {
this.context = context;
}
+ /** {@inheritDoc} */
public Map<String, String> getHeader() {
return context.getHeader();
}
+ /** {@inheritDoc} */
public Map<String, String[]> getHeaderValues() {
return context.getHeaderValues();
}
+ /** {@inheritDoc} */
public Map<String, Object> getRequestScope() {
return context.getRequestScope();
}
+ /** {@inheritDoc} */
public Map<String, Object> getSessionScope() {
return context.getSessionScope();
}
+ /** {@inheritDoc} */
public void dispatch(String path) throws IOException {
context.dispatch(path);
}
+ /** {@inheritDoc} */
public void include(String path) throws IOException {
context.include(path);
}
+ /** {@inheritDoc} */
public Map<String, String> getParam() {
return context.getParam();
}
+ /** {@inheritDoc} */
public Map<String, String[]> getParamValues() {
return context.getParamValues();
}
+ /** {@inheritDoc} */
public Locale getRequestLocale() {
return context.getRequestLocale();
}
+ /** {@inheritDoc} */
public boolean isUserInRole(String role) {
return context.isUserInRole(role);
}
+ /** {@inheritDoc} */
public Object getResponse() {
return context.getResponse();
}
+ /** {@inheritDoc} */
public Object getRequest() {
return context.getRequest();
}
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/enhanced/EnhancedTilesApplicationContext.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/enhanced/EnhancedTilesApplicationContext.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/enhanced/EnhancedTilesApplicationContext.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/enhanced/EnhancedTilesApplicationContext.java Fri Mar 16 09:17:54 2007
@@ -49,32 +49,56 @@
*/
public class EnhancedTilesApplicationContext implements TilesApplicationContext {
+ /**
+ * The logging object.
+ */
private static final Log LOG =
LogFactory.getLog(EnhancedTilesApplicationContext.class);
+ /**
+ * The root context to be wrapped.
+ */
private TilesApplicationContext rootContext;
+ /**
+ * Constructor.
+ *
+ * @param rootContext The root context to use.
+ */
public EnhancedTilesApplicationContext(TilesApplicationContext rootContext) {
this.rootContext = rootContext;
}
+ /**
+ * Returns the root context.
+ *
+ * @return The root context.
+ */
public TilesApplicationContext getRootContext() {
return rootContext;
}
+ /**
+ * Sets the root context.
+ *
+ * @param rootContext The root context.
+ */
public void setRootContext(TilesApplicationContext rootContext) {
this.rootContext = rootContext;
}
+ /** {@inheritDoc} */
public Map<String, Object> getApplicationScope() {
return rootContext.getApplicationScope();
}
+ /** {@inheritDoc} */
public Map<String, String> getInitParams() {
return rootContext.getInitParams();
}
+ /** {@inheritDoc} */
public URL getResource(String path) throws IOException {
URL rootUrl = rootContext.getResource(path);
if(rootUrl == null) {
@@ -87,6 +111,7 @@
return rootUrl;
}
+ /** {@inheritDoc} */
public Set<URL> getResources(String path) throws IOException {
Set<URL> resources = new HashSet<URL>();
resources.addAll(rootContext.getResources(path));
@@ -94,6 +119,13 @@
return resources;
}
+ /**
+ * Searches for resources in the classpath, given a path.
+ *
+ * @param path The path to search into.
+ * @return The set of found URLs.
+ * @throws IOException If something goes wrong during search.
+ */
public Set<URL> getClasspathResources(String path) throws IOException {
Set<URL> resources = new HashSet<URL>();
resources.addAll(searchResources(getClass().getClassLoader(), path));
@@ -110,6 +142,14 @@
return resources;
}
+ /**
+ * Searches for resources in the classpath, given a path, using a class
+ * loader.
+ *
+ * @param loader The class loader to use.
+ * @param path The path to search into.
+ * @return The set of found URLs.
+ */
protected Set<URL> searchResources(ClassLoader loader, String path) {
Set<URL> resources = new HashSet<URL>();
try {
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletApplicationScopeMap.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletApplicationScopeMap.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletApplicationScopeMap.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletApplicationScopeMap.java Fri Mar 16 09:17:54 2007
@@ -39,14 +39,23 @@
final class PortletApplicationScopeMap implements Map<String, Object> {
+ /**
+ * Constructor.
+ *
+ * @param context The portlet context to use.
+ */
public PortletApplicationScopeMap(PortletContext context) {
this.context = context;
}
+ /**
+ * The portlet context to use.
+ */
private PortletContext context = null;
+ /** {@inheritDoc} */
public void clear() {
Iterator<String> keys = keySet().iterator();
while (keys.hasNext()) {
@@ -55,11 +64,13 @@
}
+ /** {@inheritDoc} */
public boolean containsKey(Object key) {
return (context.getAttribute(key(key)) != null);
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public boolean containsValue(Object value) {
if (value == null) {
@@ -76,6 +87,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<Map.Entry<String, Object>> entrySet() {
Set<Map.Entry<String, Object>> set = new HashSet<Map.Entry<String, Object>>();
@@ -89,26 +101,31 @@
}
+ /** {@inheritDoc} */
public boolean equals(Object o) {
return (context.equals(o));
}
+ /** {@inheritDoc} */
public Object get(Object key) {
return (context.getAttribute(key(key)));
}
+ /** {@inheritDoc} */
public int hashCode() {
return (context.hashCode());
}
+ /** {@inheritDoc} */
public boolean isEmpty() {
return (size() < 1);
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<String> keySet() {
Set<String> set = new HashSet<String>();
@@ -120,6 +137,7 @@
}
+ /** {@inheritDoc} */
public Object put(String key, Object value) {
if (value == null) {
return (remove(key));
@@ -131,6 +149,7 @@
}
+ /** {@inheritDoc} */
public void putAll(Map<? extends String, ? extends Object> map) {
Iterator<? extends String> keys = map.keySet().iterator();
while (keys.hasNext()) {
@@ -140,6 +159,7 @@
}
+ /** {@inheritDoc} */
public Object remove(Object key) {
String skey = key(key);
Object previous = context.getAttribute(skey);
@@ -148,6 +168,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public int size() {
int n = 0;
@@ -160,6 +181,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Collection<Object> values() {
List<Object> list = new ArrayList<Object>();
@@ -171,6 +193,13 @@
}
+ /**
+ * Returns the string representation of the key.
+ *
+ * @param key The key.
+ * @return The string representation of the key.
+ * @throws IllegalArgumentException If the key is <code>null</code>.
+ */
private String key(Object key) {
if (key == null) {
throw new IllegalArgumentException();
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletInitParamMap.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletInitParamMap.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletInitParamMap.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletInitParamMap.java Fri Mar 16 09:17:54 2007
@@ -39,24 +39,35 @@
final class PortletInitParamMap implements Map<String, String> {
+ /**
+ * Constructor.
+ *
+ * @param context The portlet context to use.
+ */
public PortletInitParamMap(PortletContext context) {
this.context = context;
}
+ /**
+ * The portlet context to use.
+ */
private PortletContext context = null;
+ /** {@inheritDoc} */
public void clear() {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public boolean containsKey(Object key) {
return (context.getInitParameter(key(key)) != null);
}
+ /** {@inheritDoc} */
public boolean containsValue(Object value) {
Iterator<String> values = values().iterator();
while (values.hasNext()) {
@@ -68,6 +79,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<Map.Entry<String, String>> entrySet() {
Set<Map.Entry<String, String>> set = new HashSet<Map.Entry<String, String>>();
@@ -81,26 +93,31 @@
}
+ /** {@inheritDoc} */
public boolean equals(Object o) {
return (context.equals(o));
}
+ /** {@inheritDoc} */
public String get(Object key) {
return (context.getInitParameter(key(key)));
}
+ /** {@inheritDoc} */
public int hashCode() {
return (context.hashCode());
}
+ /** {@inheritDoc} */
public boolean isEmpty() {
return (size() < 1);
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<String> keySet() {
Set<String> set = new HashSet<String>();
@@ -112,21 +129,25 @@
}
+ /** {@inheritDoc} */
public String put(String key, String value) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public void putAll(Map<? extends String, ? extends String> map) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public String remove(Object key) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public int size() {
int n = 0;
@@ -139,6 +160,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Collection<String> values() {
List<String> list = new ArrayList<String>();
@@ -150,6 +172,13 @@
}
+ /**
+ * Returns the string representation of the key.
+ *
+ * @param key The key.
+ * @return The string representation of the key.
+ * @throws IllegalArgumentException If the key is <code>null</code>.
+ */
private String key(Object key) {
if (key == null) {
throw new IllegalArgumentException();
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletParamMap.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletParamMap.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletParamMap.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletParamMap.java Fri Mar 16 09:17:54 2007
@@ -39,24 +39,35 @@
final class PortletParamMap implements Map<String, String> {
+ /**
+ * Constructor.
+ *
+ * @param request The portlet request to use.
+ */
public PortletParamMap(PortletRequest request) {
this.request = request;
}
+ /**
+ * The portlet request to use.
+ */
private PortletRequest request = null;
+ /** {@inheritDoc} */
public void clear() {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public boolean containsKey(Object key) {
return (request.getParameter(key(key)) != null);
}
+ /** {@inheritDoc} */
public boolean containsValue(Object value) {
Iterator<String> values = values().iterator();
while (values.hasNext()) {
@@ -68,6 +79,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<Map.Entry<String, String>> entrySet() {
Set<Map.Entry<String, String>> set = new HashSet<Map.Entry<String, String>>();
@@ -82,26 +94,31 @@
}
+ /** {@inheritDoc} */
public boolean equals(Object o) {
return (request.equals(o));
}
+ /** {@inheritDoc} */
public String get(Object key) {
return (request.getParameter(key(key)));
}
+ /** {@inheritDoc} */
public int hashCode() {
return (request.hashCode());
}
+ /** {@inheritDoc} */
public boolean isEmpty() {
return (size() < 1);
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<String> keySet() {
Set<String> set = new HashSet<String>();
@@ -113,21 +130,25 @@
}
+ /** {@inheritDoc} */
public String put(String key, String value) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public void putAll(Map<? extends String, ? extends String> map) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public String remove(Object key) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public int size() {
int n = 0;
@@ -140,6 +161,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Collection<String> values() {
List<String> list = new ArrayList<String>();
@@ -151,6 +173,13 @@
}
+ /**
+ * Returns the string representation of the key.
+ *
+ * @param key The key.
+ * @return The string representation of the key.
+ * @throws IllegalArgumentException If the key is <code>null</code>.
+ */
private String key(Object key) {
if (key == null) {
throw new IllegalArgumentException();
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletParamValuesMap.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletParamValuesMap.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletParamValuesMap.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletParamValuesMap.java Fri Mar 16 09:17:54 2007
@@ -39,24 +39,35 @@
final class PortletParamValuesMap implements Map<String, String[]> {
+ /**
+ * Constructor.
+ *
+ * @param request The portlet request to use.
+ */
public PortletParamValuesMap(PortletRequest request) {
this.request = request;
}
+ /**
+ * The portlet request to use.
+ */
private PortletRequest request = null;
+ /** {@inheritDoc} */
public void clear() {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public boolean containsKey(Object key) {
return (request.getParameter(key(key)) != null);
}
+ /** {@inheritDoc} */
public boolean containsValue(Object value) {
if (!(value instanceof String[])) {
return (false);
@@ -82,6 +93,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<Map.Entry<String, String[]>> entrySet() {
Set<Map.Entry<String, String[]>> set = new HashSet<Map.Entry<String, String[]>>();
@@ -96,26 +108,31 @@
}
+ /** {@inheritDoc} */
public boolean equals(Object o) {
return (request.equals(o));
}
+ /** {@inheritDoc} */
public String[] get(Object key) {
return (request.getParameterValues(key(key)));
}
+ /** {@inheritDoc} */
public int hashCode() {
return (request.hashCode());
}
+ /** {@inheritDoc} */
public boolean isEmpty() {
return (size() < 1);
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<String> keySet() {
Set<String> set = new HashSet<String>();
@@ -127,21 +144,25 @@
}
+ /** {@inheritDoc} */
public String[] put(String key, String[] value) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public void putAll(Map<? extends String, ? extends String[]> map) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public String[] remove(Object key) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public int size() {
int n = 0;
@@ -154,6 +175,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Collection<String[]> values() {
List<String[]> list = new ArrayList<String[]>();
@@ -165,6 +187,13 @@
}
+ /**
+ * Returns the string representation of the key.
+ *
+ * @param key The key.
+ * @return The string representation of the key.
+ * @throws IllegalArgumentException If the key is <code>null</code>.
+ */
private String key(Object key) {
if (key == null) {
throw new IllegalArgumentException();
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletRequestScopeMap.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletRequestScopeMap.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletRequestScopeMap.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletRequestScopeMap.java Fri Mar 16 09:17:54 2007
@@ -39,14 +39,23 @@
final class PortletRequestScopeMap implements Map<String, Object> {
+ /**
+ * Constructor.
+ *
+ * @param request The request object to use.
+ */
public PortletRequestScopeMap(PortletRequest request) {
this.request = request;
}
+ /**
+ * The request object to use.
+ */
private PortletRequest request = null;
+ /** {@inheritDoc} */
public void clear() {
Iterator<String> keys = keySet().iterator();
while (keys.hasNext()) {
@@ -55,11 +64,13 @@
}
+ /** {@inheritDoc} */
public boolean containsKey(Object key) {
return (request.getAttribute(key(key)) != null);
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public boolean containsValue(Object value) {
if (value == null) {
@@ -76,6 +87,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<Map.Entry<String, Object>> entrySet() {
Set<Map.Entry<String, Object>> set = new HashSet<Map.Entry<String, Object>>();
@@ -90,26 +102,31 @@
}
+ /** {@inheritDoc} */
public boolean equals(Object o) {
return (request.equals(o));
}
+ /** {@inheritDoc} */
public Object get(Object key) {
return (request.getAttribute(key(key)));
}
+ /** {@inheritDoc} */
public int hashCode() {
return (request.hashCode());
}
+ /** {@inheritDoc} */
public boolean isEmpty() {
return (size() < 1);
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<String> keySet() {
Set<String> set = new HashSet<String>();
@@ -121,6 +138,7 @@
}
+ /** {@inheritDoc} */
public Object put(String key, Object value) {
if (value == null) {
return (remove(key));
@@ -132,6 +150,7 @@
}
+ /** {@inheritDoc} */
public void putAll(Map<? extends String, ? extends Object> map) {
Iterator<? extends String> keys = map.keySet().iterator();
while (keys.hasNext()) {
@@ -141,6 +160,7 @@
}
+ /** {@inheritDoc} */
public Object remove(Object key) {
String skey = key(key);
Object previous = request.getAttribute(skey);
@@ -149,6 +169,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public int size() {
int n = 0;
@@ -161,6 +182,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Collection<Object> values() {
List<Object> list = new ArrayList<Object>();
@@ -172,6 +194,13 @@
}
+ /**
+ * Returns the string representation of the key.
+ *
+ * @param key The key.
+ * @return The string representation of the key.
+ * @throws IllegalArgumentException If the key is <code>null</code>.
+ */
private String key(Object key) {
if (key == null) {
throw new IllegalArgumentException();
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletSessionScopeMap.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletSessionScopeMap.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletSessionScopeMap.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletSessionScopeMap.java Fri Mar 16 09:17:54 2007
@@ -39,14 +39,23 @@
final class PortletSessionScopeMap implements Map<String, Object> {
+ /**
+ * Constructor.
+ *
+ * @param session The portlet session to use.
+ */
public PortletSessionScopeMap(PortletSession session) {
this.session = session;
}
+ /**
+ * The portlet session to use.
+ */
private PortletSession session = null;
+ /** {@inheritDoc} */
public void clear() {
Iterator<String> keys = keySet().iterator();
while (keys.hasNext()) {
@@ -55,11 +64,13 @@
}
+ /** {@inheritDoc} */
public boolean containsKey(Object key) {
return (session.getAttribute(key(key)) != null);
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public boolean containsValue(Object value) {
if (value == null) {
@@ -77,6 +88,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<Map.Entry<String, Object>> entrySet() {
Set<Map.Entry<String, Object>> set = new HashSet<Map.Entry<String, Object>>();
@@ -91,26 +103,31 @@
}
+ /** {@inheritDoc} */
public boolean equals(Object o) {
return (session.equals(o));
}
+ /** {@inheritDoc} */
public Object get(Object key) {
return (session.getAttribute(key(key)));
}
+ /** {@inheritDoc} */
public int hashCode() {
return (session.hashCode());
}
+ /** {@inheritDoc} */
public boolean isEmpty() {
return (size() < 1);
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<String> keySet() {
Set<String> set = new HashSet<String>();
@@ -123,6 +140,7 @@
}
+ /** {@inheritDoc} */
public Object put(String key, Object value) {
if (value == null) {
return (remove(key));
@@ -134,6 +152,7 @@
}
+ /** {@inheritDoc} */
public void putAll(Map<? extends String, ? extends Object> map) {
Iterator<? extends String> keys = map.keySet().iterator();
while (keys.hasNext()) {
@@ -143,6 +162,7 @@
}
+ /** {@inheritDoc} */
public Object remove(Object key) {
String skey = key(key);
Object previous = session.getAttribute(skey);
@@ -151,6 +171,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public int size() {
int n = 0;
@@ -164,6 +185,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Collection<Object> values() {
List<Object> list = new ArrayList<Object>();
@@ -176,6 +198,13 @@
}
+ /**
+ * Returns the string representation of the key.
+ *
+ * @param key The key.
+ * @return The string representation of the key.
+ * @throws IllegalArgumentException If the key is <code>null</code>.
+ */
private String key(Object key) {
if (key == null) {
throw new IllegalArgumentException();
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletApplicationScopeMap.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletApplicationScopeMap.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletApplicationScopeMap.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletApplicationScopeMap.java Fri Mar 16 09:17:54 2007
@@ -38,14 +38,23 @@
final class ServletApplicationScopeMap implements Map<String, Object> {
+ /**
+ * Constructor.
+ *
+ * @param context The servlet context to use.
+ */
public ServletApplicationScopeMap(ServletContext context) {
this.context = context;
}
+ /**
+ * The servlet context to use.
+ */
private ServletContext context = null;
+ /** {@inheritDoc} */
public void clear() {
Iterator<String> keys = keySet().iterator();
while (keys.hasNext()) {
@@ -54,11 +63,13 @@
}
+ /** {@inheritDoc} */
public boolean containsKey(Object key) {
return (context.getAttribute(key(key)) != null);
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public boolean containsValue(Object value) {
if (value == null) {
@@ -75,6 +86,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<Map.Entry<String, Object>> entrySet() {
Set<Map.Entry<String, Object>> set = new HashSet<Map.Entry<String, Object>>();
@@ -89,26 +101,31 @@
}
+ /** {@inheritDoc} */
public boolean equals(Object o) {
return (context.equals(o));
}
+ /** {@inheritDoc} */
public Object get(Object key) {
return (context.getAttribute(key(key)));
}
+ /** {@inheritDoc} */
public int hashCode() {
return (context.hashCode());
}
+ /** {@inheritDoc} */
public boolean isEmpty() {
return (size() < 1);
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<String> keySet() {
Set<String> set = new HashSet<String>();
@@ -120,6 +137,7 @@
}
+ /** {@inheritDoc} */
public Object put(String key, Object value) {
if (value == null) {
return (remove(key));
@@ -131,6 +149,7 @@
}
+ /** {@inheritDoc} */
public void putAll(Map<? extends String, ? extends Object> map) {
Iterator<? extends String> keys = map.keySet().iterator();
while (keys.hasNext()) {
@@ -140,6 +159,7 @@
}
+ /** {@inheritDoc} */
public Object remove(Object key) {
String skey = key(key);
Object previous = context.getAttribute(skey);
@@ -148,6 +168,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public int size() {
int n = 0;
@@ -160,6 +181,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Collection<Object> values() {
List<Object> list = new ArrayList<Object>();
@@ -171,6 +193,13 @@
}
+ /**
+ * Returns the string representation of the key.
+ *
+ * @param key The key.
+ * @return The string representation of the key.
+ * @throws IllegalArgumentException If the key is <code>null</code>.
+ */
private String key(Object key) {
if (key == null) {
throw new IllegalArgumentException();
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletHeaderMap.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletHeaderMap.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletHeaderMap.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletHeaderMap.java Fri Mar 16 09:17:54 2007
@@ -37,24 +37,35 @@
final class ServletHeaderMap implements Map<String, String> {
+ /**
+ * Constructor.
+ *
+ * @param request The request object to use.
+ */
public ServletHeaderMap(HttpServletRequest request) {
this.request = request;
}
+ /**
+ * The request object to use.
+ */
private HttpServletRequest request = null;
+ /** {@inheritDoc} */
public void clear() {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public boolean containsKey(Object key) {
return (request.getHeader(key(key)) != null);
}
+ /** {@inheritDoc} */
public boolean containsValue(Object value) {
Iterator<String> values = values().iterator();
while (values.hasNext()) {
@@ -66,6 +77,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<Map.Entry<String, String>> entrySet() {
Set<Map.Entry<String, String>> set = new HashSet<Map.Entry<String, String>>();
@@ -80,26 +92,31 @@
}
+ /** {@inheritDoc} */
public boolean equals(Object o) {
return (request.equals(o));
}
+ /** {@inheritDoc} */
public String get(Object key) {
return (request.getHeader(key(key)));
}
+ /** {@inheritDoc} */
public int hashCode() {
return (request.hashCode());
}
+ /** {@inheritDoc} */
public boolean isEmpty() {
return (size() < 1);
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<String> keySet() {
Set<String> set = new HashSet<String>();
@@ -111,21 +128,25 @@
}
+ /** {@inheritDoc} */
public String put(String key, String value) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public void putAll(Map<? extends String, ? extends String> map) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public String remove(Object key) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public int size() {
int n = 0;
@@ -138,6 +159,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Collection<String> values() {
List<String> list = new ArrayList<String>();
@@ -149,6 +171,13 @@
}
+ /**
+ * Returns the string representation of the key.
+ *
+ * @param key The key.
+ * @return The string representation of the key.
+ * @throws IllegalArgumentException If the key is <code>null</code>.
+ */
private String key(Object key) {
if (key == null) {
throw new IllegalArgumentException();
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletHeaderValuesMap.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletHeaderValuesMap.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletHeaderValuesMap.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletHeaderValuesMap.java Fri Mar 16 09:17:54 2007
@@ -38,24 +38,35 @@
final class ServletHeaderValuesMap implements Map<String, String[]> {
+ /**
+ * Constructor.
+ *
+ * @param request The request object to use.
+ */
public ServletHeaderValuesMap(HttpServletRequest request) {
this.request = request;
}
+ /**
+ * The request object to use.
+ */
private HttpServletRequest request = null;
+ /** {@inheritDoc} */
public void clear() {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public boolean containsKey(Object key) {
return (request.getHeader(key(key)) != null);
}
+ /** {@inheritDoc} */
public boolean containsValue(Object value) {
if (!(value instanceof String[])) {
return (false);
@@ -81,6 +92,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<Map.Entry<String, String[]>> entrySet() {
Set<Map.Entry<String, String[]>> set = new HashSet<Map.Entry<String, String[]>>();
@@ -96,11 +108,13 @@
}
+ /** {@inheritDoc} */
public boolean equals(Object o) {
return (request.equals(o));
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public String[] get(Object key) {
List<String> list = new ArrayList<String>();
@@ -112,16 +126,19 @@
}
+ /** {@inheritDoc} */
public int hashCode() {
return (request.hashCode());
}
+ /** {@inheritDoc} */
public boolean isEmpty() {
return (size() < 1);
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<String> keySet() {
Set<String> set = new HashSet<String>();
@@ -133,22 +150,26 @@
}
+ /** {@inheritDoc} */
public String[] put(String key, String[] value) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public void putAll(Map<? extends String, ? extends String[]> map) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public String[] remove(Object key) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public int size() {
int n = 0;
@@ -161,6 +182,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Collection<String[]> values() {
List<String[]> list = new ArrayList<String[]>();
@@ -174,6 +196,13 @@
}
+ /**
+ * Returns the string representation of the key.
+ *
+ * @param key The key.
+ * @return The string representation of the key.
+ * @throws IllegalArgumentException If the key is <code>null</code>.
+ */
private String key(Object key) {
if (key == null) {
throw new IllegalArgumentException();
@@ -184,6 +213,12 @@
}
}
+ /**
+ * Converts the content of a string enumeration to an array of strings.
+ *
+ * @param enumeration The enumeration to convert.
+ * @return The corresponding array.
+ */
private String[] enumeration2array(Enumeration<String> enumeration) {
List<String> list1 = new ArrayList<String>();
while (enumeration.hasMoreElements()) {
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletInitParamMap.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletInitParamMap.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletInitParamMap.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletInitParamMap.java Fri Mar 16 09:17:54 2007
@@ -37,24 +37,35 @@
final class ServletInitParamMap implements Map<String, String> {
+ /**
+ * Constructor.
+ *
+ * @param context The servlet context to use.
+ */
public ServletInitParamMap(ServletContext context) {
this.context = context;
}
+ /**
+ * The servlet context to use.
+ */
private ServletContext context = null;
+ /** {@inheritDoc} */
public void clear() {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public boolean containsKey(Object key) {
return (context.getInitParameter(key(key)) != null);
}
+ /** {@inheritDoc} */
public boolean containsValue(Object value) {
Iterator<String> values = values().iterator();
while (values.hasNext()) {
@@ -66,6 +77,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<Map.Entry<String, String>> entrySet() {
Set<Map.Entry<String, String>> set = new HashSet<Map.Entry<String, String>>();
@@ -80,26 +92,31 @@
}
+ /** {@inheritDoc} */
public boolean equals(Object o) {
return (context.equals(o));
}
+ /** {@inheritDoc} */
public String get(Object key) {
return (context.getInitParameter(key(key)));
}
+ /** {@inheritDoc} */
public int hashCode() {
return (context.hashCode());
}
+ /** {@inheritDoc} */
public boolean isEmpty() {
return (size() < 1);
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<String> keySet() {
Set<String> set = new HashSet<String>();
@@ -111,21 +128,25 @@
}
+ /** {@inheritDoc} */
public String put(String key, String value) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public void putAll(Map<? extends String, ? extends String> map) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public String remove(Object key) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public int size() {
int n = 0;
@@ -138,6 +159,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Collection<String> values() {
List<String> list = new ArrayList<String>();
@@ -149,6 +171,13 @@
}
+ /**
+ * Returns the string representation of the key.
+ *
+ * @param key The key.
+ * @return The string representation of the key.
+ * @throws IllegalArgumentException If the key is <code>null</code>.
+ */
private String key(Object key) {
if (key == null) {
throw new IllegalArgumentException();
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletParamMap.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletParamMap.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletParamMap.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletParamMap.java Fri Mar 16 09:17:54 2007
@@ -38,24 +38,35 @@
final class ServletParamMap implements Map<String, String> {
+ /**
+ * Constructor.
+ *
+ * @param request The request object to use.
+ */
public ServletParamMap(HttpServletRequest request) {
this.request = request;
}
+ /**
+ * The request object to use.
+ */
private HttpServletRequest request = null;
+ /** {@inheritDoc} */
public void clear() {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public boolean containsKey(Object key) {
return (request.getParameter(key(key)) != null);
}
+ /** {@inheritDoc} */
public boolean containsValue(Object value) {
Iterator<String> values = values().iterator();
while (values.hasNext()) {
@@ -67,6 +78,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<Map.Entry<String, String>> entrySet() {
Set<Map.Entry<String, String>> set = new HashSet<Map.Entry<String, String>>();
@@ -81,26 +93,31 @@
}
+ /** {@inheritDoc} */
public boolean equals(Object o) {
return (request.equals(o));
}
+ /** {@inheritDoc} */
public String get(Object key) {
return (request.getParameter(key(key)));
}
+ /** {@inheritDoc} */
public int hashCode() {
return (request.hashCode());
}
+ /** {@inheritDoc} */
public boolean isEmpty() {
return (size() < 1);
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<String> keySet() {
Set<String> set = new HashSet<String>();
@@ -112,21 +129,25 @@
}
+ /** {@inheritDoc} */
public String put(String key, String value) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public void putAll(Map<? extends String, ? extends String> map) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public String remove(Object key) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public int size() {
int n = 0;
@@ -139,6 +160,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Collection<String> values() {
List<String> list = new ArrayList<String>();
@@ -150,6 +172,13 @@
}
+ /**
+ * Returns the string representation of the key.
+ *
+ * @param key The key.
+ * @return The string representation of the key.
+ * @throws IllegalArgumentException If the key is <code>null</code>.
+ */
private String key(Object key) {
if (key == null) {
throw new IllegalArgumentException();
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletParamValuesMap.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletParamValuesMap.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletParamValuesMap.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletParamValuesMap.java Fri Mar 16 09:17:54 2007
@@ -37,24 +37,35 @@
final class ServletParamValuesMap implements Map<String, String[]> {
+ /**
+ * Constructor.
+ *
+ * @param request The request object to use.
+ */
public ServletParamValuesMap(ServletRequest request) {
this.request = request;
}
+ /**
+ * The request object to use.
+ */
private ServletRequest request = null;
+ /** {@inheritDoc} */
public void clear() {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public boolean containsKey(Object key) {
return (request.getParameter(key(key)) != null);
}
+ /** {@inheritDoc} */
public boolean containsValue(Object value) {
if (!(value instanceof String[])) {
return (false);
@@ -80,6 +91,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<Map.Entry<String, String[]>> entrySet() {
Set<Map.Entry<String, String[]>> set = new HashSet<Map.Entry<String, String[]>>();
@@ -94,26 +106,31 @@
}
+ /** {@inheritDoc} */
public boolean equals(Object o) {
return (request.equals(o));
}
+ /** {@inheritDoc} */
public String[] get(Object key) {
return (request.getParameterValues(key(key)));
}
+ /** {@inheritDoc} */
public int hashCode() {
return (request.hashCode());
}
+ /** {@inheritDoc} */
public boolean isEmpty() {
return (size() < 1);
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<String> keySet() {
Set<String> set = new HashSet<String>();
@@ -125,21 +142,25 @@
}
+ /** {@inheritDoc} */
public String[] put(String key, String[] value) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public void putAll(Map<? extends String, ? extends String[]> map) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
public String[] remove(Object key) {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public int size() {
int n = 0;
@@ -152,6 +173,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Collection<String[]> values() {
List<String[]> list = new ArrayList<String[]>();
@@ -163,6 +185,13 @@
}
+ /**
+ * Returns the string representation of the key.
+ *
+ * @param key The key.
+ * @return The string representation of the key.
+ * @throws IllegalArgumentException If the key is <code>null</code>.
+ */
private String key(Object key) {
if (key == null) {
throw new IllegalArgumentException();
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletRequestScopeMap.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletRequestScopeMap.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletRequestScopeMap.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletRequestScopeMap.java Fri Mar 16 09:17:54 2007
@@ -38,14 +38,23 @@
final class ServletRequestScopeMap implements Map<String, Object> {
+ /**
+ * Constructor.
+ *
+ * @param request The request object to use.
+ */
public ServletRequestScopeMap(ServletRequest request) {
this.request = request;
}
+ /**
+ * The request object to use.
+ */
private ServletRequest request = null;
+ /** {@inheritDoc} */
public void clear() {
Iterator<String> keys = keySet().iterator();
while (keys.hasNext()) {
@@ -54,11 +63,13 @@
}
+ /** {@inheritDoc} */
public boolean containsKey(Object key) {
return (request.getAttribute(key(key)) != null);
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public boolean containsValue(Object value) {
if (value == null) {
@@ -75,6 +86,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<Map.Entry<String, Object>> entrySet() {
Set<Map.Entry<String, Object>> set = new HashSet<Map.Entry<String, Object>>();
@@ -89,26 +101,31 @@
}
+ /** {@inheritDoc} */
public boolean equals(Object o) {
return (request.equals(o));
}
+ /** {@inheritDoc} */
public Object get(Object key) {
return (request.getAttribute(key(key)));
}
+ /** {@inheritDoc} */
public int hashCode() {
return (request.hashCode());
}
+ /** {@inheritDoc} */
public boolean isEmpty() {
return (size() < 1);
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<String> keySet() {
Set<String> set = new HashSet<String>();
@@ -120,6 +137,7 @@
}
+ /** {@inheritDoc} */
public Object put(String key, Object value) {
if (value == null) {
return (remove(key));
@@ -131,6 +149,7 @@
}
+ /** {@inheritDoc} */
public void putAll(Map<? extends String, ? extends Object> map) {
Iterator<? extends String> keys = map.keySet().iterator();
while (keys.hasNext()) {
@@ -140,6 +159,7 @@
}
+ /** {@inheritDoc} */
public Object remove(Object key) {
String skey = key(key);
Object previous = request.getAttribute(skey);
@@ -148,6 +168,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public int size() {
int n = 0;
@@ -160,6 +181,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Collection<Object> values() {
List<Object> list = new ArrayList<Object>();
@@ -171,6 +193,13 @@
}
+ /**
+ * Returns the string representation of the key.
+ *
+ * @param key The key.
+ * @return The string representation of the key.
+ * @throws IllegalArgumentException If the key is <code>null</code>.
+ */
private String key(Object key) {
if (key == null) {
throw new IllegalArgumentException();
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletSessionScopeMap.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletSessionScopeMap.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletSessionScopeMap.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletSessionScopeMap.java Fri Mar 16 09:17:54 2007
@@ -38,14 +38,23 @@
final class ServletSessionScopeMap implements Map<String, Object> {
+ /**
+ * Constructor.
+ *
+ * @param session The session object to use.
+ */
public ServletSessionScopeMap(HttpSession session) {
this.session = session;
}
+ /**
+ * The session object to use.
+ */
private HttpSession session = null;
+ /** {@inheritDoc} */
public void clear() {
Iterator<String> keys = keySet().iterator();
while (keys.hasNext()) {
@@ -54,11 +63,13 @@
}
+ /** {@inheritDoc} */
public boolean containsKey(Object key) {
return (session.getAttribute(key(key)) != null);
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public boolean containsValue(Object value) {
if (value == null) {
@@ -75,6 +86,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<Map.Entry<String, Object>> entrySet() {
Set<Map.Entry<String, Object>> set = new HashSet<Map.Entry<String, Object>>();
@@ -89,26 +101,31 @@
}
+ /** {@inheritDoc} */
public boolean equals(Object o) {
return (session.equals(o));
}
+ /** {@inheritDoc} */
public Object get(Object key) {
return (session.getAttribute(key(key)));
}
+ /** {@inheritDoc} */
public int hashCode() {
return (session.hashCode());
}
+ /** {@inheritDoc} */
public boolean isEmpty() {
return (size() < 1);
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Set<String> keySet() {
Set<String> set = new HashSet<String>();
@@ -120,6 +137,7 @@
}
+ /** {@inheritDoc} */
public Object put(String key, Object value) {
if (value == null) {
return (remove(key));
@@ -131,6 +149,7 @@
}
+ /** {@inheritDoc} */
public void putAll(Map<? extends String, ? extends Object> map) {
Iterator<? extends String> keys = map.keySet().iterator();
while (keys.hasNext()) {
@@ -140,6 +159,7 @@
}
+ /** {@inheritDoc} */
public Object remove(Object key) {
String skey = key(key);
Object previous = session.getAttribute(skey);
@@ -148,6 +168,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public int size() {
int n = 0;
@@ -160,6 +181,7 @@
}
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Collection<Object> values() {
List<Object> list = new ArrayList<Object>();
@@ -171,6 +193,13 @@
}
+ /**
+ * Returns the string representation of the key.
+ *
+ * @param key The key.
+ * @return The string representation of the key.
+ * @throws IllegalArgumentException If the key is <code>null</code>.
+ */
private String key(Object key) {
if (key == null) {
throw new IllegalArgumentException();
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletTilesApplicationContext.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletTilesApplicationContext.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletTilesApplicationContext.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletTilesApplicationContext.java Fri Mar 16 09:17:54 2007
@@ -34,12 +34,15 @@
import java.util.HashSet;
/**
- * Servlet-bsed implementation of the TilesApplicationContext interface.
+ * Servlet-based implementation of the TilesApplicationContext interface.
*
* @version $Rev$ $Date$
*/
public class ServletTilesApplicationContext implements TilesApplicationContext {
+ /**
+ * The servlet context to use.
+ */
private ServletContext servletContext;
@@ -59,12 +62,15 @@
/**
* Creates a new instance of ServletTilesApplicationContext
+ *
+ * @param servletContext The servlet context to use.
*/
public ServletTilesApplicationContext(ServletContext servletContext) {
initialize(servletContext);
}
+ /** {@inheritDoc} */
public Map<String, Object> getApplicationScope() {
if ((applicationScope == null) && (servletContext != null)) {
@@ -75,6 +81,7 @@
}
+ /** {@inheritDoc} */
public Map<String, String> getInitParams() {
if ((initParam == null) && (servletContext != null)) {
@@ -84,16 +91,23 @@
}
+ /** {@inheritDoc} */
public URL getResource(String path) throws MalformedURLException {
return servletContext.getResource(path);
}
+ /** {@inheritDoc} */
public Set<URL> getResources(String path) throws MalformedURLException {
HashSet<URL> urls = new HashSet<URL>();
urls.add(getResource(path));
return urls;
}
+ /**
+ * Returns the servlet context.
+ *
+ * @return The servlet context.
+ */
public ServletContext getServletContext() {
return servletContext;
}
@@ -130,6 +144,13 @@
}
+ /**
+ * Creates a servlet context for a given request/response pair.
+ *
+ * @param request The request object.
+ * @param response The response object.
+ * @return The corresponding Tiles request context.
+ */
public TilesRequestContext createRequestContext(Object request, Object response) {
if (request instanceof HttpServletRequest) {
return new ServletTilesRequestContext(
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletTilesRequestContext.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletTilesRequestContext.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletTilesRequestContext.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/servlet/ServletTilesRequestContext.java Fri Mar 16 09:17:54 2007
@@ -39,10 +39,19 @@
*/
public class ServletTilesRequestContext extends ServletTilesApplicationContext implements TilesRequestContext {
+ /**
+ * The logging object.
+ */
private static final Log LOG = LogFactory.getLog(ServletTilesRequestContext.class);
+ /**
+ * The request object to use.
+ */
private HttpServletRequest request;
+ /**
+ * The response object to use.
+ */
private HttpServletResponse response;
@@ -88,6 +97,10 @@
/**
* Creates a new instance of ServletTilesRequestContext
+ *
+ * @param servletContext The servlet context.
+ * @param request The request object.
+ * @param response The response object.
*/
public ServletTilesRequestContext(ServletContext servletContext,
HttpServletRequest request,
@@ -97,6 +110,7 @@
}
+ /** {@inheritDoc} */
public Map<String, String> getHeader() {
if ((header == null) && (request != null)) {
@@ -107,6 +121,7 @@
}
+ /** {@inheritDoc} */
public Map<String, String[]> getHeaderValues() {
if ((headerValues == null) && (request != null)) {
@@ -117,6 +132,7 @@
}
+ /** {@inheritDoc} */
public Map<String, String> getParam() {
if ((param == null) && (request != null)) {
@@ -127,6 +143,7 @@
}
+ /** {@inheritDoc} */
public Map<String, String[]> getParamValues() {
if ((paramValues == null) && (request != null)) {
@@ -137,6 +154,7 @@
}
+ /** {@inheritDoc} */
public Map<String, Object> getRequestScope() {
if ((requestScope == null) && (request != null)) {
@@ -147,6 +165,7 @@
}
+ /** {@inheritDoc} */
public Map<String, Object> getSessionScope() {
if ((sessionScope == null) && (request != null)) {
@@ -156,6 +175,7 @@
}
+ /** {@inheritDoc} */
public void dispatch(String path) throws IOException {
if (response.isCommitted()) {
include(path);
@@ -164,6 +184,12 @@
}
}
+ /**
+ * Forwards to a path.
+ *
+ * @param path The path to forward to.
+ * @throws IOException If something goes wrong during the operation.
+ */
private void forward( String path ) throws IOException {
RequestDispatcher rd = request.getRequestDispatcher(path);
try {
@@ -175,6 +201,7 @@
}
+ /** {@inheritDoc} */
public void include(String path) throws IOException{
RequestDispatcher rd = request.getRequestDispatcher(path);
try {
@@ -185,14 +212,17 @@
}
}
+ /** {@inheritDoc} */
public Locale getRequestLocale() {
return request.getLocale();
}
+ /** {@inheritDoc} */
public HttpServletRequest getRequest() {
return request;
}
+ /** {@inheritDoc} */
public HttpServletResponse getResponse() {
return response;
}
@@ -237,6 +267,7 @@
}
+ /** {@inheritDoc} */
public boolean isUserInRole(String role) {
return request.isUserInRole(role);
}
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/definition/ComponentDefinitionsImpl.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/definition/ComponentDefinitionsImpl.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/definition/ComponentDefinitionsImpl.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/definition/ComponentDefinitionsImpl.java Fri Mar 16 09:17:54 2007
@@ -88,6 +88,8 @@
*
* @param defsMap The new definitions to add.
* @param locale The locale to add the definitions to.
+ * @throws NoSuchDefinitionException If something goes wrong during
+ * inheritance resolution.
*/
public void addDefinitions(Map<String, ComponentDefinition> defsMap, Locale locale) throws NoSuchDefinitionException {
localeSpecificDefinitions.put(locale, defsMap);
@@ -123,6 +125,8 @@
/**
* Resolve extended instances.
+ *
+ * @throws NoSuchDefinitionException If a parent definition is not found.
*/
public void resolveInheritances() throws NoSuchDefinitionException {
for (ComponentDefinition definition : baseDefinitions.values()) {
@@ -132,6 +136,9 @@
/**
* Resolve locale-specific extended instances.
+ *
+ * @param locale The locale to use.
+ * @throws NoSuchDefinitionException If a parent definition is not found.
*/
public void resolveInheritances(Locale locale) throws NoSuchDefinitionException {
resolveInheritances();
@@ -154,11 +161,19 @@
/**
* Returns base definitions collection;
+ *
+ * @return The base (i.e. not depending on any locale) definitions map.
*/
public Map<String, ComponentDefinition> getBaseDefinitions() {
return baseDefinitions;
}
+ /**
+ * Checks if an attribute is of type "definition".
+ *
+ * @param attr The attribute to check.
+ * @return <code>true</code> if the attribute is a definition.
+ */
private boolean isDefinitionType(ComponentAttribute attr) {
boolean explicit = (attr.getType() != null &&
(attr.getType().equalsIgnoreCase("definition") ||
@@ -173,6 +188,12 @@
}
+ /**
+ * Resolves attribute dependencies for the given locale. If the locale is
+ * <code>null</code>, it resolves base attribute dependencies.
+ *
+ * @param locale The locale to use.
+ */
protected void resolveAttributeDependencies(Locale locale) {
if (locale != null) {
resolveAttributeDependencies(null); // FIXME Is it necessary?
@@ -224,7 +245,9 @@
* template.
* Also copy attributes setted in parent, and not set in child
* If instance doesn't extend anything, do nothing.
- *
+ *
+ * @param definition The definition to resolve
+ * @param locale The locale to use.
* @throws NoSuchDefinitionException If an inheritance can not be solved.
*/
protected void resolveInheritance(ComponentDefinition definition,
Modified: tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/definition/UrlDefinitionsFactory.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/definition/UrlDefinitionsFactory.java?view=diff&rev=519037&r1=519036&r2=519037
==============================================================================
--- tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/definition/UrlDefinitionsFactory.java (original)
+++ tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/definition/UrlDefinitionsFactory.java Fri Mar 16 09:17:54 2007
@@ -80,8 +80,14 @@
private List<Locale> processedLocales;
+ /**
+ * The definitions holder object.
+ */
private ComponentDefinitions definitions;
+ /**
+ * The locale resolver object.
+ */
private LocaleResolver localeResolver;
/**
@@ -100,7 +106,7 @@
* the params Map.
*
* @param params The Map of configuration properties.
- * @throws DefinitionsFactoryException if an initialization error occurs.
+ * @throws TilesException if an initialization error occurs.
*/
public void init(Map<String, String> params) throws TilesException {
String readerClassName =
@@ -123,6 +129,13 @@
localeResolver.init(params);
}
+ /**
+ * Returns the definitions holder object.
+ *
+ * @return The definitions holder.
+ * @throws DefinitionsFactoryException If something goes wrong during
+ * reading definitions.
+ */
protected ComponentDefinitions getComponentDefinitions()
throws DefinitionsFactoryException {
if (definitions == null) {
@@ -255,8 +268,9 @@
* Creates and returns a {@link ComponentDefinitions} set by reading
* configuration data from the applied sources.
*
+ * @return The definitions holder object, filled with base definitions.
* @throws DefinitionsFactoryException if an error occurs reading the
- * sources.
+ * sources.
*/
public ComponentDefinitions readDefinitions()
throws DefinitionsFactoryException {
@@ -373,6 +387,7 @@
}
+ /** {@inheritDoc} */
public void refresh() throws DefinitionsFactoryException {
LOG.debug("Updating Tiles definitions. . .");
synchronized (definitions) {
@@ -386,6 +401,8 @@
/**
* Indicates whether the DefinitionsFactory is out of date and needs to be
* reloaded.
+ *
+ * @return If the factory needs refresh.
*/
public boolean refreshRequired() {
boolean status = false;