http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticClass.java ---------------------------------------------------------------------- diff --git a/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticClass.java b/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticClass.java index 85478cd..e212fe5 100644 --- a/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticClass.java +++ b/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticClass.java @@ -1,5 +1,3 @@ -// Copyright 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 @@ -24,15 +22,15 @@ import java.util.Set; * for an imperative style of development: the PlasticClass is provided to other objects; they can query it * for relevant fields or methods, and invoke methods that modify the class in various ways. Ultimately, the * end result is a {@link ClassInstantiator} used to create instances of the fully instrumented and transformed class. - * <p/> + * * The terminology is that a class that is being transformed is "plastic", but the end result is a normal concrete class * (albeit in a different class loader). - * <p/> + * * Implements {@link AnnotationAccess} to provide access to annotations on the type itself. - * <p/> + * * This class is expressly <em>not thread safe</em>; only a single thread should be responsible for operating on a * PlasticClass. - * <p/> + * * TODO: what about annotation inheritance? */ @SuppressWarnings("rawtypes") @@ -113,7 +111,7 @@ public interface PlasticClass extends AnnotationAccess * implemented in a <em>transformed</em> super class, the the default behavior is to invoke that method and return * its value. Otherwise, the default behavior is to ignore parameters and return 0, false, or null. Void methods * will invoke the super-class implementation (if it exists) and return no value. - * <p/> + * * It is allowed for the method description to indicate an abstract method; however the abstract flag will be * removed, and a non-abstract method will be created. * @@ -126,7 +124,7 @@ public interface PlasticClass extends AnnotationAccess /** * Returns an existing method declared in this class, or introduces a new method into this class. * The method is created with default behavior. - * <p/> + * * It is allowed for the method description to indicate an abstract method; however the abstract flag will be * removed, and a non-abstract method will be created. * @@ -140,7 +138,7 @@ public interface PlasticClass extends AnnotationAccess /** * A convenience that creates a {@link MethodDescription} from the Method and introduces that. This is often * invoked when walking the methods of an interface and introducing each of those methods. - * <p/> + * * Introduced methods are always concrete, not abstract. The abstract flag on the method modifiers will always be * stripped off, which is handy when {@linkplain #introduceInterface(Class) introducing methods from an interface}. *
http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticClassTransformation.java ---------------------------------------------------------------------- diff --git a/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticClassTransformation.java b/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticClassTransformation.java index 37ba2d4..2d80ba4 100644 --- a/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticClassTransformation.java +++ b/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticClassTransformation.java @@ -1,5 +1,3 @@ -// Copyright 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 @@ -33,7 +31,7 @@ public interface PlasticClassTransformation<T> * Terminates the class transformation process, finishes any final bookkeeping, and * returns an object used to instantiate the transformed class. Once this method is invoked, * no other methods of the {@link PlasticClass} (or related objects) can be invoked. - * <p> + * * The returned ClassInstantiator has an empty {@link InstanceContext} map. Use * {@link ClassInstantiator#with(Class, Object)} to create a new ClassInstantiator with new InstanceContext entries. */ http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticField.java ---------------------------------------------------------------------- diff --git a/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticField.java b/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticField.java index b935b35..0bfd1f5 100644 --- a/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticField.java +++ b/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticField.java @@ -1,5 +1,3 @@ -// Copyright 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 @@ -16,7 +14,7 @@ package org.apache.tapestry5.plastic; /** * Represents a field of a class being {@linkplain PlasticClass transformed}. - * <p> + * * No methods of this object should be invoked after the class transformation is completed. */ public interface PlasticField extends AnnotationAccess @@ -104,7 +102,7 @@ public interface PlasticField extends AnnotationAccess * Intercepts all access to the field, replacing such access with calls on the conduit. Even access via * the FieldHandle will instead delegate to the conduit. Once a conduit is provided, it is not possible * to inject a value into the field. - * <p> + * * Normally, once a conduit is in place, the field will never be actually read or written. This is problematic for * debugging, so {@link TransformationOption#FIELD_WRITEBEHIND} is useful when operating in a non-production mode. * http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticManager.java ---------------------------------------------------------------------- diff --git a/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticManager.java b/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticManager.java index e434387..5f31755 100644 --- a/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticManager.java +++ b/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticManager.java @@ -1,5 +1,3 @@ -// Copyright 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 @@ -14,15 +12,15 @@ package org.apache.tapestry5.plastic; -import java.util.Collection; -import java.util.EnumSet; -import java.util.Set; - import org.apache.tapestry5.internal.plastic.Lockable; import org.apache.tapestry5.internal.plastic.NoopDelegate; import org.apache.tapestry5.internal.plastic.PlasticClassPool; import org.apache.tapestry5.internal.plastic.PlasticInternalUtils; +import java.util.Collection; +import java.util.EnumSet; +import java.util.Set; + /** * Manages the internal class loaders and other logics necessary to load and transform existing classes, * or to create new classes dynamically at runtime. New instances are instantiates using @@ -224,7 +222,7 @@ public class PlasticManager implements PlasticClassListenerHub * @param callback * used to configure the new class * @return the instantiator, which allows instances of the new class to be created - * @see #createProxyTransformation(Class) + * @see #createProxyTransformation(Class, Class) */ public <T> ClassInstantiator<T> createProxy(Class<T> interfaceType, PlasticClassTransformer callback) { http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticMethod.java ---------------------------------------------------------------------- diff --git a/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticMethod.java b/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticMethod.java index 7ec9342..6b10c9c 100644 --- a/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticMethod.java +++ b/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticMethod.java @@ -16,7 +16,7 @@ import java.util.List; /** * A method of a {@linkplain PlasticClass transformed class}. - * <p/> + * * No methods of this object should be invoked after the class transformation is * {@linkplain PlasticClassTransformation#createInstantiator() completed}. */ @@ -40,9 +40,9 @@ public interface PlasticMethod extends AnnotationAccess /** * Clears the instructions for this method, and creates a new empty InstructionBuilder so that the implementation of * the method can be specified. This may be considered a kind of last resort when no other approach is sufficient. - * <p/> + * * If the method is currently abstract, it will have its abstract flag cleared. - * <p/> + * * If the method has advice, the advice is <em>not</em> lost but will instead wrap around the new method * implementation. * @@ -58,12 +58,12 @@ public interface PlasticMethod extends AnnotationAccess * through the MethodAdvice <em>in the order they are added</em>. Each piece of advice will receive the * {@link MethodInvocation} and should invoke {@link MethodInvocation#proceed()} to pass control to the next piece * of advice (and ultimately, to the actual method invocation). - * <p/> + * * If a method implementation is changed, using {@link #changeImplementation(InstructionBuilderCallback)}, that * change will be honored, but the logic will only be invoked at the end of the chain of MethodAdvice. Internally, a * new method is created with the same parameters, exceptions, return type and implementation (bytecode) as the * advised method, <em>then</em> the advised method's implementation is changed. - * <p/> + * * Note additionally that a recursive method invocation will still invoke the MethodAdvice chain on each recursive * call (this is an intended side-effect of copying the exact bytecode of the method implementation. * http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticUtils.java ---------------------------------------------------------------------- diff --git a/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticUtils.java b/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticUtils.java index c26257e..6ed424e 100644 --- a/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticUtils.java +++ b/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticUtils.java @@ -1,5 +1,3 @@ -// Copyright 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 @@ -40,7 +38,7 @@ public class PlasticUtils * Returns a string that can be used as part of a Java identifier and is unique * for this JVM. Currently returns a hexadecimal string and initialized by * System.nanoTime() (but both those details may change in the future). - * <p> + * * Note that the returned value may start with a numeric digit, so it should be used as a <em>suffix</em>, not * <em>prefix</em> of a Java identifier. * http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/plastic/src/main/java/org/apache/tapestry5/plastic/TryCatchBlock.java ---------------------------------------------------------------------- diff --git a/plastic/src/main/java/org/apache/tapestry5/plastic/TryCatchBlock.java b/plastic/src/main/java/org/apache/tapestry5/plastic/TryCatchBlock.java index cf073bd..abf38a0 100644 --- a/plastic/src/main/java/org/apache/tapestry5/plastic/TryCatchBlock.java +++ b/plastic/src/main/java/org/apache/tapestry5/plastic/TryCatchBlock.java @@ -1,5 +1,3 @@ -// Copyright 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 @@ -30,7 +28,7 @@ public interface TryCatchBlock * Ends the block (if not already ended) and inserts a catch block for the named exception. * The InstructionBuilder is returned so that the code for handling the exception can be added. The exception object * will be on top of the stack. This should be called after {@link #addTry(InstructionBuilderCallback)}. - * <p> + * * Note: no attempt is made currently to sort the handlers; for example adding a catch for java.lang.Exception first * will mean that more specific exception handlers added later will never be invoked. * http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/quickstart/filtered/archetype-resources/src/main/java/services/AppModule.java ---------------------------------------------------------------------- diff --git a/quickstart/filtered/archetype-resources/src/main/java/services/AppModule.java b/quickstart/filtered/archetype-resources/src/main/java/services/AppModule.java index 9af7b82..b205765 100644 --- a/quickstart/filtered/archetype-resources/src/main/java/services/AppModule.java +++ b/quickstart/filtered/archetype-resources/src/main/java/services/AppModule.java @@ -86,13 +86,13 @@ public class AppModule * RequestHandler service configuration. Tapestry IoC is responsible for passing in an * appropriate Logger instance. Requests for static resources are handled at a higher level, so * this filter will only be invoked for Tapestry related requests. - * <p/> - * <p/> + * + * * Service builder methods are useful when the implementation is inline as an inner class * (as here) or require some other kind of special initialization. In most cases, * use the static bind() method instead. - * <p/> - * <p/> + * + * * If this method was named "build", then the service id would be taken from the * service interface and would be "RequestFilter". Since Tapestry already defines * a service named "RequestFilter" we use an explicit service id that we can reference http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-beanvalidator/src/main/java/org/apache/tapestry5/beanvalidator/ClientConstraintDescriptor.java ---------------------------------------------------------------------- diff --git a/tapestry-beanvalidator/src/main/java/org/apache/tapestry5/beanvalidator/ClientConstraintDescriptor.java b/tapestry-beanvalidator/src/main/java/org/apache/tapestry5/beanvalidator/ClientConstraintDescriptor.java index 3e6e813..5d7f1fb 100644 --- a/tapestry-beanvalidator/src/main/java/org/apache/tapestry5/beanvalidator/ClientConstraintDescriptor.java +++ b/tapestry-beanvalidator/src/main/java/org/apache/tapestry5/beanvalidator/ClientConstraintDescriptor.java @@ -1,5 +1,3 @@ -// Copyright 2012 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 @@ -21,7 +19,7 @@ import java.util.Set; /** * Applies client-side validation constraints based on a particular JSR 303 annotation. - * <p/> + * * Note: converted from a final class to an interface as part of 5.4. */ public interface ClientConstraintDescriptor http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/Asset.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/Asset.java b/tapestry-core/src/main/java/org/apache/tapestry5/Asset.java index a7a9f25..9ea0ddb 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/Asset.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/Asset.java @@ -1,5 +1,3 @@ -// Copyright 2006, 2008, 2009, 2013 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 @@ -20,9 +18,9 @@ import org.apache.tapestry5.ioc.Resource; * An Asset is any kind of resource that can be exposed to the client web browser. Although quite often an Asset is a * resource in a web application's context folder, within Tapestry, Assets may also be resources on the classpath (i.e., * packaged inside JARs). - * <p/> + * * An Asset's toString() will return the URL for the resource (the same value as {@link #toClientURL()}). - * <p/> + * * Release 5.1.0.0 introduced {@link org.apache.tapestry5.Asset2}, which extends this interface with an additional * method. * @@ -33,14 +31,14 @@ public interface Asset /** * Returns a URL that can be passed, unchanged, to the client in order for it to access the resource. The same value * is returned from <code>toString()</code>. - * <p/> + * * Tapestry's built-in asset types (context and classpath) always incorporate a checksum as part of the path, * and alternate implementations are encouraged to do so as well. In addition, Tapestry ensures that context and * classpath assets have a far-future expires header (to ensure aggressive caching by the client). - * <p/>Note that starting in Tapestry 5.4, it is expected that Asset instances recognize + * Note that starting in Tapestry 5.4, it is expected that Asset instances recognize * when the underlying Resource's content has changed, and update the clientURL to reflect the new content's * checksum. This wasn't an issue in earlier releases where the clientURL incorporated a version number. - * <p/> + * * Finally, starting in 5.4, this value will often be <em>variant</em>: the exact URL returned will depend on * whether the underlying resource content is compressable, whether the current {@link org.apache.tapestry5.services.Request} * supports compression. http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/BaseOptimizedSessionPersistedObject.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/BaseOptimizedSessionPersistedObject.java b/tapestry-core/src/main/java/org/apache/tapestry5/BaseOptimizedSessionPersistedObject.java index 402328e..b66acf5 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/BaseOptimizedSessionPersistedObject.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/BaseOptimizedSessionPersistedObject.java @@ -1,5 +1,3 @@ -// Copyright 2008-2013 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 @@ -22,11 +20,11 @@ import java.util.concurrent.atomic.AtomicBoolean; * Base implementation of * {@link org.apache.tapestry5.OptimizedSessionPersistedObject}. Subclasses * should invoke {@link #markDirty()} after the internal state of the object changes. - * <p> + * * Due to the concurrent nature of session attributes it's important that markDirty occurs <strong>after</strong> * the object has been changed. If the change occurs before the object has been mutated it's possible that another * thread may re-store the object before the changes are actually made! - * <p> + * * @since 5.1.1.0 */ public abstract class BaseOptimizedSessionPersistedObject implements OptimizedSessionPersistedObject, Serializable http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/Binding.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/Binding.java b/tapestry-core/src/main/java/org/apache/tapestry5/Binding.java index 8a99914..0c49f4b 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/Binding.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/Binding.java @@ -1,5 +1,3 @@ -// Copyright 2006-2013 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 @@ -21,7 +19,7 @@ import org.apache.tapestry5.ioc.AnnotationProvider; * component to gain access to <em>resources</em> defined by the container. Resources can represent any kind of value * that can be obtained from the parent component, but is often a JavaBean property that can be read and updated. * Different implementations of Binding are used to access different kinds of resources of the container. - * <p/> + * * A binding ultimately must provide access to the underlying annotations. In most cases, there are no annotations, but * bindings that ultimate invoke methods or read and update fields must provide access to those annotations. */ http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/Block.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/Block.java b/tapestry-core/src/main/java/org/apache/tapestry5/Block.java index 95e658e..62ba9bc 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/Block.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/Block.java @@ -1,5 +1,3 @@ -// Copyright 2007-2013 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 @@ -18,7 +16,7 @@ package org.apache.tapestry5; * A block is a collection of static text and elements, and components, derived from a component template. In the * template, a block is demarcated using the <t:block> or <t:parameter> elements. The interface defines no * methods, but the provided implementations of Block are capable of rendering their contents on demand. - * <p/> + * * Tapestry includes coercions from String to {@link org.apache.tapestry5.Renderable} and {@link * org.apache.tapestry5.Renderable} to Block. This means that components that take Block parameters may be bound to * literal strings, to arbitrary numbers (or other objects, with the expectation that they will be converted to http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/ClientElement.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/ClientElement.java b/tapestry-core/src/main/java/org/apache/tapestry5/ClientElement.java index 2680661..5556df4 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/ClientElement.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/ClientElement.java @@ -1,5 +1,3 @@ -// Copyright 2007, 2010 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 @@ -21,7 +19,7 @@ import org.apache.tapestry5.services.javascript.JavaScriptSupport; * id}, typically used in the generation of client-side (JavaScript) logic. For components, the client id will be null * or inaccurate until after the component has rendered itself. Inside of any kind of loop, the clientId property is * only accurate just after the component has rendered, and before it renders again. - * <p/> + * * Some components must be configured to provide a client id. In many cases, the client id matches the component's * {@linkplain ComponentResourcesCommon#getId() component id}, typically passed through * {@link JavaScriptSupport#allocateClientId(String)} to ensure uniqueness. http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/ComponentAction.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/ComponentAction.java b/tapestry-core/src/main/java/org/apache/tapestry5/ComponentAction.java index 3899be0..488745f 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/ComponentAction.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/ComponentAction.java @@ -1,5 +1,3 @@ -// 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 @@ -19,10 +17,10 @@ import java.io.Serializable; /** * An action that is associated with a component. This is used in several areas of Tapestry and is primarily an attempt * to externalize state for a component so that it can be recorded outside the object. - * <p/> + * * ComponentActions should be immutable. They are often created during one request and associated with a particular * component instance. They are then used in a later request (with an equivalent component instance). - * <p/> + * * ComponentActions are serializable (they are often serialized into Base64 strings for storage on the client). */ public interface ComponentAction<T> extends Serializable http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/ComponentEventCallback.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/ComponentEventCallback.java b/tapestry-core/src/main/java/org/apache/tapestry5/ComponentEventCallback.java index 4861efa..b0b7b7e 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/ComponentEventCallback.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/ComponentEventCallback.java @@ -1,5 +1,3 @@ -// Copyright 2006, 2008, 2010 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 @@ -26,7 +24,7 @@ public interface ComponentEventCallback<T> * Invoked to handle a non-null event handler method result. The handler should determine whether the value is * acceptable, and throw an exception if not. Any thrown exception will be wrapped to identify the component and * method from which the value was returned. - * <p/> + * * Boolean values are <em>not</em> passed to the callback. Booleans are used to indicate that the event has been * handled (true, meaning the event is handled and aborted) or that a further search for handlers should continue * (false, meaning the event was not handled, is not aborted, and the search up the component hierarchy for event http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/ComponentResources.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/ComponentResources.java b/tapestry-core/src/main/java/org/apache/tapestry5/ComponentResources.java index 5c51903..e6e1839 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/ComponentResources.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/ComponentResources.java @@ -1,5 +1,3 @@ -// Copyright 2006-2013 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 @@ -138,7 +136,7 @@ public interface ComponentResources extends ComponentResourcesCommon * @param parameterName * used to select the parameter (case is ignored) * @return the generic type of the bound parameter, or null if the parameter is not bound - * @see Binding#getBindingGenericType() + * @see Binding#getBindingType() */ Type getBoundGenericType(String parameterName); http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/ComponentResourcesCommon.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/ComponentResourcesCommon.java b/tapestry-core/src/main/java/org/apache/tapestry5/ComponentResourcesCommon.java index 6d2b20c..ddaa422 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/ComponentResourcesCommon.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/ComponentResourcesCommon.java @@ -41,7 +41,7 @@ public interface ComponentResourcesCommon extends Locatable /** * Returns a string consisting of the logical name of the containing page, and the {@link #getNestedId() nested id} * of this component, separated by a colon. I.e., "MyPage:foo.bar.baz". For a page, returns just the page's name. - * <p/> + * * This value is often used to obtain an equivalent component instance in a later request. * * @see org.apache.tapestry5.services.ComponentSource#getComponent(String) @@ -74,7 +74,7 @@ public interface ComponentResourcesCommon extends Locatable * container, and so on. When a matching event handler method is located, it is invoked. If the method returns a * value, the value is passed to the callback (if callback is null, then it is an error for a method to return a * non-null value). - * <p/> + * * Resolution of event type to event handler methods is case insensitive. * * @param eventType http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/ContentType.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/ContentType.java b/tapestry-core/src/main/java/org/apache/tapestry5/ContentType.java index 93739f3..04362a8 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/ContentType.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/ContentType.java @@ -27,7 +27,7 @@ import java.util.regex.Pattern; * Represents an HTTP content type. Allows to set various elements like the MIME type, the character set, and other * parameters. This is similar to a number of other implementations of the same concept in JAF, etc. We have created * this simple implementation to avoid including the whole libraries. - * <p/> + * * As of Tapestry 5.4, this is now an immutable data type. */ public final class ContentType http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/Field.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/Field.java b/tapestry-core/src/main/java/org/apache/tapestry5/Field.java index c22b28d..2ba5a18 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/Field.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/Field.java @@ -15,12 +15,12 @@ package org.apache.tapestry5; /** * Defines a field within a form. Fields have a <a href="http://www.w3.org/TR/html4/interact/forms.html#control-name">control * name</a> that is used when rendering and, later, when the form is submitted, to identify the query parameter. - * <p/> + * * Timing is important, as components may render multiple times, due to looping and other factors. Generally, a * component's {@link #getControlName()} will only be accurate after it has rendered. In some cases, when generating * JavaScript for example, it is necessary to {@linkplain org.apache.tapestry5.services.Heartbeat#defer(Runnable) wait * until the end of the current Heartbeat} to ensure that all components have had their chance to render. - * <p/> + * * Most Fields also implement {@link org.apache.tapestry5.Field2}, which was introduced to bridge a gap related to * re-rendering a form as part of an Ajax request. */ http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/Field2.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/Field2.java b/tapestry-core/src/main/java/org/apache/tapestry5/Field2.java index 3322325..6382f39 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/Field2.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/Field2.java @@ -16,12 +16,12 @@ package org.apache.tapestry5; * Due to how control names and client ids are allocated inside during an Ajax request, it is difficult to * to connect input data and field validation errors to the fields, since the control name and client id are different * during the processing of the submitted form data and during the subsequent render. Starting in 5.4, the - * key used to identify a field inside the {@link org.apache.tapestry5.ValidationTracker is this new validation id, + * key used to identify a field inside the {@link ValidationTracker} is this new validation id, * which is assigned on first read. - * <p/> - * If a field inplements {@link org.apache.tapestry5.Field} but not Field2, then the control name is used as the + * + * If a field implements {@link Field} but not Field2, then the control name is used as the * validation id (which will work correctly during non-Ajax requests). - * <p/> + * * This assumes a "flat" field structure, where a given component renders only once (not multiple times, inside * a {@link org.apache.tapestry5.corelib.components.Loop}. * http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/Link.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/Link.java b/tapestry-core/src/main/java/org/apache/tapestry5/Link.java index 212cb90..19e8185 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/Link.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/Link.java @@ -1,5 +1,3 @@ -// Copyright 2006-2013 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 @@ -26,7 +24,7 @@ import java.util.List; * A link is the Tapestry representation of a URL or URI that triggers dynamic behavior. This link is in three parts: a * path portion, an optional anchor, and a set of query parameters. A request for a link will ultimately be recognized * by a {@link org.apache.tapestry5.services.Dispatcher}. - * <p/> + * * Query parameter values are kept separate from the path portion to support encoding those values into hidden form * fields (where appropriate). */ @@ -44,11 +42,11 @@ public interface Link /** * Returns the value of a specifically named query parameter, or <tt>null</tt> if no such query parameter is stored * in the link. - * <p/> - * <p>Use this method only when you are sure the parameter has only one value. If the parameter might have more than + * + * Use this method only when you are sure the parameter has only one value. If the parameter might have more than * one value, use {@link #getParameterValues}. - * <p/> - * <p>If you use this method with a multivalued parameter, the value returned is equal to the first value in the + * + * If you use this method with a multivalued parameter, the value returned is equal to the first value in the * array returned by <code>getParameterValues</code>. * * @return a string representing the single value of the named parameter @@ -138,7 +136,7 @@ public interface Link * Returns the absolute URL, which includes the scheme, hostname and possibly port (as per * {@link BaseURLSource#getBaseURL(boolean)}). * By default, the scheme is chosen to match the {@linkplain Request#isSecure() security} of the current request. - * <p/> + * * Note: the semantics of this method changed between Tapestry 5.1 and 5.2. Most code should use toString() or * {@link #toURI()} (which are equivalent) instead. * http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/MarkupWriter.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/MarkupWriter.java b/tapestry-core/src/main/java/org/apache/tapestry5/MarkupWriter.java index 18169e6..ba9c077 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/MarkupWriter.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/MarkupWriter.java @@ -1,5 +1,3 @@ -// Copyright 2006, 2007, 2008 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 @@ -35,7 +33,7 @@ public interface MarkupWriter * Begins a new element as a child of the current element. The new element becomes the current element. The new * Element is returned and can be directly manipulated (possibly at a later date). Optionally, attributes for the * new element can be specified directly. - * <p/> + * * * @param name the name of the element to create * @param attributes an even number of values, alternating names and values http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/OptimizedSessionPersistedObject.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/OptimizedSessionPersistedObject.java b/tapestry-core/src/main/java/org/apache/tapestry5/OptimizedSessionPersistedObject.java index b7534f4..41c5334 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/OptimizedSessionPersistedObject.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/OptimizedSessionPersistedObject.java @@ -1,5 +1,3 @@ -// Copyright 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 @@ -20,7 +18,7 @@ package org.apache.tapestry5; * in-memory changes are flushed to other persistent session stores (e.g. RDBMS, servers in a cluster, etc). Objects * that implement this interface are expected to track when they are dirty (have pending changes), so that the save * back into the session can be avoided when not necessary. - * <p> + * * This method is accessed concurrently. * * @see org.apache.tapestry5.annotations.ImmutableSessionPersistedObject http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/PageCallback.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/PageCallback.java b/tapestry-core/src/main/java/org/apache/tapestry5/PageCallback.java index 081ed9b..18574b7 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/PageCallback.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/PageCallback.java @@ -1,5 +1,3 @@ -// Copyright 2010 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 @@ -14,19 +12,19 @@ package org.apache.tapestry5; -import java.io.Serializable; - import org.apache.tapestry5.annotations.ImmutableSessionPersistedObject; import org.apache.tapestry5.internal.InternalConstants; import org.apache.tapestry5.ioc.internal.util.InternalUtils; import org.apache.tapestry5.services.PageRenderLinkSource; +import java.io.Serializable; + /** * A way of capturing the name of a page and the page activation context so that, at a future date, * the page can be invoked with that data. This kind of callback is very useful when creating more * complicated workflows, where access to a page is "interrupted" with some operation before * returning (via a callback) to the original flow. - * <p> + * * Since the callback is serializable, it can be stored in the session. * * @since 5.2.0 http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/SelectModel.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/SelectModel.java b/tapestry-core/src/main/java/org/apache/tapestry5/SelectModel.java index ec96edf..a25d7a6 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/SelectModel.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/SelectModel.java @@ -1,5 +1,3 @@ -// Copyright 2007, 2008 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 @@ -18,7 +16,7 @@ import java.util.List; /** * Defines the possible options and option groups for a <select> [X]HTML element. - * <p/> + * * Primarily used by the {@link org.apache.tapestry5.corelib.components.Select} component, but potentially used by * anything similar, that needs to present a list of options to the user. Generally paired with a {@link * org.apache.tapestry5.ValueEncoder} to create client-side representations of server-side values. http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/SymbolConstants.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/SymbolConstants.java b/tapestry-core/src/main/java/org/apache/tapestry5/SymbolConstants.java index 00cb3a7..ae6f58c 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/SymbolConstants.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/SymbolConstants.java @@ -40,7 +40,7 @@ public class SymbolConstants * Indicates whether Tapestry is running in production mode or developer mode. This affects a large * number of Tapestry behaviors related to performance and security, including how exceptions are * reported, whether far-future expire headers are emitted, whether JavaScript files may be combined, - * whether JSON is compressed, whether component field & parameter values are shadowed to instance + * whether JSON is compressed, whether component field and parameter values are shadowed to instance * variables (to assist with debugging), and more. */ public static final String PRODUCTION_MODE = "tapestry.production-mode"; @@ -134,7 +134,7 @@ public class SymbolConstants * Version number of the application. Prior to 5.4, this version number was integrated into asset URLs. Starting * with 5.4, a checksum of the individual asset's content is used instead, and this version number is only used * for documentation purposes; it appears in the default exception report page, for example. - * <p/> + * * The default value is "0.0.1". In 5.3 and earlier, the default value was a random hexadecimal string. * * @see AssetDispatcher @@ -282,7 +282,7 @@ public class SymbolConstants * If "true", then resources (individually or when aggregated into stacks) will be minimized via the * {@link ResourceMinimizer} service. If "false", then minification is disabled. Tracks production mode * (minification is normally disabled in development mode). - * <p/> + * * Note that Tapestry's default implementation of {@link ResourceMinimizer} does nothing; minification is provided * by add-on libraries. * @@ -294,9 +294,9 @@ public class SymbolConstants * If "true" then at the end of each request the * {@link org.apache.tapestry5.services.SessionPersistedObjectAnalyzer} will be called on each session persisted * object that was accessed during the request. - * <p/> + * * This is provided as a performance enhancement for servers that do not use clustered sessions. - * <p/> + * * The default is {@code true}, to preserve 5.2 behavior. For non-clustered applications (the majority), this value should be * overridden to {@code false}. A future release of Tapestry may change the default. * @@ -309,14 +309,14 @@ public class SymbolConstants * URLs in the context under the context root; by setting this to the name of a folder, the T5 URLs will be inside that folder only, and should * match a corresponding entry in the {@code web.xml} configuration file. This is useful when running multiple servlets within the same web application (such as when migrating * from Tapestry 4 or some other framework, to Tapestry 5). - * <p>Effectively, if this symbol is set to a value, that folder name will be placed after the context path + * Effectively, if this symbol is set to a value, that folder name will be placed after the context path * (typically "/") and before the locale, page name, or other prefix. For example, if this symbol is set to "app", the {@code web.xml <url-pattern>} should be set to {@code /app/*}, and Tapestry will * only be in invoked by the servlet container for requests inside the virtual {@code app} folder. - * <p/> + * * This also affects the search for page templates (which are allowed within the web context). When set to a non-blank value, page templates are searched for in the folder, rather than in the root context. - * <p/> + * * The default value is the empty string, which preserves Tapestry 5.2 behavior (and continues to be appropriate for most applications). - * <p/> + * * Note that while Tapestry is case-insensitive, the servlet container is not, so the configured value must exactly match * the folder name inside the {@code <url-parameter>} value, including case. * @@ -336,7 +336,7 @@ public class SymbolConstants * Prefix to be used for all resource paths, used to recognize which requests are for assets. This value * is appended to the context path and the (optional {@linkplain #APPLICATION_FOLDER application folder}. * It may contain slashes, but should not begin or end with one. - * <p/> + * * The default is "assets". */ public static final String ASSET_PATH_PREFIX = "tapestry.asset-path-prefix"; @@ -346,7 +346,7 @@ public class SymbolConstants * Prefix used for all module resources. This may contain slashes, but should not being or end with one. * Tapestry will create two {@link org.apache.tapestry5.services.Dispatcher}s from this: one for normal * modules, the other for GZip compressed modules (by appending ".gz" to this value). - * <p/> + * * The default is "modules". * * @since 5.4 @@ -390,7 +390,7 @@ public class SymbolConstants * as a {@link org.apache.tapestry5.services.javascript.JavaScriptModuleConfiguration} to provide a specific implementation * of the {@code t5/core/dom} module. Tapestry 5.4 directly supports "prototype" or "jquery". To support * other foundation frameworks, override this symbol value and supply your own module configuration. - * <p/> + * * In Tapestry 5.4, this defaults to "prototype" for compatibility with 5.3. This will likely change in * 5.5 to default to "jquery". At some point in the future, Prototype support will no longer be present. * @@ -415,7 +415,7 @@ public class SymbolConstants * If true (the default), then Tapestry will automatically include the "core" stack in all * pages. * - * @see https://issues.apache.org/jira/browse/TAP5-2169 + * @see <a href="https://issues.apache.org/jira/browse/TAP5-2169">TAP5-2169</a> * @since 5.4 */ public static final String INCLUDE_CORE_STACK = "tapestry.include-core-stack"; @@ -426,7 +426,7 @@ public class SymbolConstants * {@linkplain BeanEditForm} and {@linkplain BeanEditor} * components surrounding the label and the field. The default value is <code>form-group</code>. * - * @see https://issues.apache.org/jira/browse/TAP5-2182 + * @see <a href="https://issues.apache.org/jira/browse/TAP5-2182">TAP5-2182</a> * @since 5.4 */ public static final String FORM_GROUP_WRAPPER_CSS_CLASS = "tapestry.form-group-wrapper-css-class"; @@ -437,7 +437,7 @@ public class SymbolConstants * If this symbol is null or an empty string, no element will be generated surrouding the * form field. The default value is the empty string (no wrapping). * - * @see https://issues.apache.org/jira/browse/TAP5-2182 + * @see <a href="https://issues.apache.org/jira/browse/TAP5-2182">TAP5-2182</a> * @see #FORM_GROUP_FORM_FIELD_WRAPPER_ELEMENT_CSS_CLASS * @since 5.4 */ @@ -449,7 +449,7 @@ public class SymbolConstants * when {@linkplain #FORM_GROUP_FORM_FIELD_WRAPPER_ELEMENT_NAME} is not set to null or the empty string. * The default value is the empty string (no CSS class added). * - * @see https://issues.apache.org/jira/browse/TAP5-2182 + * @see <a href="https://issues.apache.org/jira/browse/TAP5-2182">TAP5-2182</a> * @since 5.4 */ public static final String FORM_GROUP_FORM_FIELD_WRAPPER_ELEMENT_CSS_CLASS = "tapestry.form-group-form-field-wrapper-element-css-class"; @@ -460,7 +460,7 @@ public class SymbolConstants * {@linkplain BeanEditForm} and {@linkplain BeanEditor} * components. The default value is <code>control-label</code>. * - * @see https://issues.apache.org/jira/browse/TAP5-2182 + * @see <a href="https://issues.apache.org/jira/browse/TAP5-2182">TAP5-2182</a> * @since 5.4 */ public static final String FORM_GROUP_LABEL_CSS_CLASS = "tapestry.form-group-label-css-class"; @@ -469,7 +469,7 @@ public class SymbolConstants * Defines the CSS class that will be given to form field components which are * {@linkplain AbstractField} subclasses. The default value is <code>form-control</code>. * - * @see https://issues.apache.org/jira/browse/TAP5-2182 + * @see <a href="https://issues.apache.org/jira/browse/TAP5-2182">TAP5-2182</a> * @since 5.4 */ public static final String FORM_FIELD_CSS_CLASS = "tapestry.form-field-css-class"; @@ -486,7 +486,7 @@ public class SymbolConstants * The directory to which exception report files should be written. The default is appropriate * for development: {@code build/exceptions}, and should be changed for production. * - * @see org.apache.tapestry5.services.exceptions.ExceptionReporter + * @see org.apache.tapestry5.services.ExceptionReporter * @since 5.4 */ http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/TapestryConstants.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/TapestryConstants.java b/tapestry-core/src/main/java/org/apache/tapestry5/TapestryConstants.java index c06ed59..ad1495a 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/TapestryConstants.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/TapestryConstants.java @@ -46,12 +46,12 @@ public class TapestryConstants /** * Name of a request attribute that contains an {@link org.apache.tapestry5.ioc.IOOperation} * used to render the response. The operation should return void. - * <p/> + * * Implementations of {@link org.apache.tapestry5.services.ComponentEventResultProcessor} * will store a response rendering operation into the request; the operation, if present, * will be executed as the first filter inside the * {@link org.apache.tapestry5.services.ComponentRequestHandler} pipeline. - * <p/> + * * This approach is recommended for any "complex" rendering that involves components or pages. * It is optional for other types. * http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/TapestryFilter.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/TapestryFilter.java b/tapestry-core/src/main/java/org/apache/tapestry5/TapestryFilter.java index 61c2cdb..d4237e0 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/TapestryFilter.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/TapestryFilter.java @@ -1,5 +1,3 @@ -// Copyright 2006-2013 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 @@ -38,14 +36,14 @@ import java.io.IOException; * that are relevant to Tapestry, and lets the servlet container handle the rest. It is also * responsible for * initializing Tapestry. - * <p/> + * * The application is primarily configured via context-level init parameters. - * <p/> + * * <dl> * <dt>tapestry.app-package</dt> * <dd>The application package (used to search for pages, components, etc.)</dd> * </dl> - * <p/> + * * In addition, a JVM system property affects configuration: <code>tapestry.execution-mode</code> * (with default value "production"). This property is a comma-separated list of execution modes. * For each mode, an additional init parameter is checked for: http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/TrackableComponentEventCallback.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/TrackableComponentEventCallback.java b/tapestry-core/src/main/java/org/apache/tapestry5/TrackableComponentEventCallback.java index 4a3672f..fdd76bd 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/TrackableComponentEventCallback.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/TrackableComponentEventCallback.java @@ -1,5 +1,3 @@ -// Copyright 2010 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 @@ -14,19 +12,19 @@ package org.apache.tapestry5; -import java.io.IOException; - import org.apache.tapestry5.annotations.Environmental; import org.apache.tapestry5.services.ComponentEventResultProcessor; import org.apache.tapestry5.services.Traditional; +import java.io.IOException; + /** * Extends {@link ComponentEventCallback} with a way to determine if the underlying event has been aborted * due to a some event returning an acceptable, non-null value. The standard implementation of this * is a wrapper around either the {@linkplain Traditional traditional} or * {@linkplain org.apache.tapestry5.services.Ajax ajax} versions of the {@link ComponentEventResultProcessor} * service, i.e., they allow for a navigational result. - * <p> + * * Instances of this are made available via the {@link Environmental} annotation. * * @since 5.2.0 http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/ValidationDecorator.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/ValidationDecorator.java b/tapestry-core/src/main/java/org/apache/tapestry5/ValidationDecorator.java index 51e380a..7d214f5 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/ValidationDecorator.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/ValidationDecorator.java @@ -1,5 +1,3 @@ -// Copyright 2007, 2008 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 @@ -19,12 +17,12 @@ import org.apache.tapestry5.dom.Element; /** * An object responsible for performing decorations around fields and field labels. The decorator is notified at * intervals by the fields and labels. - * <p/> + * * In most western languages (written left to right) the label will render before the field, so the properties of the * Field may not be set yet (or may reflect a previous looping's rendering). It may be necessary to {@linkplain * org.apache.tapestry5.services.Heartbeat#defer(Runnable)} defer any rendering} until after the Label and the Field have * both had their change to initialize and render. - * <p/> + * * Modern HTML and CSS, especially under HTML5 and CSS3, really makes this pointless; it is possible to handle all * of these issues directly in the client. ValidationDecorator will be supported in Tapestry 5.4, * but the default implementation will be changed to do nothing. http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/ValidationTracker.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/ValidationTracker.java b/tapestry-core/src/main/java/org/apache/tapestry5/ValidationTracker.java index 2230d13..0b3bf77 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/ValidationTracker.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/ValidationTracker.java @@ -1,5 +1,3 @@ -// Copyright 2006, 2008, 2013 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 @@ -21,16 +19,16 @@ import java.util.List; /** * Tracks information related to user input validations. This information is: <ul> <li>The input values provided by the * user. <li>Any validation exceptions associated with input fields. </ul> - * <p/> + * * The tracker must differentiate between components (which will implement the {@link Field} interfaces) and fields. It * is a one to many relationship, because each field may be called upon to render itself multiple times within a * request, because of {@link Loop} or other similar components. - * <p/> + * * Internally, the tracker indexes its information in terms of the {@linkplain Field#getControlName() control name} for * each rendering of the component (the mechanics of Tapestry ensures that this is unique within the form). - * <p/> + * * Validation trackers must be serializable, as they will almost always be stored into the HttpSession. - * <p/> + * * Trackers are used by only a single form within a single page; they are not threadsafe. */ public interface ValidationTracker http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/Validator.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/Validator.java b/tapestry-core/src/main/java/org/apache/tapestry5/Validator.java index c54345c..7461dca 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/Validator.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/Validator.java @@ -1,5 +1,3 @@ -// Copyright 2006, 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 @@ -20,7 +18,7 @@ import org.apache.tapestry5.services.FormSupport; /** * Used by a {@link Field} to enforce a <strong>constraint</strong> related to a form submission. Validators themselves * are stateless singletons. - * <p/> + * * Validators are usually encapsulated inside a {@link FieldValidator}. * * @see FieldValidationSupport http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/ValueEncoder.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/ValueEncoder.java b/tapestry-core/src/main/java/org/apache/tapestry5/ValueEncoder.java index d8cd164..3476c85 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/ValueEncoder.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/ValueEncoder.java @@ -1,5 +1,3 @@ -// Copyright 2007-2013 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 @@ -19,25 +17,25 @@ package org.apache.tapestry5; * strings (typically IDs) and back. This mechanism is widely used in Tapestry * to allow you to work more seamlessly with objects rather than manually * managing the encoding and decoding process throughout your application. - * <p/> + * * Tapestry uses a ValueEncoder when generating an * {@link org.apache.tapestry5.EventContext} as part of a URL, and when * components (such as {@link org.apache.tapestry5.corelib.components.Select}) * need to generate unique client-side strings to be rendered within form * elements. - * <p/> + * * Tapestry can automatically generate ValueEncoders for enums as well as * Collections of any object types for which a coercion can be found from a * formatted String, such as primitives, primitive wrappers, Dates, Calendars, * "name=value" strings, and any types for which a {@linkplain org.apache.tapestry5.ioc.services.TypeCoercer * custom type coercion} has been contributed. - * <p/> + * * Custom ValueEncoder implementations will need to be supplied for entity type * objects. In such cases the {@link #toClient(Object)} method typically returns * an object's database primary key, and the {@link #toValue(String)} * re-acquires the corresponding entity object, perhaps by doing a database * lookup by that ID. - * <p/> + * * Some optional modules, such as Tapestry's own Hibernate and JPA modules, can * automatically create a ValueEncoder for each of your entity types and then * configure Tapestry to use them whenever a ValueEncoder is needed for those http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/VersionUtils.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/VersionUtils.java b/tapestry-core/src/main/java/org/apache/tapestry5/VersionUtils.java index 130ed31..61ce301 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/VersionUtils.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/VersionUtils.java @@ -1,5 +1,3 @@ -// Copyright 2007-2013 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 @@ -29,7 +27,7 @@ public class VersionUtils * Reads a version number from a properties file on the classpath. These files are generally created by Gradle. For * example, tapestry-core's properties file is <code>META-INF/gradle/org.apache.tapestry/tapestry-core/pom.properties</code>. * The Gradle generated properties files include the version and possibly others properties. - * <p/> + * * The resource is located using the Thread's context class loader. * * @param resourcePath the complete path to the resource, including a leading slash. http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/ajax/MultiZoneUpdate.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/ajax/MultiZoneUpdate.java b/tapestry-core/src/main/java/org/apache/tapestry5/ajax/MultiZoneUpdate.java index 3797176..3d24f23 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/ajax/MultiZoneUpdate.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/ajax/MultiZoneUpdate.java @@ -1,5 +1,3 @@ -// Copyright 2009, 2010 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 @@ -24,7 +22,7 @@ import java.util.Map; * A mapping from <em>client-side zone ids</em> to objects that can render the content for that zone on the client. An * event handler method may instantiate an instance and chain together a series of calls to {@link #add(String, Object)} * , and return the final result. - * <p/> + * * Remember that client-side element ids may not match server-side component ids, especially once Ajax is added to the * mix. Because of this, it is highly recommended that the client-side logic gather the actual component ids and include * those in the Ajax request, to ensure that the server generates updates that the client can process. Better yet, use http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/annotations/ActivationRequestParameter.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/ActivationRequestParameter.java b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/ActivationRequestParameter.java index f7e264d..7dc171b 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/ActivationRequestParameter.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/ActivationRequestParameter.java @@ -12,14 +12,6 @@ package org.apache.tapestry5.annotations; -import static java.lang.annotation.RetentionPolicy.RUNTIME; -import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.PAGE; - -import java.lang.annotation.Documented; -import java.lang.annotation.ElementType; -import java.lang.annotation.Retention; -import java.lang.annotation.Target; - import org.apache.tapestry5.ComponentResources; import org.apache.tapestry5.EventConstants; import org.apache.tapestry5.Link; @@ -27,21 +19,29 @@ import org.apache.tapestry5.ValueEncoder; import org.apache.tapestry5.ioc.annotations.UseWith; import org.apache.tapestry5.services.ValueEncoderSource; +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.Target; + +import static java.lang.annotation.RetentionPolicy.RUNTIME; +import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.PAGE; + /** * Marks a field of a page (not a component) as persistent within the URL, as with a page activation context. The field * is mapped * to a query parameter. When component event or page render links are generated for the page, * additional values will be added to the {@link Link} (via the {@link EventConstants#DECORATE_COMPONENT_EVENT_LINK} or * {@link EventConstants#DECORATE_PAGE_RENDER_LINK} events). - * <p> + * * The field may be of any type; a {@link ValueEncoder} (from the {@link ValueEncoderSource}) will be used to convert * between client-side and server-side representations. Null values are not added as query parameters (just non-null). - * <p> + * * When a page is activated, the mapped fields will receive their values before an {@linkplain EventConstants#ACTIVATE * activate} event handler method is invoked. - * <p> + * * This annotation is an alternative to {@link Persist}. - * <p> + * * Fields annotated with ActivationRequestParameter are <em>not</em> considered persistent (its a process parallel to the one * related to the {@link Persist} annotation). Invoking {@link ComponentResources#discardPersistentFieldChanges()} will * <em>not</em> affect annotated fields, only assigning them back to null will. http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/annotations/BeforeRenderBody.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/BeforeRenderBody.java b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/BeforeRenderBody.java index 11aa8eb..4444f91 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/BeforeRenderBody.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/BeforeRenderBody.java @@ -1,5 +1,3 @@ -// Copyright 2006, 2009 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 @@ -14,25 +12,26 @@ package org.apache.tapestry5.annotations; +import org.apache.tapestry5.ioc.annotations.UseWith; + import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; -import static java.lang.annotation.RetentionPolicy.RUNTIME; import java.lang.annotation.Target; +import static java.lang.annotation.RetentionPolicy.RUNTIME; import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*; -import org.apache.tapestry5.ioc.annotations.UseWith; /** * Marks methods to be invoked when the component rendering state machine hits the point in the component's template * where the body element occurs. Such methods may optionally take a {@link org.apache.tapestry5.MarkupWriter} * parameter, and may return void or boolean. - * <p/> + * * Returning true (or void) will queue up the component's body for rendering. - * <p/> + * * Returning false will skip the component's body, but continue rendering the template. The {@link * org.apache.tapestry5.annotations.AfterRenderBody} phase will still execute after the template finishes rendering. - * <p/> + * * This phase is skipped for components which do not have a body. */ @Target(ElementType.METHOD) http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/annotations/BeginRender.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/BeginRender.java b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/BeginRender.java index 3449a79..6b33204 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/BeginRender.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/BeginRender.java @@ -1,5 +1,3 @@ -// Copyright 2006, 2007, 2009 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 @@ -14,29 +12,30 @@ package org.apache.tapestry5.annotations; +import org.apache.tapestry5.ioc.annotations.UseWith; + import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; -import static java.lang.annotation.RetentionPolicy.RUNTIME; import java.lang.annotation.Target; +import static java.lang.annotation.RetentionPolicy.RUNTIME; import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*; -import org.apache.tapestry5.ioc.annotations.UseWith; /** * Marker annotation for methods that should be executed at the start of rendering the component. This usually includes * rendering of the component's start tag. - * <p/> + * * Such methods may optionally take a {@link org.apache.tapestry5.MarkupWriter} parameter, and may return void or * boolean. Returning true or void will allow the component to advance into the render template / render body phase. If * a body is present, the {@link org.apache.tapestry5.annotations.BeforeRenderBody} phase will execute. If a component * has a template, the {@link BeforeRenderTemplate} phase will execute (and the render body will only occur if the * template directs so). - * <p/> + * * Either way, the {@link org.apache.tapestry5.annotations.AfterRender} phase will execute after the template and/or * body have rendered. A component with a body but without a template will still see the {@link * org.apache.tapestry5.annotations.BeforeRenderBody} phase execute. - * <p/> + * * Returning false will skip rendering of the template and/or body, and jump directly to the {@link AfterRender} phase. */ @Target(ElementType.METHOD) http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/annotations/BindParameter.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/BindParameter.java b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/BindParameter.java index 4f6445b..03b751a 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/BindParameter.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/BindParameter.java @@ -1,5 +1,3 @@ -// Copyright 2009 , 2010 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 @@ -14,16 +12,16 @@ package org.apache.tapestry5.annotations; -import java.lang.annotation.Target; +import org.apache.tapestry5.internal.transform.BindParameterWorker; +import org.apache.tapestry5.ioc.annotations.UseWith; + import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.MIXIN; -import org.apache.tapestry5.internal.transform.BindParameterWorker; -import org.apache.tapestry5.ioc.annotations.UseWith; - /** * Designates a field in a mixin which is bound to the parameter of the containing * component corresponding to the value of the annotation. If no value is specified, @@ -31,7 +29,7 @@ import org.apache.tapestry5.ioc.annotations.UseWith; * For example, a mixin intended to work with form fields would define a field named * "value", marked by this annotation. The user-variable bound to the component's value * parameter would ultimately be bound in a chain: - * uservariable <=> mixin.value <=> component.value. + * user-variable {@code <=>} mixin.value {@code <=>} component.value. * Changes to any one value in the chain will be propagated accordingly. * * @since 5.2.0 http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Cached.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Cached.java b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Cached.java index aaf35f4..a53e4ec 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Cached.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Cached.java @@ -1,5 +1,3 @@ -// Copyright 2008-2014 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 @@ -14,17 +12,18 @@ package org.apache.tapestry5.annotations; +import org.apache.tapestry5.ioc.annotations.UseWith; + import java.lang.annotation.*; import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*; -import org.apache.tapestry5.ioc.annotations.UseWith; /** * Indicates that a method should only be evaluated once per request and the result cached. * Further calls to the method during the same request will return the cached result. * However, if the method's component occurs more than once within an enclosing component, * the cached results will be distinct for each occurrence. - * <p/> + * * This annotation is commonly used on getters for component properties: * <pre> * @Cached @@ -33,10 +32,10 @@ import org.apache.tapestry5.ioc.annotations.UseWith; * } * </pre> * You may not apply @Cached to void methods or methods with parameters. - * <p/> + * * Note that this annotation is inheritance-safe; if a subclass calls a superclass method that * has @Cached then the value the subclass method gets is the cached value. - * <p/> + * * The watch parameter can be passed a binding expression which will be evaluated each time the method is called. The * method will then only be executed the first time it is called and after that only when the value of the binding * changes. This can be used, for instance, to have the method only evaluated once per iteration of a loop by setting http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Environmental.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Environmental.java b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Environmental.java index 621259f..76680c4 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Environmental.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Environmental.java @@ -1,5 +1,3 @@ -// Copyright 2006, 2009, 2010 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 @@ -14,23 +12,21 @@ package org.apache.tapestry5.annotations; -import static java.lang.annotation.ElementType.FIELD; -import static java.lang.annotation.RetentionPolicy.RUNTIME; -import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.COMPONENT; -import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.MIXIN; -import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.PAGE; +import org.apache.tapestry5.ioc.annotations.UseWith; +import org.apache.tapestry5.services.javascript.JavaScriptSupport; import java.lang.annotation.Documented; import java.lang.annotation.Retention; import java.lang.annotation.Target; -import org.apache.tapestry5.ioc.annotations.UseWith; -import org.apache.tapestry5.services.javascript.JavaScriptSupport; +import static java.lang.annotation.ElementType.FIELD; +import static java.lang.annotation.RetentionPolicy.RUNTIME; +import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*; /** * Defines a field of a component class that is replaced at runtime with a read-only value obtained from the * {@link org.apache.tapestry5.services.Environment} service. - * <p> + * * Most commonly, the field will be of type {@link JavaScriptSupport}, {@link org.apache.tapestry5.services.Heartbeat} * or {@link org.apache.tapestry5.services.FormSupport}, though many other options are possible. */ http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/annotations/HeartbeatDeferred.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/HeartbeatDeferred.java b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/HeartbeatDeferred.java index 9bbbf05..fcfc4fe 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/HeartbeatDeferred.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/HeartbeatDeferred.java @@ -1,5 +1,3 @@ -// Copyright 2010 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 @@ -14,29 +12,27 @@ package org.apache.tapestry5.annotations; -import static java.lang.annotation.RetentionPolicy.RUNTIME; -import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.COMPONENT; -import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.MIXIN; -import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.PAGE; +import org.apache.tapestry5.internal.transform.HeartbeatDeferredWorker; +import org.apache.tapestry5.ioc.annotations.UseWith; +import org.apache.tapestry5.services.Heartbeat; import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.Target; -import org.apache.tapestry5.internal.transform.HeartbeatDeferredWorker; -import org.apache.tapestry5.ioc.annotations.UseWith; -import org.apache.tapestry5.services.Heartbeat; +import static java.lang.annotation.RetentionPolicy.RUNTIME; +import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*; /** * Marks a component method as deferred until the end of the {@link Heartbeat}. This * is only allowed on void methods that do not throw exceptions. The invocation is captured * and will execute at the end of the current Heartbeat. - * <p> + * * This annotation should be used with care, since deferring the invocation can change its semantics. For example, the * value stored in instance variables may change between the time the method is invoked and the time it eventually * executes. Likewise, runtime exceptions thrown by the method can not be caught by the invoking method. - * <p> + * * Annotated methods must return void, and not declare any checked exceptions. * * @since 5.2.0 http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Import.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Import.java b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Import.java index 133f735..2e50e3f 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Import.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Import.java @@ -1,5 +1,3 @@ -// Copyright 2010-2013 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 @@ -27,10 +25,10 @@ import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*; * be placed on a class, in which case importing will occur as part of the {@link SetupRender} render phase. * Alternately, the annotation maybe placed on any method (though typically it will be placed on a render phase * method) and the import operations will be associated of that method. - * <p/> + * * Use of this annotation is translated into invocations against the {@link org.apache.tapestry5.services.javascript.JavaScriptSupport} * environmental; all imports there will implicitly import the core stack. - * <p/> + * * Assets are localized during the {@link org.apache.tapestry5.runtime.PageLifecycleAdapter#containingPageDidLoad()} lifecycle * method. * @@ -75,7 +73,7 @@ public @interface Import * term is the library name (or "app" for the application), e.g. <code>flash/gordon</code> would map to the file * <code>META-INF/modules/flash/gordon.js</code>. Alternately a function name can be included, after a colon seperator. * e.g., <code>flash/gordon:setup</code>. - * <p/> + * * Module initializations specified this way may not have an parameters, so they are typically doing single-use * setup. * http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/annotations/OnEvent.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/OnEvent.java b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/OnEvent.java index 300862d..5419552 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/OnEvent.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/OnEvent.java @@ -1,5 +1,3 @@ -// Copyright 2006, 2007, 2008, 2009 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 @@ -16,32 +14,33 @@ package org.apache.tapestry5.annotations; import org.apache.tapestry5.EventConstants; import org.apache.tapestry5.ioc.annotations.UseWith; -import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*; import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; -import static java.lang.annotation.RetentionPolicy.RUNTIME; import java.lang.annotation.Target; +import static java.lang.annotation.RetentionPolicy.RUNTIME; +import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*; + /** * Marks a method as a handler for a client side event. The handler method will be invoked when a component triggers an * event. Filters on the type of event and on the originating component ensure that only the appropriate methods are * invoked. - * <p/> + * * Client events include a <em>context</em> of one or more values. These context values are included in the action URI. * The values are optionally supplied to the handler method as parameters. Automatic {@linkplain * org.apache.tapestry5.ValueEncoder conversion} from string to the type of the actual parameter occur. - * <p/> + * * Handlers may return a value. Returning a non-null value will abort the handling of the event, and will usually * control the response sent to the client web browser. The details are somewhat specific to the type of event and the * component involved. - * <p/> + * * If a handler is not found within the originating component (or no handler aborts the event handling), then handlers * within the containing component will be searched. This continues up the page hierarchy. In some cases, having no * handlers (or no aborting handlers) is considered acceptible; in others, it is an error. Again, this is defined by the * type of originating component, and the type of event. - * <p/> + * * <strong>If you fail to provide filters on either component or event type, then your method will be invoked for all * component events, possibly including events that bubble up from embedded sub-components. </strong> */ @@ -65,7 +64,7 @@ public @interface OnEvent * component. If an event from a component is not handled in the component's container, it is re-triggered inside * the component's grand-container and will appear to originate from the container. Thus events that escape a * component will appear to originate in the component's container, and so forth. - * <p/> + * * Matching by component id is case insensitive. */ String component() default "";