You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tapestry.apache.org by hl...@apache.org on 2007/11/12 23:23:28 UTC
svn commit: r594319 [13/40] - in /tapestry/tapestry5/trunk: ./
tapestry-annotations/
tapestry-annotations/src/main/java/org/apache/tapestry/beaneditor/
tapestry-annotations/src/site/ tapestry-component-report/
tapestry-component-report/src/main/java/or...
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/Environment.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/Environment.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/Environment.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/Environment.java Mon Nov 12 14:22:31 2007
@@ -19,52 +19,44 @@
/**
* Provides access to environment services, which are almost always provided to enclosed components
* by enclosing components.
- * <p>
+ * <p/>
* The Environment acts like a collection of stacks. Each stack contains environmental service
* providers of a given type.
*/
public interface Environment
{
/**
- * @param <T>
- * the type of environmental service
- * @param type
- * class used to select a service
+ * @param <T> the type of environmental service
+ * @param type class used to select a service
* @return the current service of that type, or null if no service of that type has been added
*/
<T> T peek(Class<T> type);
/**
- * @param <T>
- * the type of environmental service
- * @param type
- * class used to select a service
+ * @param <T> the type of environmental service
+ * @param type class used to select a service
* @return the current service
- * @throws RuntimeException
- * if no service of that type has been added
+ * @throws RuntimeException if no service of that type has been added
*/
<T> T peekRequired(Class<T> type);
/**
* Removes and returns the top environmental service of the selected type.
- *
+ *
* @param <T>
* @param type
* @return
- * @throws NoSuchElementException
- * if the environmental stack (for the specified type) is empty
+ * @throws NoSuchElementException if the environmental stack (for the specified type) is empty
*/
<T> T pop(Class<T> type);
/**
* Pushes a new service onto the stack. The old service at the top of the stack is returned (it
* may be null).
- *
+ *
* @param <T>
- * @param type
- * the type of service to store
- * @param instance
- * the service instance
+ * @param type the type of service to store
+ * @param instance the service instance
* @return the previous top service
*/
<T> T push(Class<T> type, T instance);
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/EnvironmentalShadowBuilder.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/EnvironmentalShadowBuilder.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/EnvironmentalShadowBuilder.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/EnvironmentalShadowBuilder.java Mon Nov 12 14:22:31 2007
@@ -30,10 +30,9 @@
* {@link Environment#peekRequired(Class)}. Note that at the time this method is invoked, the
* Environment service may still be virtual, and will often not yet have been loaded with
* values, and that's OK, the resolution is deferred to the instant a method is invoked.
- *
+ *
* @param <T>
- * @param serviceType
- * the service type, which is used to obtained the delegate instance
+ * @param serviceType the service type, which is used to obtained the delegate instance
* @return a proxy to the service
*/
<T> T build(Class<T> serviceType);
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/ExceptionReporter.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/ExceptionReporter.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/ExceptionReporter.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/ExceptionReporter.java Mon Nov 12 14:22:31 2007
@@ -1,30 +1,29 @@
-// Copyright 2006 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
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
+// Copyright 2006 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
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
package org.apache.tapestry.services;
/**
* Interface implemented by a page used for reporting exceptions.
- *
- *
+ *
* @see RequestExceptionHandler
*/
public interface ExceptionReporter
{
/**
* Used to communicate to the page what exception is to be reported.
- *
+ *
* @param exception
*/
void reportException(Throwable exception);
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/FieldValidatorDefaultSource.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/FieldValidatorDefaultSource.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/FieldValidatorDefaultSource.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/FieldValidatorDefaultSource.java Mon Nov 12 14:22:31 2007
@@ -14,13 +14,13 @@
package org.apache.tapestry.services;
-import java.util.Locale;
-
import org.apache.tapestry.Field;
import org.apache.tapestry.FieldValidator;
import org.apache.tapestry.ioc.AnnotationProvider;
import org.apache.tapestry.ioc.Messages;
+import java.util.Locale;
+
/**
* For a particular field, geenerates the default validation for the field, in accordance with a
* number of factors and contributions.
@@ -30,7 +30,7 @@
/**
* Analyzes the property type and property annotations to determine the default set of
* validations for the property, which are wrapped to form a {@link FieldValidator} for a field.
- *
+ *
* @param field
* @param overrideId
* @param overrideMessages
@@ -40,6 +40,6 @@
* @return
*/
FieldValidator createDefaultValidator(Field field, String overrideId,
- Messages overrideMessages, Locale locale, Class propertyType,
- AnnotationProvider propertyAnnotations);
+ Messages overrideMessages, Locale locale, Class propertyType,
+ AnnotationProvider propertyAnnotations);
}
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/FieldValidatorSource.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/FieldValidatorSource.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/FieldValidatorSource.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/FieldValidatorSource.java Mon Nov 12 14:22:31 2007
@@ -14,14 +14,14 @@
package org.apache.tapestry.services;
-import java.util.Locale;
-
import org.apache.tapestry.Field;
import org.apache.tapestry.FieldValidator;
import org.apache.tapestry.Validator;
import org.apache.tapestry.corelib.components.BeanEditForm;
import org.apache.tapestry.ioc.Messages;
+import java.util.Locale;
+
/**
* Used to create {@link FieldValidator}s for a particular {@link Field} component.
*/
@@ -34,15 +34,12 @@
* field defines a message key <code><i>id</i>-<i>validator</i>
* (where id is the simple id of the field component, and validator is the validatorType), then that
* message is used instead. This allows you to override the message for a particular validation of a particular field.
- *
- * @param field
- * the field for which a validator is to be created
- * @param validatorType
- * used to select the {@link Validator} that forms the core of the
- * {@link FieldValidator}
- * @param constraintValue
- * a value used to configure the validator, or null if the validator is not
- * configurarable
+ *
+ * @param field the field for which a validator is to be created
+ * @param validatorType used to select the {@link Validator} that forms the core of the
+ * {@link FieldValidator}
+ * @param constraintValue a value used to configure the validator, or null if the validator is not
+ * configurarable
* @return the field validator for the field
*/
FieldValidator createValidator(Field field, String validatorType, String constraintValue);
@@ -52,34 +49,28 @@
* where the container of the field is not necesarrilly the place to look for override messages,
* and the id of the field is not the key to use when checking. The {@link BeanEditForm} is an
* example of this.
- *
- * @param field
- * the field for which a validator is to be created
- * @param validatorType
- * used to select the {@link Validator} that forms the core of the
- * {@link FieldValidator}
- * @param constraintValue
- * a value used to configure the validator, or null if the validator is not
- * configurable
- * @param overrideId
- * the base id used when searching for validator message overrides (this would
- * normally be the field component's simple id)
- * @param overrideMessages
- * the message catalog to search for override messages (this would normally be the
- * catalog for the container of the field component)
- * @param locale
- * locale used when retrieving default validation messages from the
- * {@link ValidationMessagesSource}
+ *
+ * @param field the field for which a validator is to be created
+ * @param validatorType used to select the {@link Validator} that forms the core of the
+ * {@link FieldValidator}
+ * @param constraintValue a value used to configure the validator, or null if the validator is not
+ * configurable
+ * @param overrideId the base id used when searching for validator message overrides (this would
+ * normally be the field component's simple id)
+ * @param overrideMessages the message catalog to search for override messages (this would normally be the
+ * catalog for the container of the field component)
+ * @param locale locale used when retrieving default validation messages from the
+ * {@link ValidationMessagesSource}
* @return the field validator for the field
*/
FieldValidator createValidator(Field field, String validatorType, String constraintValue,
- String overrideId, Messages overrideMessages, Locale locale);
+ String overrideId, Messages overrideMessages, Locale locale);
/**
* Creates a set of validators. The specification is a string used to identify and configure the
* individual validators. The specification is a comma-separated list of terms. Each term is a
* validator type name and an optional constraint value (seperated by an equals sign).
- *
+ *
* @param field
* @param specification
* @return a composite field validator
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/FormSupport.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/FormSupport.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/FormSupport.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/FormSupport.java Mon Nov 12 14:22:31 2007
@@ -20,7 +20,7 @@
/**
* Services provided by an enclosing Form control component to the various form element components
* it encloses. Implement {@link ClientElement}, to share the id of the enclosing form.
- *
+ *
* @author Howard M. Lewis Ship
*/
public interface FormSupport extends ClientElement
@@ -28,15 +28,16 @@
/**
* Allocates a unique (within the form) element name for some component enclosed component,
* based on the component's id.
- *
- * @param id
- * the component's id
+ *
+ * @param id the component's id
* @return a unique string, usually the component's id, but sometime extended with a unique
* number or string
*/
String allocateElementName(String id);
- /** Stores an action for execution during a later request. */
+ /**
+ * Stores an action for execution during a later request.
+ */
<T> void store(T component, ComponentAction<T> action);
<T> void storeAndExecute(T component, ComponentAction<T> action);
@@ -45,18 +46,16 @@
* Defers a command until the end of the form submission. The command will be executed after the
* Form's validate notification, but before the Form's submit, success or failure notifications.
* During a form render, runnables are executed after the body of the form has rendered.
- *
+ *
* @param command
*/
void defer(Runnable command);
/**
* Sets the encoding type for the Form. This should only be set once, and if
- *
- * @param encodingType
- * MIME type indicating type of encoding for the form
- * @throws IllegalStateException
- * if the encoding type has already been set to a value different than the supplied
+ *
+ * @param encodingType MIME type indicating type of encoding for the form
+ * @throws IllegalStateException if the encoding type has already been set to a value different than the supplied
*/
void setEncodingType(String encodingType);
}
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/Heartbeat.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/Heartbeat.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/Heartbeat.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/Heartbeat.java Mon Nov 12 14:22:31 2007
@@ -28,14 +28,15 @@
*/
void begin();
- /** Executes all commands since the most recent {@link #begin()}. */
+ /**
+ * Executes all commands since the most recent {@link #begin()}.
+ */
void end();
/**
* Adds a new command to the current Heartbeat. The command will be executed by {@link #end()}.
- *
- * @param command
- * command to be executed at the end of the heartbeat
+ *
+ * @param command command to be executed at the end of the heartbeat
*/
void defer(Runnable command);
}
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/HttpServletRequestFilter.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/HttpServletRequestFilter.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/HttpServletRequestFilter.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/HttpServletRequestFilter.java Mon Nov 12 14:22:31 2007
@@ -1,26 +1,24 @@
-// Copyright 2006 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
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
+// Copyright 2006 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
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
package org.apache.tapestry.services;
-import java.io.IOException;
-
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import java.io.IOException;
/**
- *
* @see org.apache.tapestry.services.HttpServletRequestHandler
*/
public interface HttpServletRequestFilter
@@ -29,9 +27,9 @@
* Filter interface for the tapestry.request.HttpServletRequestHandler pipeline. A filter should
* delegate to the handler. It may perform operations before or after invoking the handler, and
* may modify the request and response passed in to the handler.
- *
+ *
* @return true if the request has been handled, false otherwise
*/
boolean service(HttpServletRequest request, HttpServletResponse response,
- HttpServletRequestHandler handler) throws IOException;
+ HttpServletRequestHandler handler) throws IOException;
}
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/HttpServletRequestHandler.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/HttpServletRequestHandler.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/HttpServletRequestHandler.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/HttpServletRequestHandler.java Mon Nov 12 14:22:31 2007
@@ -1,32 +1,32 @@
-// Copyright 2006 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
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
+// Copyright 2006 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
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
package org.apache.tapestry.services;
-import java.io.IOException;
-
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import java.io.IOException;
/**
* Service interface for the tapestry.request.HttpServletRequestHandler pipeline service.
- *
- *
+ *
* @see org.apache.tapestry.services.HttpServletRequestFilter
*/
public interface HttpServletRequestHandler
{
- /** Returns true if the request was handled, false otherwise. */
+ /**
+ * Returns true if the request was handled, false otherwise.
+ */
boolean service(HttpServletRequest request, HttpServletResponse response) throws IOException;
}
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/InjectionProvider.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/InjectionProvider.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/InjectionProvider.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/InjectionProvider.java Mon Nov 12 14:22:31 2007
@@ -21,7 +21,7 @@
* Provides some form of injection when the value for an
* {@link org.apache.tapestry.annotations.Inject} annotation is present. In this case, the provider
* is responsible for determining the value to be injected from the field name and field type.
- * <p>
+ * <p/>
* This interface will be used as part of a
* {@link org.apache.tapestry.ioc.services.ChainBuilder chain of command}.
*/
@@ -31,20 +31,15 @@
* Peform the injection, if possible. Most often, this will result in a call to
* {@link ClassTransformation#injectField(String, Object)}. The caller is responsible for
* invoking {@link ClassTransformation#claimField(String, Object)}.
- *
- * @param fieldName
- * the name of the field requesting injection
- * @param fieldType
- * the type of the field
- * @param locator
- * allows services to be located
- * @param transformation
- * allows the code for the class to be transformed
- * @param componentModel
- * defines the relevant aspects of the component
+ *
+ * @param fieldName the name of the field requesting injection
+ * @param fieldType the type of the field
+ * @param locator allows services to be located
+ * @param transformation allows the code for the class to be transformed
+ * @param componentModel defines the relevant aspects of the component
* @return true if an injection has been made (terminates the command chain), false to continue
* down the chain
*/
boolean provideInjection(String fieldName, Class fieldType, ObjectLocator locator,
- ClassTransformation transformation, MutableComponentModel componentModel);
+ ClassTransformation transformation, MutableComponentModel componentModel);
}
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/LibraryMapping.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/LibraryMapping.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/LibraryMapping.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/LibraryMapping.java Mon Nov 12 14:22:31 2007
@@ -1,17 +1,17 @@
-// Copyright 2006 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
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
+// Copyright 2006 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
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
package org.apache.tapestry.services;
/**
@@ -20,8 +20,6 @@
* the path is mapped to a package. Prefixes should start with a character and end with a slash, as
* in "core". The root package name should have two sub-packages: "pages" to contain named pages,
* and "components" to contain named components.
- *
- *
*/
public final class LibraryMapping
{
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/MarkupWriterFactory.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/MarkupWriterFactory.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/MarkupWriterFactory.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/MarkupWriterFactory.java Mon Nov 12 14:22:31 2007
@@ -1,28 +1,28 @@
-// Copyright 2006 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
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
+// Copyright 2006 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
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
package org.apache.tapestry.services;
-import org.apache.tapestry.MarkupWriter;
+import org.apache.tapestry.MarkupWriter;
/**
* Source for {@link org.apache.tapestry.MarkupWriter} instances.
- *
- *
*/
public interface MarkupWriterFactory
{
- /** This will likely expand in the future to control things like output format and encoding, etc. */
+ /**
+ * This will likely expand in the future to control things like output format and encoding, etc.
+ */
MarkupWriter newMarkupWriter();
}
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/MetaDataLocator.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/MetaDataLocator.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/MetaDataLocator.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/MetaDataLocator.java Mon Nov 12 14:22:31 2007
@@ -29,11 +29,9 @@
{
/**
* Searches for the value for the corresponding key.
- *
- * @param key
- * the key used to locate the meta data (case insensitive)
- * @param resources
- * the resources of the initial component used in the search
+ *
+ * @param key the key used to locate the meta data (case insensitive)
+ * @param resources the resources of the initial component used in the search
* @return the value if found (in the component, the component's container, etc. or via a folder
* default) or null if not found anywhere
*/
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/ObjectRenderer.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/ObjectRenderer.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/ObjectRenderer.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/ObjectRenderer.java Mon Nov 12 14:22:31 2007
@@ -24,11 +24,9 @@
{
/**
* Renders the object out as markup.
- *
- * @param object
- * to be rendered
- * @param writer
- * to which output should be directed
+ *
+ * @param object to be rendered
+ * @param writer to which output should be directed
*/
void render(T object, MarkupWriter writer);
}
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PageRenderCommand.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PageRenderCommand.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PageRenderCommand.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PageRenderCommand.java Mon Nov 12 14:22:31 2007
@@ -20,18 +20,22 @@
/**
* Page render commands are invoked at the start of the page render cycle and at the end. This
* allows them to perform initial startup or final cleanup (or both).
- * <p>
+ * <p/>
* When commands are invoked (by the default {@link PageRenderInitializer}), the
* {@link MarkupWriter} and {@link Document} will have already been set. Most commands deal with
* storing new environmental services into the Environment.
- *
+ *
* @see PageRenderInitializer
*/
public interface PageRenderCommand
{
- /** Invoked to perform an initial setup. */
+ /**
+ * Invoked to perform an initial setup.
+ */
void setup(Environment environment);
- /** Invoked to peform final cleanup. */
+ /**
+ * Invoked to peform final cleanup.
+ */
void cleanup(Environment environment);
}
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PageRenderInitializer.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PageRenderInitializer.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PageRenderInitializer.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PageRenderInitializer.java Mon Nov 12 14:22:31 2007
@@ -25,18 +25,16 @@
/**
* Perform any initial setup, by invoking {@link PageRenderCommand#setup(Environment)}.
* Execution occurs in normal order.
- *
- * @param writer
- * the markup writer that will be used to generate all output markup
+ *
+ * @param writer the markup writer that will be used to generate all output markup
*/
void setup(MarkupWriter writer);
/**
* Peform any post-render cleanup, by invoking {@link PageRenderCommand#cleanup(Environment)}.
* Execution order is reversed.
- *
- * @param writer
- * the markup writer used to generate all output markup in the document
+ *
+ * @param writer the markup writer used to generate all output markup in the document
*/
void cleanup(MarkupWriter writer);
}
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PageRenderRequestFilter.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PageRenderRequestFilter.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PageRenderRequestFilter.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PageRenderRequestFilter.java Mon Nov 12 14:22:31 2007
@@ -23,15 +23,12 @@
/**
* Invoked to activate and render a page. The return value of the event handler method(s) for
* the activate event may result in an action response generator being returned.
- *
- * @param logicalPageName
- * the logical name of the page to activate and render
- * @param context
- * context data, supplied by the page at render time, extracted from the render URL
- * @param handler
- * to delegate the invocation to
+ *
+ * @param logicalPageName the logical name of the page to activate and render
+ * @param context context data, supplied by the page at render time, extracted from the render URL
+ * @param handler to delegate the invocation to
* @return an action response generator, or null if the page simply rendered
*/
ActionResponseGenerator handle(String logicalPageName, String[] context,
- PageRenderRequestHandler handler);
+ PageRenderRequestHandler handler);
}
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PageRenderRequestHandler.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PageRenderRequestHandler.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PageRenderRequestHandler.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PageRenderRequestHandler.java Mon Nov 12 14:22:31 2007
@@ -16,7 +16,7 @@
/**
* Handles a invocation related to rendering out a pages complete content.
- *
+ *
* @see PageRenderRequestFilter
*/
public interface PageRenderRequestHandler
@@ -24,11 +24,9 @@
/**
* Invoked to activate and render a page. The return value of the event handler method(s) for
* the activate event may result in an action response generator being returned.
- *
- * @param logicalPageName
- * the logical name of the page to activate and render
- * @param context
- * context data, supplied by the page at render time, extracted from the render URL
+ *
+ * @param logicalPageName the logical name of the page to activate and render
+ * @param context context data, supplied by the page at render time, extracted from the render URL
* @return an action response generator, or null if the page simply rendered
*/
ActionResponseGenerator handle(String logicalPageName, String[] context);
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PersistentFieldBundle.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PersistentFieldBundle.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PersistentFieldBundle.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PersistentFieldBundle.java Mon Nov 12 14:22:31 2007
@@ -1,17 +1,17 @@
-// Copyright 2006 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
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
+// Copyright 2006 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
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
package org.apache.tapestry.services;
/**
@@ -23,22 +23,18 @@
* Checks to see if a persistent value has been stored for the indicated component and field.
* TODO: This method can probably be removed; it doesn't look like its used (instead, we if
* check getValue() returns null).
- *
- * @param componentId
- * the nested id of the component (within the page), may be null or blank for the
- * root component of the page
- * @param fieldName
- * the name of the field whose value was persisted
+ *
+ * @param componentId the nested id of the component (within the page), may be null or blank for the
+ * root component of the page
+ * @param fieldName the name of the field whose value was persisted
* @return true if a change has been stored
*/
boolean containsValue(String componentId, String fieldName);
/**
- * @param componentId
- * the nested if of the component (within the page), may be null or blank for the
- * root component of the page
- * @param fieldName
- * the name of the field whose value was persisted
+ * @param componentId the nested if of the component (within the page), may be null or blank for the
+ * root component of the page
+ * @param fieldName the name of the field whose value was persisted
* @return the persisted value, possibly null
*/
Object getValue(String componentId, String fieldName);
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PersistentFieldChange.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PersistentFieldChange.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PersistentFieldChange.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PersistentFieldChange.java Mon Nov 12 14:22:31 2007
@@ -1,17 +1,17 @@
-// Copyright 2006 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
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
+// Copyright 2006 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
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
package org.apache.tapestry.services;
/**
@@ -20,12 +20,18 @@
*/
public interface PersistentFieldChange
{
- /** Returns the nested id of the component, or the empty string for the page's root component. */
+ /**
+ * Returns the nested id of the component, or the empty string for the page's root component.
+ */
String getComponentId();
- /** Returns the name of the field for which a change was recorded. */
+ /**
+ * Returns the name of the field for which a change was recorded.
+ */
String getFieldName();
- /** Returns the new value for the field (which may be null). */
+ /**
+ * Returns the new value for the field (which may be null).
+ */
Object getValue();
}
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PersistentFieldManager.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PersistentFieldManager.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PersistentFieldManager.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PersistentFieldManager.java Mon Nov 12 14:22:31 2007
@@ -24,25 +24,20 @@
{
/**
* Posts a change of a persistent property.
- *
- * @param pageName
- * the logical name of the page containing the component
- * @param resources
- * the resources for the component or mixin (used to determine the persistence
- * strategy)
- * @param fieldName
- * the name of the field whose persistent value has changed
- * @param newValue
- * the new value for the field, possibly null
+ *
+ * @param pageName the logical name of the page containing the component
+ * @param resources the resources for the component or mixin (used to determine the persistence
+ * strategy)
+ * @param fieldName the name of the field whose persistent value has changed
+ * @param newValue the new value for the field, possibly null
*/
void postChange(String pageName, ComponentResources resources, String fieldName, Object newValue);
/**
* Locates all persistently stored changes to all properties within the page (for the current
* session and request) and gathers them together into a bundle.
- *
- * @param pageName
- * the logical name of the page to gather changes for
+ *
+ * @param pageName the logical name of the page to gather changes for
* @return a bundle identifying all such changes
*/
PersistentFieldBundle gatherChanges(String pageName);
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PersistentFieldStrategy.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PersistentFieldStrategy.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PersistentFieldStrategy.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PersistentFieldStrategy.java Mon Nov 12 14:22:31 2007
@@ -1,36 +1,31 @@
-// Copyright 2006 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
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
+// Copyright 2006 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
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
package org.apache.tapestry.services;
-import java.util.Collection;
+import java.util.Collection;
public interface PersistentFieldStrategy
{
/**
* Posts a change of a persistent property.
- *
- * @param pageName
- * the name of the page containing the component
- * @param componentId
- * the nested id path of the component (or null for the page's root component)
- * @param fieldName
- * the name of the field whose persistent value has changed
- * @param strategy
- * the name of the stategy used to persist the property value
- * @param newValue
- * the new value for the field, possibly null
+ *
+ * @param pageName the name of the page containing the component
+ * @param componentId the nested id path of the component (or null for the page's root component)
+ * @param fieldName the name of the field whose persistent value has changed
+ * @param strategy the name of the stategy used to persist the property value
+ * @param newValue the new value for the field, possibly null
*/
void postChange(String pageName, String componentId, String fieldName, Object newValue);
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PropertyConduitSource.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PropertyConduitSource.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PropertyConduitSource.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PropertyConduitSource.java Mon Nov 12 14:22:31 2007
@@ -21,7 +21,7 @@
* A source for {@link PropertyConduit}s, which can be thought of as a compiled property path
* expression. PropertyConduits are the basis of the "prop:" binding factory, thus this service
* defines the expression format used by the {@link PropBindingFactory}.
- * <p>
+ * <p/>
* The expression consist of one or more terms, seperated by periods. Each term may be either the
* name of a JavaBean property, or the name of a method (a method that takes no parameters). Method
* names are distinguished from property names by appending empty parens. Using a method term as the
@@ -31,9 +31,8 @@
{
/**
* Creates a new property conduit instance for the given expression.
- *
- * @param rootClass
- * the class of the root object to which the expression is applied
+ *
+ * @param rootClass the class of the root object to which the expression is applied
* @param expression
* @return RuntimeException if the expression is invalid (poorly formed, references non-existent
* properties, etc.)
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PropertyEditContext.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PropertyEditContext.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PropertyEditContext.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PropertyEditContext.java Mon Nov 12 14:22:31 2007
@@ -26,7 +26,7 @@
/**
* Defines a context for editing a property of a bean via {@link BeanEditForm}. This value is made
* available to blocks via the {@link Environmental} annotation.
- *
+ *
* @see BeanBlockSource
*/
public interface PropertyEditContext
@@ -40,9 +40,8 @@
/**
* Updates the value of the property being edited (the context encapsulates the object
* containing the property).
- *
- * @param value
- * new value for the property
+ *
+ * @param value new value for the property
*/
void setPropertyValue(Object value);
@@ -54,14 +53,14 @@
/**
* Returns the translator appropriate for the field (this is based on the property type).
- *
+ *
* @see TranslatorDefaultSource
*/
Translator getTranslator();
/**
* Returns the FieldValidator for the field.
- *
+ *
* @see Validate
* @see FieldValidatorDefaultSource
*/
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PropertyOutputContext.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PropertyOutputContext.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PropertyOutputContext.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/PropertyOutputContext.java Mon Nov 12 14:22:31 2007
@@ -42,6 +42,8 @@
*/
String getPropertyId();
- /** Returns the name of the property (which may, in fact, be a property expression). */
+ /**
+ * Returns the name of the property (which may, in fact, be a property expression).
+ */
String getPropertyName();
}
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/Request.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/Request.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/Request.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/Request.java Mon Nov 12 14:22:31 2007
@@ -26,9 +26,8 @@
/**
* Gets the {@link Session}. If create is false and the session has not be created previously,
* returns null.
- *
- * @param create
- * true to force the creation of the session
+ *
+ * @param create true to force the creation of the session
* @return the session (or null if create is false the session has not been previously created)
*/
Session getSession(boolean create);
@@ -39,7 +38,9 @@
*/
String getContextPath();
- /** Returns a list of query parameter names, in alphabetical order. */
+ /**
+ * Returns a list of query parameter names, in alphabetical order.
+ */
List<String> getParameterNames();
/**
@@ -51,7 +52,7 @@
/**
* Returns the parameter values for the given name. Returns null if no such parameter is in the
* request.
- * <p>
+ * <p/>
* TODO: Shouldn't this move to {@link FormParameterLookup}?
*/
String[] getParameters(String name);
@@ -62,52 +63,55 @@
*/
String getPath();
- /** Returns the locale of the client as determined from the request headers. */
+ /**
+ * Returns the locale of the client as determined from the request headers.
+ */
Locale getLocale();
- /** Returns the names of all headers in the request. */
+ /**
+ * Returns the names of all headers in the request.
+ */
List<String> getHeaderNames();
/**
* Returns the value of the specified request header as a <code>long</code> value that
* represents a <code>Date</code> object. Use this method with headers that contain dates,
* such as <code>If-Modified-Since</code>.
- * <p>
+ * <p/>
* The date is returned as the number of milliseconds since January 1, 1970 GMT. The header name
* is case insensitive.
- * <p>
+ * <p/>
* If the request did not have a header of the specified name, this method returns -1. If the
* header can't be converted to a date, the method throws an
* <code>IllegalArgumentException</code>.
- *
- * @param nme
- * a <code>String</code> specifying the name of the header
+ *
+ * @param nme a <code>String</code> specifying the name of the header
* @return a <code>long</code> value representing the date specified in the header expressed
* as the number of milliseconds since January 1, 1970 GMT, or -1 if the named header
* was not included with the reqest
- * @exception IllegalArgumentException
- * If the header value can't be converted to a date
+ * @throws IllegalArgumentException If the header value can't be converted to a date
*/
long getDateHeader(String name);
- /** Returns the named header as a string, or null if not found. */
+ /**
+ * Returns the named header as a string, or null if not found.
+ */
String getHeader(String name);
/**
* Sets the encoding of the request, which must occur before any parameters for the request are
* read.
- *
- * @param requestEncoding
- * charset used when parsing parameters
+ *
+ * @param requestEncoding charset used when parsing parameters
*/
void setEncoding(String requestEncoding);
-
+
/**
* Returns true if the request originated on the client using XmlHttpRequest (the core of any Ajax behavior).
* Ajax action requests may behave quite differently than ordinary, page-based requests. This implementation
* currently depends on the client side setting a header: <strong>X-Requested-With=XmlHttpRequest</strong> (this is what
* Prototype does).
- *
+ *
* @return true if the request has an XmlHttpRequest origin
*/
boolean isXHR();
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/RequestExceptionHandler.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/RequestExceptionHandler.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/RequestExceptionHandler.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/RequestExceptionHandler.java Mon Nov 12 14:22:31 2007
@@ -1,35 +1,32 @@
-// Copyright 2006 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
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
+// Copyright 2006 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
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
package org.apache.tapestry.services;
-import java.io.IOException;
+import java.io.IOException;
/**
* Service invoked when an uncaught exception occurs. The error handler is responsible for providing
* a response to the user to describe the error.
- *
- *
*/
public interface RequestExceptionHandler
{
/**
* Reponsible for handling the error <em>in some way</em> and providing <em>some response</em>
* to the client. A default implementation may render an error response page.
- *
- * @param exception
- * uncaught exception to be reported
+ *
+ * @param exception uncaught exception to be reported
* @throws IOException
*/
void handleRequestException(Throwable exception) throws IOException;
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/RequestGlobals.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/RequestGlobals.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/RequestGlobals.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/RequestGlobals.java Mon Nov 12 14:22:31 2007
@@ -1,31 +1,31 @@
-// Copyright 2006, 2007 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
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
+// Copyright 2006, 2007 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
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
package org.apache.tapestry.services;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
/**
* Service used to store the current request objects, both the Servlet API versions, and the
* Tapestry generic versions.
- *
- *
*/
public interface RequestGlobals
{
- /** Stores the servlet API request and response objects, for access via the properties. */
+ /**
+ * Stores the servlet API request and response objects, for access via the properties.
+ */
void store(HttpServletRequest request, HttpServletResponse response);
HttpServletRequest getHTTPServletRequest();
@@ -34,9 +34,13 @@
void store(Request request, Response response);
- /** Accessible as injected object "alias:Request". */
+ /**
+ * Accessible as injected object "alias:Request".
+ */
Request getRequest();
- /** Accessible as injected object "alias:Response". */
+ /**
+ * Accessible as injected object "alias:Response".
+ */
Response getResponse();
}
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/RequestHandler.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/RequestHandler.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/RequestHandler.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/RequestHandler.java Mon Nov 12 14:22:31 2007
@@ -18,12 +18,14 @@
/**
* Service interface for the RequestHandler pipeline service.
- *
+ *
* @see RequestFilter
*/
public interface RequestHandler
{
- /** Returns true if the request has been handled, false otherwise. */
+ /**
+ * Returns true if the request has been handled, false otherwise.
+ */
boolean service(Request request, Response response) throws IOException;
}
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/ResourceDigestGenerator.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/ResourceDigestGenerator.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/ResourceDigestGenerator.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/ResourceDigestGenerator.java Mon Nov 12 14:22:31 2007
@@ -14,16 +14,16 @@
package org.apache.tapestry.services;
-import java.net.URL;
-
import org.apache.tapestry.internal.services.ClasspathAssetFactory;
import org.apache.tapestry.ioc.Resource;
import org.apache.tapestry.ioc.internal.util.ClasspathResource;
+import java.net.URL;
+
/**
* Responsible for determining which classpath resources require checksums, and for generating
* checksums for such resources.
- *
+ *
* @see ClasspathResource
* @see ClasspathAssetFactory
*/
@@ -41,7 +41,7 @@
* digest of its content. This digest will be incorporated into the URL provided to the
* client, to verify that the client has been "granted" access to this resource. This is only
* used for resources where {@link #requiresDigest(String)} is true.
- *
+ *
* @param url
* @return the digest for the resource
*/
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/Response.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/Response.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/Response.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/Response.java Mon Nov 12 14:22:31 2007
@@ -27,27 +27,24 @@
/**
* Returns a PrintWriter object to which output may be sent. Invoking flush() on the writer will
* commit the output.
- *
- * @param contentType
- * the MIME content type for the output, typically "text/html"
+ *
+ * @param contentType the MIME content type for the output, typically "text/html"
*/
PrintWriter getPrintWriter(String contentType) throws IOException;
/**
* Returns an OutputStream to which byte-oriented output may be sent. Invoking flush() on the
* stream will commit the output.
- *
- * @param contentType
- * the MIME content type for the output, often "application/octet-stream" or
- * "text/plain" or one of several others
+ *
+ * @param contentType the MIME content type for the output, often "application/octet-stream" or
+ * "text/plain" or one of several others
*/
OutputStream getOutputStream(String contentType) throws IOException;
/**
* Sends a redirect to the client.
- *
- * @param URL
- * full or partial (relative) URL to send to the client
+ *
+ * @param URL full or partial (relative) URL to send to the client
* @see #encodeRedirectURL(String)
*/
void sendRedirect(String URL) throws IOException;
@@ -59,28 +56,23 @@
* unmodified. If an error-page declaration has been made for the web application corresponding
* to the status code passed in, it will be served back in preference to the suggested msg
* parameter.
- * <p>
+ * <p/>
* If the response has already been committed, this method throws an IllegalStateException.
* After using this method, the response should be considered to be committed and should not be
* written to.
- *
- * @param sc
- * the error status code
- * @param message
- * the descriptive message
- * @exception IOException
- * If an input or output exception occurs
- * @exception IllegalStateException
- * If the response was committed
+ *
+ * @param sc the error status code
+ * @param message the descriptive message
+ * @throws IOException If an input or output exception occurs
+ * @throws IllegalStateException If the response was committed
*/
void sendError(int sc, String message) throws IOException;
/**
* Sets the length of the content body in the response; this method sets the HTTP Content-Length
* header.
- *
- * @param length
- * the length of the content
+ *
+ * @param length the length of the content
*/
void setContentLength(int length);
@@ -88,38 +80,34 @@
* Sets a response header with the given name and date-value. The date is specified in terms of
* milliseconds since the epoch. If the header had already been set, the new value overwrites
* the previous one.
- *
- * @param name
- * the name of the header to set
- * @param date
- * the assigned date value
+ *
+ * @param name the name of the header to set
+ * @param date the assigned date value
*/
void setDateHeader(String name, long date);
/**
* Sets a response header with the given name and value. If the header had already been set,
* the new value overwrites the previous one.
- * @param name
- * the name of the header to set
- * @param value
- * the assigned value
+ *
+ * @param name the name of the header to set
+ * @param value the assigned value
*/
void setHeader(String name, String value);
/**
* Sets a response header with the given name and integer value. If the header had already been set,
* the new value overwrites the previous one.
- * @param name
- * the name of the header to set
- * @param value
- * the assigned integer value
+ *
+ * @param name the name of the header to set
+ * @param value the assigned integer value
*/
void setIntHeader(String name, int value);
/**
* Encodes the URL, ensuring that a session id is included (if a session exists, and as
* necessary depending on the client browser's use of cookies).
- *
+ *
* @param URL
* @return the same URL or a different one with additional information to track the user session
*/
@@ -128,7 +116,7 @@
/**
* Encodes the URL for use as a redirect, ensuring that a session id is included (if a session
* exists, and as necessary depending on the client browser's use of cookies).
- *
+ *
* @param URL
* @return the same URL or a different one with additional information to track the user session
*/
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/ServletApplicationInitializer.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/ServletApplicationInitializer.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/ServletApplicationInitializer.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/ServletApplicationInitializer.java Mon Nov 12 14:22:31 2007
@@ -1,25 +1,23 @@
-// Copyright 2006 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
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
+// Copyright 2006 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
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
package org.apache.tapestry.services;
-import javax.servlet.ServletContext;
+import javax.servlet.ServletContext;
/**
* Service interface for initializing a servlet application.
- *
- *
*/
public interface ServletApplicationInitializer
{
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/ServletApplicationInitializerFilter.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/ServletApplicationInitializerFilter.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/ServletApplicationInitializerFilter.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/ServletApplicationInitializerFilter.java Mon Nov 12 14:22:31 2007
@@ -1,29 +1,30 @@
-// Copyright 2006 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
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
+// Copyright 2006 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
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
package org.apache.tapestry.services;
-import javax.servlet.ServletContext;
+import javax.servlet.ServletContext;
/**
* Filter interface for {@link org.apache.tapestry.services.ServletApplicationInitializer}.
- *
- *
+ *
* @see org.apache.tapestry.services.ServletApplicationInitializer
*/
public interface ServletApplicationInitializerFilter
{
- /** Peforms one step of initializing the application before passing off to the next step. */
+ /**
+ * Peforms one step of initializing the application before passing off to the next step.
+ */
void initializeApplication(ServletContext context, ServletApplicationInitializer initializer);
}
Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/Session.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/Session.java?rev=594319&r1=594318&r2=594319&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/Session.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry/services/Session.java Mon Nov 12 14:22:31 2007
@@ -14,9 +14,8 @@
package org.apache.tapestry.services;
-import java.util.List;
-
import javax.servlet.http.HttpSession;
+import java.util.List;
/**
* Generic version of {@link HttpSession}, used to bridge the gaps between the Servlet API and the
@@ -36,10 +35,14 @@
*/
List<String> getAttributeNames(String prefix);
- /** Returns the value previously stored in the session. */
+ /**
+ * Returns the value previously stored in the session.
+ */
Object getAttribute(String name);
- /** Sets the value of an attribute. If the value is null, then the attribute is deleted. */
+ /**
+ * Sets the value of an attribute. If the value is null, then the attribute is deleted.
+ */
void setAttribute(String name, Object value);
/**
@@ -58,9 +61,8 @@
/**
* 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();
}