Author: hlship
Date: Wed Jun 8 18:09:45 2011
New Revision: 1133493
URL: http://svn.apache.org/viewvc?rev=1133493&view=rev
Log:
TAP5-1528: Fix a number of JavaDoc errors and warnings
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/ComponentRequestHandlerTerminator.java
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/LinkSecurity.java
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/PageLoader.java
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/RequestConstants.java
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/RequestPageCache.java
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/runtime/RenderQueue.java
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/FieldValidatorDefaultSource.java
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/Session.java
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/dynamic/DynamicDelegate.java
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/ComponentRequestHandlerTerminator.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/ComponentRequestHandlerTerminator.java?rev=1133493&r1=1133492&r2=1133493&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/ComponentRequestHandlerTerminator.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/ComponentRequestHandlerTerminator.java
Wed Jun 8 18:09:45 2011
@@ -1,4 +1,4 @@
-// Copyright 2009 Apache Software Foundation
+// Copyright 2009, 2011 Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -23,7 +23,7 @@ import java.io.IOException;
* {@link org.apache.tapestry5.services.ComponentEventRequestHandler} and
{@link org.apache.tapestry5.services.PageRenderRequestHandler}
* pipelines.
*
- * @sicne 5.1.0.0
+ * @since 5.1.0.0
*/
public class ComponentRequestHandlerTerminator implements
ComponentRequestHandler
{
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/LinkSecurity.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/LinkSecurity.java?rev=1133493&r1=1133492&r2=1133493&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/LinkSecurity.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/LinkSecurity.java
Wed Jun 8 18:09:45 2011
@@ -1,4 +1,4 @@
-// Copyright 2010 The Apache Software Foundation
+// Copyright 2010, 2011 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -14,6 +14,8 @@
package org.apache.tapestry5.internal.services;
+import org.apache.tapestry5.Link;
+
/**
* Identifies how a {@link Link} should handle security.
*
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/PageLoader.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/PageLoader.java?rev=1133493&r1=1133492&r2=1133493&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/PageLoader.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/PageLoader.java
Wed Jun 8 18:09:45 2011
@@ -35,7 +35,7 @@ public interface PageLoader
* the <em>canonicalized</em> logical name of the page, which
will be made available via
* {@link Page#getName()} and {@link
ComponentResourcesCommon#getPageName()} (for any component within
* the page).
- * @param locale
+ * @param selector
* Encapsulates the locale and other information used to select
the component's
* template and message catalog resources.
*/
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/RequestConstants.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/RequestConstants.java?rev=1133493&r1=1133492&r2=1133493&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/RequestConstants.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/RequestConstants.java
Wed Jun 8 18:09:45 2011
@@ -1,4 +1,4 @@
-// Copyright 2006, 2007, 2008, 2009, 2010 The Apache Software Foundation
+// Copyright 2006, 2007, 2008, 2009, 2010, 2011 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -16,6 +16,7 @@ package org.apache.tapestry5.internal.se
import org.apache.tapestry5.corelib.components.Form;
import org.apache.tapestry5.corelib.components.FormInjector;
+import org.apache.tapestry5.corelib.components.Zone;
import org.apache.tapestry5.services.javascript.JavaScriptStack;
/**
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/RequestPageCache.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/RequestPageCache.java?rev=1133493&r1=1133492&r2=1133493&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/RequestPageCache.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/RequestPageCache.java
Wed Jun 8 18:09:45 2011
@@ -1,4 +1,4 @@
-// Copyright 2006, 2007, 2008, 2009 The Apache Software Foundation
+// Copyright 2006, 2007, 2008, 2009, 2011 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -14,7 +14,6 @@
package org.apache.tapestry5.internal.services;
-import org.apache.tapestry5.SymbolConstants;
import org.apache.tapestry5.internal.structure.Page;
import org.apache.tapestry5.runtime.PageLifecycleListener;
@@ -26,8 +25,7 @@ import org.apache.tapestry5.runtime.Page
* {@link org.apache.tapestry5.services.ComponentSource} service instead.
* <p>
* Starting in 5.2, page instances are shared (with externalized mutable
state), not pooled, but the cache is still
- * useful for managing the page's {@linkplain PageLifecycleListener
lifecycle}. There are now two different
- * implementation classes for this single service, selected via {@link
SymbolConstants#PAGE_POOL_ENABLED}.
+ * useful for managing the page's {@linkplain PageLifecycleListener lifecycle}.
*/
public interface RequestPageCache
{
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/runtime/RenderQueue.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/runtime/RenderQueue.java?rev=1133493&r1=1133492&r2=1133493&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/runtime/RenderQueue.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/runtime/RenderQueue.java
Wed Jun 8 18:09:45 2011
@@ -1,10 +1,10 @@
-// Copyright 2006, 2008 The Apache Software Foundation
+// Copyright 2006, 2008, 2011 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
-// http://www.apache.org/licenses/LICENSE-2.0
+// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
@@ -29,13 +29,15 @@ public interface RenderQueue
/**
* Indicates that a component is starting its render. A stack of active
components is used for exception reporting.
- *
- * @param resources identifies the component that is rendering
+ *
+ * @param resources
+ * identifies the component that is rendering
*/
void startComponent(ComponentResources resources);
/**
- * Corresponds to {@link #startComponent(String)}, used to denote when the
most recently started component finishes
+ * Corresponds to {@link #startComponent(ComponentResources)}, used to
denote when the most recently started
+ * component finishes
* rendering.
*/
void endComponent();
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/FieldValidatorDefaultSource.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/FieldValidatorDefaultSource.java?rev=1133493&r1=1133492&r2=1133493&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/FieldValidatorDefaultSource.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/FieldValidatorDefaultSource.java
Wed Jun 8 18:09:45 2011
@@ -1,10 +1,10 @@
-// Copyright 2007, 2008 The Apache Software Foundation
+// Copyright 2007, 2008, 2011 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
-// http://www.apache.org/licenses/LICENSE-2.0
+// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
@@ -31,26 +31,32 @@ public interface FieldValidatorDefaultSo
/**
* Analyzes the property type and property annotations to determine the
default set of validations for the property,
* which are wrapped to form a {@link org.apache.tapestry5.FieldValidator}
for a field.
- *
- * @param field Field component for which a validator is
being created
- * @param overrideId the id of the component, used to locate
related messages for labels and errors
- * @param overrideMessages where to search for label and error messages
- * @param locale locale used for locating messages
- * @param propertyType type of property bound to the editting
parameter of the field (typically, the
- * parameter named "value").
- * @param propertyAnnotations source of annotations for the property being
editted
+ *
+ * @param field
+ * Field component for which a validator is being created
+ * @param overrideId
+ * the id of the component, used to locate related messages for
labels and errors
+ * @param overrideMessages
+ * where to search for label and error messages
+ * @param locale
+ * locale used for locating messages
+ * @param propertyType
+ * type of property bound to the editting parameter of the
field (typically, the
+ * parameter named "value").
+ * @param propertyAnnotations
+ * source of annotations for the property being editted
* @return a validator reflecting all default validations for the field
*/
FieldValidator createDefaultValidator(Field field, String overrideId,
Messages overrideMessages, Locale locale,
- Class propertyType,
AnnotationProvider propertyAnnotations);
+ Class propertyType, AnnotationProvider propertyAnnotations);
/**
- * A convienience for the full version; assumes that the resources are
associated with a {@link
- * org.apache.tapestry5.Field}.
- *
+ * A convenience for the full version; assumes that the resources are
associated with a
+ * {@link org.apache.tapestry5.Field}.
+ *
* @param resources
* @param parameterName
- * @return
+ * @return a validator reflecting all default validations for the field
*/
FieldValidator createDefaultValidator(ComponentResources resources, String
parameterName);
}
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/Session.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/Session.java?rev=1133493&r1=1133492&r2=1133493&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/Session.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/Session.java
Wed Jun 8 18:09:45 2011
@@ -4,7 +4,7 @@
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
-// http://www.apache.org/licenses/LICENSE-2.0
+// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
@@ -15,6 +15,11 @@
package org.apache.tapestry5.services;
import javax.servlet.http.HttpSession;
+
+import org.apache.tapestry5.OptimizedSessionPersistedObject;
+import org.apache.tapestry5.annotations.ImmutableSessionPersistedObject;
+import
org.apache.tapestry5.internal.services.OptimizedSessionPersistedObjectAnalyzer;
+
import java.util.List;
/**
@@ -60,29 +65,30 @@ public interface Session
/**
* Invalidates this session then unbinds any objects bound to it.
- *
- * @throws IllegalStateException if this method is called on an already
invalidated session
+ *
+ * @throws IllegalStateException
+ * if this method is called on an already invalidated session
*/
void invalidate();
/**
- * Checks to see if the session has been invalidated. Note: this only
catches calls to {@link #invalidate()}, not
+ * Checks to see if the session has been invalidated. Note: this only
catches calls to {@link #invalidate()}, not
* calls to {@link javax.servlet.http.HttpSession#invalidate()}.
- *
+ *
* @since 5.1.0.0
*/
boolean isInvalidated();
/**
- * Re-stores dirty objects back into the session. This is necessary to
support clustering, because (in most
- * application servers) session objects are only broadcast around the
cluster from setAttribute(). If a mutable
+ * Re-stores dirty objects back into the session. This is necessary to
support clustering, because (in most
+ * application servers) session objects are only broadcast around the
cluster from setAttribute(). If a mutable
* session object is read and changed, those changes will be limited to a
single server in the cluster, which can
- * cause confusing application failures in the event of a failover.
Does nothing if there are no changes, or
+ * cause confusing application failures in the event of a failover. Does
nothing if there are no changes, or
* the session has been invalidated.
- *
- * @see org.apache.tapestry5.OptimizedSessionPersistedObject
- * @see
org.apache.tapestry5.internal.services.OptimizedApplicationStateObjectAnalyzer
- * @see org.apache.tapestry5.annotations.ImmutableSessionPersistedObject
+ *
+ * @see OptimizedSessionPersistedObject
+ * @see OptimizedSessionPersistedObjectAnalyzer
+ * @see ImmutableSessionPersistedObject
* @since 5.1.0.0
*/
void restoreDirtyObjects();
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/dynamic/DynamicDelegate.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/dynamic/DynamicDelegate.java?rev=1133493&r1=1133492&r2=1133493&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/dynamic/DynamicDelegate.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/dynamic/DynamicDelegate.java
Wed Jun 8 18:09:45 2011
@@ -16,9 +16,10 @@ package org.apache.tapestry5.services.dy
import org.apache.tapestry5.Block;
import org.apache.tapestry5.ComponentResources;
+import org.apache.tapestry5.corelib.components.Dynamic;
/**
- * Used by implementations of {@link DynamicTemplate} to obtain {@link Blocks}
as replacements
+ * Used by implementations of {@link DynamicTemplate} to obtain {@link Block}s
as replacements
* for elements within the template. The Blocks are passed to the {@link
Dynamic} component as informal parameters.
*
* @since 5.3.0
