Author: apetrelli
Date: Tue Mar 20 09:51:48 2007
New Revision: 520476
URL: http://svn.apache.org/viewvc?view=rev&rev=520476
Log:
TILES-86
Fourth run of JavaDocs added.
Modified:
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/BasicComponentContext.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/enhanced/EnhancedContextFactory.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletTilesApplicationContext.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletTilesRequestContext.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/definition/ComponentDefinitions.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/definition/DefinitionsFactory.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/locale/LocaleResolver.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/locale/impl/DefaultLocaleResolver.java
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/preparer/NoSuchPreparerException.java
Modified:
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/BasicComponentContext.java
URL:
http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/BasicComponentContext.java?view=diff&rev=520476&r1=520475&r2=520476
==============================================================================
---
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/BasicComponentContext.java
(original)
+++
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/BasicComponentContext.java
Tue Mar 20 09:51:48 2007
@@ -31,7 +31,7 @@
import java.util.*;
/**
- * Component context.
+ * Basic implementation for <code>ComponentContext</code>.
*
* @version $Rev$ $Date$
*/
@@ -62,6 +62,11 @@
}
+ /**
+ * Copy constructor.
+ *
+ * @param context The constructor to copy.
+ */
public BasicComponentContext(ComponentContext context) {
this.attributes = new HashMap<String, ComponentAttribute>();
Iterator<String> names = context.getAttributeNames();
@@ -214,6 +219,7 @@
return contextStack.pop();
}
+ /** [EMAIL PROTECTED] */
public void clear() {
attributes.clear();
}
Modified:
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/enhanced/EnhancedContextFactory.java
URL:
http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/enhanced/EnhancedContextFactory.java?view=diff&rev=520476&r1=520475&r2=520476
==============================================================================
---
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/enhanced/EnhancedContextFactory.java
(original)
+++
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/enhanced/EnhancedContextFactory.java
Tue Mar 20 09:51:48 2007
@@ -26,15 +26,21 @@
import org.apache.tiles.context.TilesRequestContext;
/**
+ * Tiles context factory to be used together with
+ * [EMAIL PROTECTED] EnhancedTilesApplicationContext}.
+ *
* @version $Rev$ $Date$
*/
public class EnhancedContextFactory extends ChainedTilesContextFactory {
+ /** [EMAIL PROTECTED] */
+ @Override
public TilesApplicationContext createApplicationContext(Object context) {
TilesApplicationContext root = super.createApplicationContext(context);
return new EnhancedTilesApplicationContext(root);
}
+ /** [EMAIL PROTECTED] */
@Override
public TilesRequestContext createRequestContext(TilesApplicationContext
context,
Object... requestItems) {
Modified:
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletTilesApplicationContext.java
URL:
http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletTilesApplicationContext.java?view=diff&rev=520476&r1=520475&r2=520476
==============================================================================
---
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletTilesApplicationContext.java
(original)
+++
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletTilesApplicationContext.java
Tue Mar 20 09:51:48 2007
@@ -62,6 +62,8 @@
/**
* Creates a new instance of PortletTilesApplicationContext
+ *
+ * @param context The portlet context to use.
*/
public PortletTilesApplicationContext(PortletContext context) {
initialize(context);
@@ -100,12 +102,15 @@
/**
* <p>Return the [EMAIL PROTECTED] PortletContext} for this context.</p>
+ *
+ * @return The original portlet context.
*/
public PortletContext getPortletContext() {
return (this.context);
}
+ /** [EMAIL PROTECTED] */
public Map<String, Object> getApplicationScope() {
if ((applicationScope == null) && (context != null)) {
applicationScope = new PortletApplicationScopeMap(context);
@@ -114,6 +119,7 @@
}
+ /** [EMAIL PROTECTED] */
public Map<String, String> getInitParams() {
if ((initParam == null) && (context != null)) {
initParam = new PortletInitParamMap(context);
@@ -123,16 +129,25 @@
}
+ /** [EMAIL PROTECTED] */
public URL getResource(String path) throws MalformedURLException {
return context.getResource(path);
}
+ /** [EMAIL PROTECTED] */
public Set<URL> getResources(String path) throws MalformedURLException {
HashSet<URL> set = new HashSet<URL>();
set.add(getResource(path));
return set;
}
+ /**
+ * Creates a portlet 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 PortletRequest && response instanceof
PortletResponse) {
return new PortletTilesRequestContext(
Modified:
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletTilesRequestContext.java
URL:
http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletTilesRequestContext.java?view=diff&rev=520476&r1=520475&r2=520476
==============================================================================
---
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletTilesRequestContext.java
(original)
+++
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/context/portlet/PortletTilesRequestContext.java
Tue Mar 20 09:51:48 2007
@@ -94,6 +94,10 @@
/**
* Creates a new instance of PortletTilesRequestContext
+ *
+ * @param context The portlet context to use.
+ * @param request The request object to use.
+ * @param response The response object to use.
*/
public PortletTilesRequestContext(PortletContext context, PortletRequest
request,
PortletResponse response) {
@@ -150,6 +154,8 @@
/**
* <p>Return the [EMAIL PROTECTED] PortletRequest} for this context.</p>
+ *
+ * @return The used portlet request.
*/
public PortletRequest getRequest() {
return (this.request);
@@ -157,11 +163,14 @@
/**
* <p>Return the [EMAIL PROTECTED] PortletResponse} for this context.</p>
+ *
+ * @return The used portlet response.
*/
public PortletResponse getResponse() {
return (this.response);
}
+ /** [EMAIL PROTECTED] */
@SuppressWarnings("unchecked")
public Map<String, String> getHeader() {
if ((header == null) && (request != null)) {
@@ -170,6 +179,7 @@
return (header);
}
+ /** [EMAIL PROTECTED] */
@SuppressWarnings("unchecked")
public Map<String, String[]> getHeaderValues() {
if ((headerValues == null) && (request != null)) {
@@ -178,6 +188,7 @@
return (headerValues);
}
+ /** [EMAIL PROTECTED] */
public Map<String, String> getParam() {
if ((param == null) && (request != null)) {
param = new PortletParamMap(request);
@@ -185,6 +196,7 @@
return (param);
}
+ /** [EMAIL PROTECTED] */
public Map<String, String[]> getParamValues() {
if ((paramValues == null) && (request != null)) {
paramValues = new PortletParamValuesMap(request);
@@ -192,6 +204,7 @@
return (paramValues);
}
+ /** [EMAIL PROTECTED] */
public Map<String, Object> getRequestScope() {
if ((requestScope == null) && (request != null)) {
requestScope = new PortletRequestScopeMap(request);
@@ -199,6 +212,7 @@
return (requestScope);
}
+ /** [EMAIL PROTECTED] */
public Map<String, Object> getSessionScope() {
if ((sessionScope == null) && (request != null)) {
sessionScope =
@@ -207,10 +221,12 @@
return (sessionScope);
}
+ /** [EMAIL PROTECTED] */
public void dispatch(String path) throws IOException {
include(path);
}
+ /** [EMAIL PROTECTED] */
public void include(String path) throws IOException {
if (isRenderRequest) {
try {
@@ -222,6 +238,7 @@
}
}
+ /** [EMAIL PROTECTED] */
public Locale getRequestLocale() {
if (request != null) {
return request.getLocale();
@@ -230,6 +247,7 @@
}
}
+ /** [EMAIL PROTECTED] */
public boolean isUserInRole(String role) {
return request.isUserInRole(role);
}
Modified:
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/definition/ComponentDefinitions.java
URL:
http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/definition/ComponentDefinitions.java?view=diff&rev=520476&r1=520475&r2=520476
==============================================================================
---
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/definition/ComponentDefinitions.java
(original)
+++
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/definition/ComponentDefinitions.java
Tue Mar 20 09:51:48 2007
@@ -79,11 +79,16 @@
/**
* Resolves configuration inheritance properties.
+ *
+ * @throws NoSuchDefinitionException If parent definitions are not found.
*/
public void resolveInheritances() throws NoSuchDefinitionException;
/**
* Resolves locale-specific configuration inheritance properties.
+ *
+ * @param locale The locale object to use.
+ * @throws NoSuchDefinitionException If parent definitions are not found.
*/
public void resolveInheritances(Locale locale) throws
NoSuchDefinitionException;
@@ -94,6 +99,8 @@
/**
* Returns base definitions collection;
+ *
+ * @return A map of the type "definition name -> definition".
*/
public Map<String, ComponentDefinition> getBaseDefinitions();
}
Modified:
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/definition/DefinitionsFactory.java
URL:
http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/definition/DefinitionsFactory.java?view=diff&rev=520476&r1=520475&r2=520476
==============================================================================
---
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/definition/DefinitionsFactory.java
(original)
+++
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/definition/DefinitionsFactory.java
Tue Mar 20 09:51:48 2007
@@ -23,6 +23,7 @@
package org.apache.tiles.definition;
import org.apache.tiles.context.TilesRequestContext;
+import org.apache.tiles.locale.LocaleResolver;
import org.apache.tiles.TilesException;
import java.util.Map;
@@ -51,6 +52,10 @@
public static final String DEFINITIONS_IMPL_PROPERTY =
"org.apache.tiles.definition.ComponentDefinitions";
+ /**
+ * Property name that specifies the implementation of
+ * [EMAIL PROTECTED] LocaleResolver}.
+ */
public static final String LOCALE_RESOLVER_IMPL_PROPERTY =
"org.apache.tiles.locale.LocaleResolver";
@@ -62,6 +67,7 @@
*
* @param params The Map of configuration properties.
* @throws DefinitionsFactoryException if an initialization error occurs.
+ * @throws TilesException If a generic Tiles exception occurs.
*/
public void init(Map<String, String> params) throws
DefinitionsFactoryException, TilesException;
@@ -97,7 +103,8 @@
/**
* Creates and returns a [EMAIL PROTECTED] ComponentDefinitions} set by
reading
* configuration data from the applied sources.
- *
+ *
+ * @return The read definitions.
* @throws DefinitionsFactoryException if an error occurs reading the
* sources.
*/
Modified:
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/locale/LocaleResolver.java
URL:
http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/locale/LocaleResolver.java?view=diff&rev=520476&r1=520475&r2=520476
==============================================================================
---
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/locale/LocaleResolver.java
(original)
+++
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/locale/LocaleResolver.java
Tue Mar 20 09:51:48 2007
@@ -26,9 +26,11 @@
import org.apache.tiles.TilesException;
import org.apache.tiles.context.TilesRequestContext;
-import org.apache.tiles.definition.DefinitionsFactoryException;
/**
+ * It represents an object able to resolve the current locale for the current
+ * request, where its strategy depends on its implementation.
+ *
* @version $Rev$ $Date$
*/
public interface LocaleResolver {
@@ -39,10 +41,16 @@
* method is called.
*
* @param params A map of properties used to set up the resolver.
- * @throws DefinitionsFactoryException if required properties are not
passed
+ * @throws TilesException if required properties are not passed
* in or the initialization fails.
*/
public void init(Map<String, String> params) throws TilesException;
+ /**
+ * Resolves the locale.
+ *
+ * @param request The Tiles request object.
+ * @return The current locale for the current request.
+ */
public Locale resolveLocale(TilesRequestContext request);
}
Modified:
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/locale/impl/DefaultLocaleResolver.java
URL:
http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/locale/impl/DefaultLocaleResolver.java?view=diff&rev=520476&r1=520475&r2=520476
==============================================================================
---
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/locale/impl/DefaultLocaleResolver.java
(original)
+++
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/locale/impl/DefaultLocaleResolver.java
Tue Mar 20 09:51:48 2007
@@ -30,15 +30,22 @@
import org.apache.tiles.locale.LocaleResolver;
/**
+ * Default implementation of <code>LocaleResolver</code><br>
+ * It tries to take the locale from the session-scoped attribute
+ * [EMAIL PROTECTED] ComponentConstants#LOCALE_KEY}. If it is not found, it
returns the
+ * locale included in the request.
+ *
* @version $Rev$ $Date$
*/
public class DefaultLocaleResolver implements LocaleResolver {
+ /** [EMAIL PROTECTED] */
public void init(Map<String, String> params)
throws TilesException {
// Does nothing.
}
+ /** [EMAIL PROTECTED] */
public Locale resolveLocale(TilesRequestContext request) {
Locale retValue = null;
Map<String, Object> session = request.getSessionScope();
Modified:
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/preparer/NoSuchPreparerException.java
URL:
http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/preparer/NoSuchPreparerException.java?view=diff&rev=520476&r1=520475&r2=520476
==============================================================================
---
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/preparer/NoSuchPreparerException.java
(original)
+++
tiles/framework/trunk/tiles-core/src/main/java/org/apache/tiles/preparer/NoSuchPreparerException.java
Tue Mar 20 09:51:48 2007
@@ -29,10 +29,21 @@
*/
public class NoSuchPreparerException extends PreparerException {
+ /**
+ * Constructor.
+ *
+ * @param message The message to include.
+ */
public NoSuchPreparerException(String message) {
super(message);
}
+ /**
+ * Constructor.
+ *
+ * @param message The message to include.
+ * @param e The cause exception.
+ */
public NoSuchPreparerException(String message, Exception e) {
super(message, e);
}
