http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/AssetFactory.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/AssetFactory.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/AssetFactory.java index a06dc5a..faf8f35 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/AssetFactory.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/AssetFactory.java @@ -1,5 +1,3 @@ -// Copyright 2006, 2007, 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 @@ -19,16 +17,16 @@ import org.apache.tapestry5.ioc.Resource; /** * Used by {@link AssetSource} to create new {@link Asset}s as needed. - * <p/> + * * Starting in Tapestry 5.4, the built-in implementations of this interface (for context assets, and for classpath assets) * were changed so that when underlying resources changed, the client URLs for Assets are discarded; this is necessitated by two factors: - * <p/>1) the {@linkplain org.apache.tapestry5.Asset#toClientURL() client URL} + * 1) the {@linkplain org.apache.tapestry5.Asset#toClientURL() client URL} * for an Asset now includes a checksum based on the content of the underlying resource, so a change to resource content * (during development) results in a change to the URL. - * <p/>2) {@link org.apache.tapestry5.services.javascript.JavaScriptStack} (especially the {@link org.apache.tapestry5.services.javascript.ExtensibleJavaScriptStack} implementation) + * 2) {@link org.apache.tapestry5.services.javascript.JavaScriptStack} (especially the {@link org.apache.tapestry5.services.javascript.ExtensibleJavaScriptStack} implementation) * made no provision for rebuilding the Assets post-construction, and there is no backwards compatible way to * introduce this concept (and JavaScriptStacks are something many applications and third-party libraries make use of). - * <p/>So, starting in Tapestry 5.4, the implementations of {@link Asset} should be + * So, starting in Tapestry 5.4, the implementations of {@link Asset} should be * * @see org.apache.tapestry5.services.AssetSource */
http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/AssetPathConverter.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/AssetPathConverter.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/AssetPathConverter.java index 6fbb3e6..8040612 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/AssetPathConverter.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/AssetPathConverter.java @@ -1,5 +1,3 @@ -// Copyright 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 @@ -18,7 +16,7 @@ package org.apache.tapestry5.services; * Converts the {@linkplain org.apache.tapestry5.Asset#toClientURL() path (or URI) of an asset} into a new format. This * is the <em>hook</em> needed to make use of a <a href="http://en.wikipedia.org/wiki/Content_Delivery_Network";>Content * Delivery Network</a>. - * <p/> + * * The default implementation of this is <em>identity</em>, the URI is passed through unchanged. Using a contribution to * the {@link org.apache.tapestry5.ioc.services.ServiceOverride} service, you may override the default implementation. * http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/AssetSource.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/AssetSource.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/AssetSource.java index 111b2f9..df82262 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/AssetSource.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/AssetSource.java @@ -23,11 +23,11 @@ import java.util.Locale; /** * Used to find or create an {@link org.apache.tapestry5.Asset} with a given path. - * <p/> + * * Assets are defined with a domain, and the domain is indicated by a prefix. The two builtin domains are "context:" * (for files inside the web application context) and "classpath:" for files stored on the classpath (typically, inside * a JAR, such as a component library). Other domains can be defined via contributions to the AssetSource service. - * <p/> + * * Since 5.1.0.0, is is preferred that * {@link org.apache.tapestry5.services.AssetFactory#createAsset(org.apache.tapestry5.ioc.Resource)} return an instance * of {@link org.apache.tapestry5.Asset2}. @@ -40,7 +40,7 @@ public interface AssetSource * <em>or</em> it may have a prefix, such as "context:" or "classpath:", in which case it is treated as a complete * path within the indicated domain. The resulting Resource is then localized (to the provided Locale) and returned * as an Asset. - * <p/> + * * The AssetSource caches its results, so a single Asset instance may be shared among many different components. * * @param baseResource @@ -129,7 +129,7 @@ public interface AssetSource * This is the preferred location in 5.4, with compatibility for 5.3 that allows assets to be stored on the classpath * alongside Java classes and server-only resources such as templates and message catalogs. * - * <p/> + * * When resolving a resource in a component that is subclass, the point of injection is the class which contains * the injecting annotation (e.g., {@link org.apache.tapestry5.ioc.annotations.Inject} with {@link org.apache.tapestry5.annotations.Path}, * or {@link org.apache.tapestry5.annotations.Import}). In other words, the library name for the library containing the class, http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/BeanBlockOverrideSource.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/BeanBlockOverrideSource.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/BeanBlockOverrideSource.java index 887a611..1057b3d 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/BeanBlockOverrideSource.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/BeanBlockOverrideSource.java @@ -1,5 +1,3 @@ -// Copyright 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 @@ -31,7 +29,7 @@ public interface BeanBlockOverrideSource * * @param datatype logical name for the type of data to be displayed * @return the Block - * @throws null if no override is available + * @throws NullPointerException if no override is available */ Block getEditBlock(String datatype); @@ -40,7 +38,7 @@ public interface BeanBlockOverrideSource * * @param datatype logical name for the type of data to be displayed * @return the Block - * @throws null if no override is available + * @throws NullPointerException if no override is available */ Block getDisplayBlock(String datatype); http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/BeanBlockSource.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/BeanBlockSource.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/BeanBlockSource.java index 3de8743..b921456 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/BeanBlockSource.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/BeanBlockSource.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 @@ -22,10 +20,10 @@ import org.apache.tapestry5.ioc.annotations.UsesConfiguration; * org.apache.tapestry5.corelib.components.Grid} component), or to edit the properties of a bean (used by the {@link * org.apache.tapestry5.corelib.components.BeanEditForm} component). Contributions to this service (a configuration of * {@link BeanBlockContribution}s) define what properties may be editted. - * <p/> + * * Blocks are accessed in terms of a <strong>data type</strong> a string that identifies the type of data to be editted, * such as "string", "date", "boolean", etc. - * <p/> + * * Tapestry contributes a number of default data types and corresponding edit and display blocks. The {@link * org.apache.tapestry5.services.BeanBlockOverrideSource} service allows these to be overridden. * http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/BindingFactory.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/BindingFactory.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/BindingFactory.java index 13c27e8..e7f336a 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/BindingFactory.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/BindingFactory.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 @@ -26,7 +24,7 @@ public interface BindingFactory { /** * Creates a new binding instance. - * <p/> + * * The binding represents a connection between the container and the component (the component is usually the child * of the component, though in a few cases, it is the component itself). In most cases, the expression is evaluated * in terms of the resources of the <em>container</em> and the component is ignored. http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/BindingSource.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/BindingSource.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/BindingSource.java index 2bc6fd2..6049584 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/BindingSource.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/BindingSource.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 @@ -31,7 +29,7 @@ public interface BindingSource * BindingFactory}, which receives the description, the expression (after the prefix), and the location. If the * prefix doesn't exist, or if there's no prefix, then the factory for the default prefix (often "literal") is used * (and passed the full prefix). - * <p/> + * * The binding represents a connection between the container and the component (the component is usually the child * of the container, though in a few cases, it is the component itself). In most cases, the expression is evaluated * in terms of the resources of the <em>container</em> and the component is ignored. http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/ClasspathAssetAliasManager.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/ClasspathAssetAliasManager.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/ClasspathAssetAliasManager.java index b540780..ac777f4 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/ClasspathAssetAliasManager.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/ClasspathAssetAliasManager.java @@ -1,5 +1,3 @@ -// Copyright 2006, 2008, 2010, 2011, 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,19 +24,19 @@ import java.util.Map; * {@link org.apache.tapestry5.ioc.Resource} to a URL that can be accessed by the client. The asset path, within the * classpath, is converted into a shorter virtual path. The term "alias" here is generally referred to as * "virtual folder" elsewhere. - * <p/> + * * Service configuration is a map from folder aliases (short names) to complete paths. Names should not start or end end * with a slash. Generally, an alias should be a single name (not contain a slash). Paths should also not start or end * with a slash. An example mapping would be <code>mylib</code> to <code>com/example/mylib</code>. - * <p/> + * * As originally envisioned, this service would simply <em>optimize</em> classpath assets, allowing the URL path for * such assets to be shortened (and have a version number added, important for caching); thus the word "alias" makes * sense ... it was responsible for creating an "alias" URL shorter than the default "classpath" URL. - * <p/> + * * Starting in Tapestry 5.2, this changed; all classpath assets <strong>must</strong> be "aliased" to a shorter URL * path. Any URL that can not be shortened is now rejected. This simplifies creating new libraries, but also helps with * security concerns, as it limits which portions of the classpath can <em>ever</em> be exposed to the user agent. - * <p/> + * * Tapestry automatically contributes a number of mappings: for the application root package itself (as alias "app") and * for each library (via {@link ComponentClassResolver#getFolderToPackageMapping()}); * http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/ClientBehaviorSupport.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/ClientBehaviorSupport.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/ClientBehaviorSupport.java index eb78d4c..22e5bc0 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/ClientBehaviorSupport.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/ClientBehaviorSupport.java @@ -1,5 +1,3 @@ -// Copyright 2007, 2008, 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 @@ -21,7 +19,7 @@ import org.apache.tapestry5.corelib.data.InsertPosition; /** * Collects details about zone usage for efficient initialization of the client side objects. This has grown to include * the client-side behavior associated with {@link org.apache.tapestry5.corelib.components.FormFragment}s. - * <p/> + * * This interface is only kept for binary compatibility in Tapestry 5.4; the implementation no longer does anything but * throw exceptions and will be removed in 5.5. * @@ -48,7 +46,7 @@ public interface ClientBehaviorSupport /** * Sets the client-side onclick handler for an <a> element to perform an Ajax update of a zone. - * <p/> + * * Starting in Tapestry 5.4, this can be accomplished by adding a "data-update-zone" attribute * to the element. The attribute value may be {@code ^} or the id of the zone's client element. * @@ -95,7 +93,7 @@ public interface ClientBehaviorSupport /** * Adds a new client-side Tapestry.FormFragment object. FormFragment's are used to make parts of a client-side form * visible or invisible, which involves interactions with both the server-side and client-side validation. - * <p/> + * * <strong>This implementation has been removed in 5.4; it throws an {@link UnsupportedOperationException}.</strong> * * @param clientId http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/ClientDataEncoder.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/ClientDataEncoder.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/ClientDataEncoder.java index 89ac933..9774989 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/ClientDataEncoder.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/ClientDataEncoder.java @@ -1,5 +1,3 @@ -// Copyright 2009, 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.io.ObjectInputStream; * A service used when a component or service needs to encode some amount of data on the client as a string. The string * may be a query parameter, hidden form field, or a portion of a URL. The default implementation converts the object * output stream into a Base64 string. - * <p/> + * * Starting in release 5.3.6, the encoded data incorporates an HMAC (hash based message authentication code) signature, * as a prefix. HMAC requires a secret key, configured using the * {@link org.apache.tapestry5.SymbolConstants#HMAC_PASSPHRASE} symbol. http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentClassResolver.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentClassResolver.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentClassResolver.java index 15fedf7..de77c43 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentClassResolver.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentClassResolver.java @@ -1,5 +1,3 @@ -// Copyright 2006, 2007, 2008, 2009, 2010, 2011, 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 @@ -28,14 +26,14 @@ import java.util.Map; * Resolves page names and component types to fully qualified class names. Pages and components may be provided by the * application or inside a <em>mapped package</em>. Page names often appear inside URLs, and component types often * appear in component templates (when specifying the type of an embedded component). - * <p/> + * * The service is configured using a collection of {@link LibraryMapping}s. Each mapping maps a prefix, such as "core" * to a root package name, such as "org.apache.tapestry5.corelib". The root package is expected to have sub-packages: * "pages", "components", "mixins" and "base" ("base" is for base classes). - * <p/> + * * The resolver performs a search of the classpath (via {@link ClassNameLocator}), to build up a set of case-insensitive * maps from logical page name, component type, or mixin type to fully qualified class name. - * <p/> + * * Certain ambiguities occur if mapped packages overlap, either in terms of the the prefixes or the package names. Keep * things clearly separate to avoid lookup problems. */ @@ -130,7 +128,7 @@ public interface ComponentClassResolver /** * A mapping from virtual folder name to a package name (used for converting classpath {@link Asset}s * to client URLs). This is derived from the contributed {@link LibraryMapping}s. - * <p/> + * * It is allowed to contribute multiple root packages as a single folder name. In this case, the best common package * name is used. For example, if both <code>com.example.main</code> and <code>com.example.extras</code> is mapped to * folder "example", then the package mapping for "example" will be <code>com.example</code>. http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventLinkEncoder.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventLinkEncoder.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventLinkEncoder.java index 7113e67..c2c491e 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventLinkEncoder.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventLinkEncoder.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 @@ -42,7 +40,7 @@ public interface ComponentEventLinkEncoder /** * Creates a link that encapsulates a component event request, including <em>{@link * org.apache.tapestry5.services.PersistentLocale} (if set)</em>. - * <p> + * * Forms: * <ul> * <li>/context/pagename:eventname -- event on the page, no action context</li> @@ -53,15 +51,15 @@ public interface ComponentEventLinkEncoder * <li>/context/pagename.bar.baz:eventname/foo/gnu -- event on component bar.baz within the page with action context * "foo" , "gnu"</li> * </ul> - * <p/> + * * The persistent locale may be placed in between the context name and the page name, i.e., "/context/fr/SomePage". - * <p/> + * * In many cases the context name is blank, so the path begins with a "/" and then the locale name or page name. - * <p/> + * * The page name portion may itself consist of a series of folder names, i.e., "admin/user/create". The context * portion isn't the concern of this code, since {@link org.apache.tapestry5.services.Request#getPath()} will * already have stripped that off. We can act as if the context is always "/" (the path always starts with a slash). - * <p/> + * * Passes the resulting Link through the {@link ComponentEventLinkTransformer} chain of command, returning the * result. * http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventRequestHandler.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventRequestHandler.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventRequestHandler.java index 9ae643d..c24efe4 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventRequestHandler.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventRequestHandler.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 @@ -22,11 +20,11 @@ import java.io.IOException; * Handler interface for component event requests. Component event requests <em>do things</em> such as process a form * submission or otherwise change state. In the majority of cases, after the component event, a redirect response is * sent to the client which, in turn, causes a page render. - * <p/> + * * The ComponentEventRequestHandler service is a pipeline, allowing extensibility via contributed {@linkplain * org.apache.tapestry5.services.ComponentEventRequestFilter filters}. It may be distinguished by the @{@link * org.apache.tapestry5.services.Traditional} marker annotation. - * <p/> + * * A second service, AjaxComponentEventRequestHandler is also a pipeline and may be distinguished by the @{@link * org.apache.tapestry5.services.Ajax} marker annotation. * http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventResultProcessor.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventResultProcessor.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventResultProcessor.java index c43b2d9..5505ff9 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventResultProcessor.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventResultProcessor.java @@ -1,5 +1,3 @@ -// Copyright 200-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 @@ -20,7 +18,7 @@ import java.io.IOException; /** * Responsible for handling the return value provided by a component event handler method. - * <p/> + * * There are two services built into Tapestry that implement this interface: ComponentEventResultProcessor (used for * ordinary page-oriented requests, and distinguished by the @{@link org.apache.tapestry5.services.Traditional} * and/or @{@link org.apache.tapestry5.ioc.annotations.Primary} marker annotations) and @@ -35,7 +33,7 @@ public interface ComponentEventResultProcessor<T> { /** * For a given, non-null return value from a component event method, construct and send a response. - * <p/> + * * Starting in release 5.4, it is recommended that for any response that involves Tapestry pages or components, * the implementation should create an {@link org.apache.tapestry5.ioc.IOOperation} to do the rendering, and * add the operation to the {@link org.apache.tapestry5.services.Request} as attribute http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentOverride.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentOverride.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentOverride.java index cbbbf98..4e650e6 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentOverride.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentOverride.java @@ -23,7 +23,7 @@ import org.apache.tapestry5.ioc.annotations.UsesMappedConfiguration; * replaced, the value is the replacement. * * @since 5.4 - * @see org.apache.tapestry5.services.ComponentClassResolver. + * @see org.apache.tapestry5.services.ComponentClassResolver */ @UsesMappedConfiguration(key = Class.class, value = Class.class) public interface ComponentOverride http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/Environment.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/Environment.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/Environment.java index be00050..6672458 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/Environment.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/Environment.java @@ -1,5 +1,3 @@ -// Copyright 2006-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 @@ -19,7 +17,7 @@ import java.util.NoSuchElementException; /** * Provides access to environment objects, which are almost always provided to enclosed components by enclosing * components. Environmental services are a form of very late binding. - * <p/> + * * The Environment acts like a collection of stacks. Each stack contains environmental objects of a given type. Most * often, a stack has zero or one elements, but on occasion, a particular component will push an override onto the stack * for the benefit of the components it encloses. http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/ExceptionReporter.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/ExceptionReporter.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/ExceptionReporter.java index 070aa84..7fe2261 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/ExceptionReporter.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/ExceptionReporter.java @@ -14,13 +14,13 @@ package org.apache.tapestry5.services; /** * Interface implemented by a page used for reporting exceptions. - * <p/> + * * Alternately, implemented by services to report request handling exceptions. This is invoked <em>before</em> the exception report page is rendered. * The default implementation converts the exception into a well formatted text file, with content similar to the default * {@link org.apache.tapestry5.corelib.pages.ExceptionReport} page, and stores this file on the file system. - * <p/> + * * Exception report files are stored beneath a root directory, with intermediate folders for the day (e.g., "2014-06-02"), hour, and minute. - * <p/> + * * Directories are created as necessary; however, there is nothing in place to delete these exceptions reports. * * @see org.apache.tapestry5.SymbolConstants#EXCEPTION_REPORTS_DIR http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/FieldValidatorSource.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/FieldValidatorSource.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/FieldValidatorSource.java index 4ea3ede..ffd4582 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/FieldValidatorSource.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/FieldValidatorSource.java @@ -1,5 +1,3 @@ -// Copyright 2006, 2008, 2011 The Apache Software Foundation -// // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at @@ -33,7 +31,7 @@ public interface FieldValidatorSource /** * Creates the validator. The error message associated with the field validator usually comes from the * global message catalog (using the validator's {@link Validator#getMessageKey() message key}). However, - * if the container component of the field defines a message key <code><i>id</i>-<i>validator</i> (where id is the simple + * if the container component of the field defines a message key <code><i>id</i>-<i>validator</i></code> (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. * @@ -50,7 +48,7 @@ public interface FieldValidatorSource /** * Full featured version of {@link #createValidator(Field, String, String)} used in situations 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 + * of the field is not necessarily 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 @@ -76,7 +74,7 @@ public interface FieldValidatorSource /** * 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). + * optional constraint value (separated by an equals sign). * * @param field * @param specification http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/Heartbeat.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/Heartbeat.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/Heartbeat.java index f3db6a1..cb7046a 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/Heartbeat.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/Heartbeat.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 @@ -21,7 +19,7 @@ import org.apache.tapestry5.annotations.HeartbeatDeferred; * component may add a command to be executed "{@linkplain #end() at the end of the heartbeat}". The classic example of * this is a Label and the field it labels; since we don't know which order the two will render, we can't tell if the * field's id is correct until after both have rendered. - * <p/> + * * The Heartbeat is injected into components via the {@link org.apache.tapestry5.annotations.Environmental} annotation. */ public interface Heartbeat http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/HiddenFieldLocationRules.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/HiddenFieldLocationRules.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/HiddenFieldLocationRules.java index 092d016..30692a2 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/HiddenFieldLocationRules.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/HiddenFieldLocationRules.java @@ -1,5 +1,3 @@ -// Copyright 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,7 +17,7 @@ import org.apache.tapestry5.ioc.annotations.UsesMappedConfiguration; /** * Provides some assistance in determining <em>where</em> to place a hidden field based on standard (X)HTML elements. - * <p/> + * * The service works based on a mapped service contribution; keys are the element names, values area {@link * org.apache.tapestry5.services.RelativeElementPosition}. */ http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/LibraryMapping.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/LibraryMapping.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/LibraryMapping.java index f1cfc5f..6794bdc 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/LibraryMapping.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/LibraryMapping.java @@ -1,5 +1,3 @@ -// Copyright 2006, 2010, 2011, 2012, 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 @@ -18,7 +16,7 @@ import org.apache.tapestry5.ioc.internal.util.InternalUtils; /** * Used to configure the {@link ComponentClassResolver}, to allow it to map library names to library root packages (the * application namespace is a special case of this). In each case, a prefix on the path is mapped to a package. - * <p/> + * * The root package name should have a number of sub-packages: * <dl> * <dt>pages</dt> @@ -30,7 +28,7 @@ import org.apache.tapestry5.ioc.internal.util.InternalUtils; * <dt>base</dt> * <dd>contains base classes</dd> * </dl> - * <p> + * * @see ComponentLibraryInfo */ public final class LibraryMapping @@ -40,13 +38,13 @@ public final class LibraryMapping /** * Identifies the root package of a library. The application has uses the library name "" (the empty string). * The special library "core" is all the built-in components. - * <p/> + * * The library name is sometimes referred to as the "path prefix" or the "virtual folder name". This is for historical * reasons, as the concept of a library and how it was defined and managed evolved from release to release. - * <p/> + * * The library name should be alpha numeric, and directly encodable into a URL. It may contain slashes (though this is not * used often), but may not start or end with one. - * <p/> + * * Note that it <em>is</em> allowed to contribute multiple LibraryMappings with the library name to the * {@link ComponentClassResolver}, and the results are merged: the single library will have multiple root packages. * Be careful that <em>none</em> of the root packages overlap! @@ -75,7 +73,7 @@ public final class LibraryMapping * Returns the library name; the method is oddly named for historical reasons. The library name is sometimes * referred to as the virtual folder name. * - * @deprecated In 5.4, use {@link #getLibraryName()} instead. + * @deprecated In 5.4, use {@link #libraryName} instead. */ public String getPathPrefix() { http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/LocalizationSetter.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/LocalizationSetter.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/LocalizationSetter.java index 5cee327..0555cd7 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/LocalizationSetter.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/LocalizationSetter.java @@ -1,5 +1,3 @@ -// Copyright 2006, 2009, 2010, 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 @@ -14,16 +12,16 @@ package org.apache.tapestry5.services; -import java.util.List; -import java.util.Locale; - import org.apache.tapestry5.SelectModel; import org.apache.tapestry5.ioc.annotations.IncompatibleChange; +import java.util.List; +import java.util.Locale; + /** * Sets the thread's locale given a desired locale. Note that the desired locale is just a hint. It will try to honor it * but there is no guarantee that it will be used as is. - * <p/> + * * Localization is controlled by the {@link org.apache.tapestry5.SymbolConstants#SUPPORTED_LOCALES} symbol. */ public interface LocalizationSetter @@ -34,7 +32,7 @@ public interface LocalizationSetter * to the provided locale, if supported, or to the default locale). If the locale name is supported, it will also * set the {@link org.apache.tapestry5.services.PersistentLocale} (which may affect how page and event links are * generated, to persist the selected locale across requests). - * <p/> + * * Note that locale names <strong>are</strong> case sensitive. * * @param localeName http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/MarkupRenderer.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/MarkupRenderer.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/MarkupRenderer.java index b58a26e..5b91893 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/MarkupRenderer.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/MarkupRenderer.java @@ -1,5 +1,3 @@ -// Copyright 2007, 2008, 2011 The Apache Software Foundation -// // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at @@ -20,7 +18,7 @@ import org.apache.tapestry5.ioc.annotations.UsesOrderedConfiguration; /** * An object which will perform rendering of a page (or portion of a page). This interface exists to be filtered via * {@link org.apache.tapestry5.services.MarkupRendererFilter}. - * <p/> + * * The MarkupRenderer service takes an ordered configuration of {@link org.apache.tapestry5.services.MarkupRendererFilter}s, * which are used for ordinary page rendering (as opposed to {@linkplain org.apache.tapestry5.services.PartialMarkupRenderer * partial page rendering} for Ajax requests). The MarkupRenderer service may be selected using the http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/MetaDataLocator.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/MetaDataLocator.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/MetaDataLocator.java index 3a57b1a..f08e98d 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/MetaDataLocator.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/MetaDataLocator.java @@ -1,5 +1,3 @@ -// Copyright 2007, 2008, 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 org.apache.tapestry5.ioc.annotations.UsesMappedConfiguration; * containment hierarchy (to the component's container, and the container's container, and so on). If <em>that</em> * proves unfruitful, a system of defaults is provided by configuration and matched against the containing page's * logical name. - * <p/> + * * Finally, if no metadata is available, then {@link org.apache.tapestry5.ioc.services.SymbolSource#valueForSymbol(String)} * is used to obtain a value. Generally speaking, if you are going to use this service to look up meta data, your should * also make a contribution to the FactoryDefaults service; otherwise, you risk a runtime exception if a meta-data key http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/ObjectRenderer.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/ObjectRenderer.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/ObjectRenderer.java index ad40d82..711970d 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/ObjectRenderer.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/ObjectRenderer.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 @@ -20,7 +18,7 @@ import org.apache.tapestry5.ioc.annotations.UsesMappedConfiguration; /** * A strategy interface used for converting an object into markup that describes that object. This is primarily used in * terms of an {@link org.apache.tapestry5.services.ExceptionReporter} page. - * <p/> + * * The ObjectRenderer service (distinguished by the @{@link org.apache.tapestry5.ioc.annotations.Primary} marker * annotation) uses {@linkplain org.apache.tapestry5.ioc.services.StrategyBuilder type-based matching} to find a * specific ObjectRenderer for any given type. http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/PageRenderRequestHandler.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/PageRenderRequestHandler.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/PageRenderRequestHandler.java index 6ca2e41..7407170 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/PageRenderRequestHandler.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/PageRenderRequestHandler.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 @@ -20,7 +18,7 @@ import java.io.IOException; /** * Handles a invocation related to rendering out a pages complete content. - * <p/> + * * The PageRenderRequestHandler service is an extensible {@linkplain org.apache.tapestry5.ioc.services.PipelineBuilder * pipeline}. */ http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/PartialMarkupRenderer.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/PartialMarkupRenderer.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/PartialMarkupRenderer.java index 3be19da..e850815 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/PartialMarkupRenderer.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/PartialMarkupRenderer.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 @@ -22,8 +20,8 @@ import org.apache.tapestry5.json.JSONObject; * Defines an Ajax-oriented partial page render, wherein a render of a portion of a page occurs, and the content is * stored into a key ("content") of a {@link org.apache.tapestry5.json.JSONObject}, which is sent to the client side as * the final response. Client-side JavaScript receives this reply and uses it to update a portion of the page. - * <p/> - * <p/> + * + * * The PartialMarkupRenderer service takes an ordered configuration of {@link PartialMarkupRendererFilter}s. It can be * selected using the {@link org.apache.tapestry5.ioc.annotations.Primary} marker annotation. */ http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/PartialTemplateRenderer.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/PartialTemplateRenderer.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/PartialTemplateRenderer.java index e4a595a..dd179a9 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/PartialTemplateRenderer.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/PartialTemplateRenderer.java @@ -1,5 +1,3 @@ -// Copyright 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 @@ -16,38 +14,36 @@ package org.apache.tapestry5.services; import org.apache.tapestry5.Block; import org.apache.tapestry5.alerts.Alert; import org.apache.tapestry5.dom.Document; -import org.apache.tapestry5.dom.Element; import org.apache.tapestry5.ioc.services.TypeCoercer; import org.apache.tapestry5.runtime.RenderCommand; /** - * <p> - * Service that provides methods that render {@link Block}s (<code><t:block>>)</code>, + * + * Service that provides methods that render {@link Block}s ({@code <t:block>} in the template), * component instances and {@link RenderCommand}s to a {@link String} or * {@link Document org.apache.tapestry5.dom.Document} in a programatic way. - * </p> - * <p> + * + * * This service was created for situations in which a page or component needs to generate some markup * that wouldn't be rendered normally, but for external use, such as e-mails, returning * HTML for AJAX requests or passing HTML instead of plain string for an {@link Alert}. - * </p> - * <p> + * + * * The name of this interface comes from <a href="https://issues.apache.org/jira/browse/TAP5-938";>TAP5-938</a>: * <em>Expose ability to render a portion of a page (a Block, Component, etc.) without using internal services</em>. - * </p> + * * @since 5.4 */ public interface PartialTemplateRenderer { - /** - * <p> + * * Renders an object, probably a {@link Block} or component instance, to a string. * This method supposes any kind of initialization needed * was already done. CSS and JavaScript inclusions or importings are ignored. * The object must implement {@link RenderCommand} or being able to be coerced to it * by {@link TypeCoercer}. - * <p> + * * @param object an object, probably a {@link Block} or component instance or {@link RenderCommand}. * @throws IllegalArgumentException if the object isn't a {@link RenderCommand} and cannot be coerced to it by {@link TypeCoercer}. */ @@ -58,7 +54,7 @@ public interface PartialTemplateRenderer * This method supposes any kind of initialization needed * was already done. CSS and JavaScript inclusions or importings are ignored. * - * @param renderCommand a {@link RenderCommand}. + * @param object to render, a {@link RenderCommand}, or {@linkplain TypeCoercer coercible} to one * @return a {@link Document}. */ Document renderAsDocument(Object object); http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/Request.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/Request.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/Request.java index e2f7ee2..7166264 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/Request.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/Request.java @@ -1,5 +1,3 @@ -// Copyright 2006, 2007, 2008, 2011, 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 @@ -20,7 +18,7 @@ import java.util.Locale; /** * Generic version of {@link javax.servlet.http.HttpServletRequest}, used to encapsulate the Servlet API version, and to * help bridge the differences between Servlet API and Porlet API. - * <p/> + * * The Request service is a {@linkplain org.apache.tapestry5.ioc.services.PropertyShadowBuilder shadow} of the current * thread's request. */ @@ -81,10 +79,10 @@ public interface Request * 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/> + * * The date is returned as the number of milliseconds since January 1, 1970 GMT. The header name is case * insensitive. - * <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>. * http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/RequestExceptionHandler.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/RequestExceptionHandler.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/RequestExceptionHandler.java index 3d63bf8..df4fe79 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/RequestExceptionHandler.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/RequestExceptionHandler.java @@ -1,5 +1,3 @@ -// Copyright 2006, 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 @@ -23,10 +21,10 @@ import java.io.IOException; public interface RequestExceptionHandler { /** - * Reponsible for handling the error <em>in some way</em> and providing <em>some response</em> to the client. A + * Responsible 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. - * <p/> - * <p/> + * + * * The handler is also responsible for setting the response status and the X-Tapestry-ErrorMessage response header. * These are very important in Ajax requests to allow the client-side logic to detect the error and present it to * the user. http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/ResourceDigestGenerator.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/ResourceDigestGenerator.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/ResourceDigestGenerator.java index c1f1477..ed28b38 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/ResourceDigestGenerator.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/ResourceDigestGenerator.java @@ -1,5 +1,3 @@ -// Copyright 2006, 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 @@ -21,7 +19,7 @@ import java.net.URL; /** * Responsible for determining which classpath resources require checksums, and for generating checksums for such * resources. - * <p/> + * * The service's configuration identifies which file extensions will be secured using an checksum. The default list * (in Tapestry 5.3) is * "class" and "tml". Note that in 5.4, there are no longer any contributions to this service by Tapestry, and @@ -39,7 +37,7 @@ public interface ResourceDigestGenerator /** * Examines the path (typically, the file name extension at the end of the path) to determine if a checksum is * required for the path. The path is {@link org.apache.tapestry5.ioc.Resource} style, without a leading slash. - * <p/> + * * As of Tapestry 5.4, simply returns false. */ boolean requiresDigest(String path); @@ -49,7 +47,7 @@ public interface ResourceDigestGenerator * 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. - * <p/> + * * As of Tapestry 5.4, simply returns null. * * @param url http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/Response.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/Response.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/Response.java index 1269937..7b2795c 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/Response.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/Response.java @@ -1,5 +1,3 @@ -// Copyright 2006, 2007, 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 @@ -23,8 +21,8 @@ import java.io.PrintWriter; /** * API agnostic wrapper for generating a response. Bridges the gaps between the Servlet API and the Portlet API. - * <p/> - * <p/> + * + * * The Response service is a {@linkplain org.apache.tapestry5.ioc.services.PropertyShadowBuilder shadow} of the current * thread's response object. */ @@ -81,7 +79,7 @@ public interface Response * "text/html", leaving cookies and other headers 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/> + * * 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. * http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/SessionPersistedObjectAnalyzer.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/SessionPersistedObjectAnalyzer.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/SessionPersistedObjectAnalyzer.java index 950fbeb..25c7ee0 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/SessionPersistedObjectAnalyzer.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/SessionPersistedObjectAnalyzer.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 @@ -18,11 +16,11 @@ import org.apache.tapestry5.ioc.annotations.UsesMappedConfiguration; /** * Analyzes a session-persisted object, specifically to see if it is dirty or not. - * <p/> + * * This service is provided to support applications which store mutable session attributes where the * session is replicated to a slower medium (e.g. RDMBS, Cluster, etc) this can help alleviate excessive writes * to the session store while ensuring changes are propagated. - * <p/> + * * The service implementation uses a mapped configuration to form a * {@linkplain org.apache.tapestry5.ioc.services.StrategyBuilder strategy} based on object type. The service may be * injected using the {@link org.apache.tapestry5.ioc.annotations.Primary} marker annotation. @@ -36,7 +34,7 @@ public interface SessionPersistedObjectAnalyzer<T> { /** * Atomically check and reset the dirty state of the session persisted object. - * <p/> + * * The implementer should take consideration for the fact that session attributes are accessed concurrently. A * naive check/set algorithm may allow changes to go un-noticed. * http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/StreamPageContent.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/StreamPageContent.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/StreamPageContent.java index a7acebb..1f54e18 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/StreamPageContent.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/StreamPageContent.java @@ -1,5 +1,3 @@ -// Copyright 2010, 2011 The Apache Software Foundation -// // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at @@ -19,11 +17,11 @@ package org.apache.tapestry5.services; * of a particular page without causing a redirect to that page; the rendering takes place as part * of the original component event request, thus forming the opposite of Tapestry's normal * redirect-after-event behavior. - * <p> + * * The page will be activated using the provided page activation context (or an empty page activation * context). Starting with 5.3, the page activation step can be bypassed. Rendering occurs using * the standard {@link PageRenderRequestHandler} pipeline. - * </p> + * * * @since 5.2.0 */ http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/TransformConstants.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/TransformConstants.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/TransformConstants.java index 3cdfa52..7d61ecf 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/TransformConstants.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/TransformConstants.java @@ -1,5 +1,3 @@ -// Copyright 2006, 2007, 2008, 2009, 2011 The Apache Software Foundation -// // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at @@ -28,7 +26,7 @@ import java.lang.reflect.Modifier; /** * Constants used by implementations {@link ComponentClassTransformWorker2}. - * <p/> + * * Note: render phase methods on transformed components will not be invoked <em>unless</em> * {@linkplain org.apache.tapestry5.model.MutableComponentModel#addRenderPhase(Class) the component model is updated to * identify the use of the corresponding render phase}. This represents an optimization introduced in Tapestry 5.1. http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/TranslatorAlternatesSource.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/TranslatorAlternatesSource.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/TranslatorAlternatesSource.java index 0aec87b..d0bbd9a 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/TranslatorAlternatesSource.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/TranslatorAlternatesSource.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,16 +12,16 @@ package org.apache.tapestry5.services; -import java.util.Map; - import org.apache.tapestry5.Translator; import org.apache.tapestry5.ioc.annotations.UsesMappedConfiguration; +import java.util.Map; + /** * This service is used by {@link TranslatorSource} to specify {@link Translator} <em>alternates</em>: translators that * are used when specified explicitly by name. These translators may overlap the standard translators * by type (thus requiring a separate configuration). - * <p> + * * Translators contributed to this configuration must have names that do not overlap the standard translators. Further, * the contribution key must match the {@linkplain Translator#getName() translator name}. * http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/TranslatorSource.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/TranslatorSource.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/TranslatorSource.java index d53f1f6..5890b90 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/TranslatorSource.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/TranslatorSource.java @@ -1,5 +1,3 @@ -// Copyright 2007, 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 @@ -22,13 +20,13 @@ import org.apache.tapestry5.ioc.util.StrategyRegistry; * A source for {@link org.apache.tapestry5.Translator}s, either by name or by property type. The source knows * about two sets of translators: the <em>standard</em> translators contributed directly to the service * and the <em>alternate</em> translators, contributed to the {@link TranslatorAlternatesSource} service. - * <p/> + * * Each contributed translator must have a unique {@linkplain org.apache.tapestry5.Translator#getName() name}. - * <p> + * * Generally, Translators are matched by type (i.e., the type matching a particular property that will be read or * updated). Contributions to this service use a {@link StrategyRegistry} to match by type. Translators can also be * selected by name. The {@link TranslatorAlternatesSource} service configuration is often used for this purpose. - * <p> + * * The contribution key must match the {@linkplain Translator#getType() translator type}. */ @UsesMappedConfiguration(key=Class.class, value=Translator.class) http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/ajax/AjaxResponseRenderer.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/ajax/AjaxResponseRenderer.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/ajax/AjaxResponseRenderer.java index aae2b9f..7013291 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/ajax/AjaxResponseRenderer.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/ajax/AjaxResponseRenderer.java @@ -19,7 +19,7 @@ import org.apache.tapestry5.services.PartialMarkupRendererFilter; * Manages the rendering of a partial page render as part of an Ajax response. This replaces * the {@link org.apache.tapestry5.ajax.MultiZoneUpdate} introduced in Tapestry 5.1. Much of the API is used to * queue behaviors that take effect when {@linkplain org.apache.tapestry5.services.PartialMarkupRenderer partial markup rendering takes place}. - * <p/> + * * The implementation of this class provides {@link org.apache.tapestry5.services.PartialMarkupRendererFilter} to * the {@link org.apache.tapestry5.internal.services.PageRenderQueue}. * http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/AssetRequestHandler.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/AssetRequestHandler.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/AssetRequestHandler.java index e8c2e99..54d8164 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/AssetRequestHandler.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/AssetRequestHandler.java @@ -24,7 +24,7 @@ import java.io.IOException; * Handler for asset requests, which expose some kind of {@link Asset} to * the user agent (i.e., the client web browser). When contributed to the {@link AssetDispatcher} service, * the contributed key is a handler id (such as "meta/core"). - * <p/> + * * An example request path might be <code>/assets/meta/core/dd8d73ac51dbab28caaec4865d302bf2/deselect.png</code>. * The handler id would be * <code>meta/core</code>, the {@linkplain AssetChecksumGenerator checksum of the resource content} is the @@ -43,11 +43,11 @@ public interface AssetRequestHandler * (via {@link Response#getOutputStream(String)}) or an error response * (via {@link Response#sendError(int, String)}). It is the handler's responsibility to allow * for client-side caching (possibly sending an {@link HttpServletResponse#SC_NOT_MODIFIED} response). - * <p/> + * * The handler should return true if it provided a response. If the handler returns false, this indicates that the * extra path did not identify a known asset (virtual or otherwise) and the AssetDispatcher service should send a * {@link HttpServletResponse#SC_NOT_FOUND} response. - * <p/> + * * Starting in Tapestry 5.4, the handler is informed by the {@link org.apache.tapestry5.services.AssetRequestDispatcher} * whether or not the content should be compressed (this is determined based on information in the URL). * http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/CompressionAnalyzer.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/CompressionAnalyzer.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/CompressionAnalyzer.java index 4f060ff..a61e56c 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/CompressionAnalyzer.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/CompressionAnalyzer.java @@ -17,9 +17,9 @@ import org.apache.tapestry5.ioc.annotations.UsesMappedConfiguration; /** * Identifies which content types are compressable. In general, content types are assumed to be compressable. The * configuration of the service identifies exceptions, which are usually image file formats. - * <p/> + * * The configuration maps content types to boolean values (true for compressable). - * <p/> + * * Since 5.4, the contributed values may also be a wild-card such as "image/*" (that is, the subtype * may be a '*' to match any content type with the same top-level type). * http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/ContentTypeAnalyzer.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/ContentTypeAnalyzer.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/ContentTypeAnalyzer.java index ec2ea9e..1a7c045 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/ContentTypeAnalyzer.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/ContentTypeAnalyzer.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 @@ -22,7 +20,7 @@ import org.apache.tapestry5.services.Context; * Used to determine the MIME content type for a resource. The service configuration is the first step, * followed by {@link Context#getMimeType(String)}, and then (finally) "application/octet-stream" * as a stop-gap. - * <p> + * * The service configuration maps the file extension (e.g., "png") to its corresponding MIME type (e.g., "image/png"); */ @UsesMappedConfiguration(String.class) http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/ResourceMinimizer.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/ResourceMinimizer.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/ResourceMinimizer.java index 23a71a4..dc1cd11 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/ResourceMinimizer.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/ResourceMinimizer.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.services.assets; -import java.io.IOException; - import org.apache.tapestry5.ioc.annotations.Primary; import org.apache.tapestry5.ioc.annotations.UsesMappedConfiguration; +import java.io.IOException; + /** * Certain kinds of resources can be minimized: this primarily refers to JavaScript and CSS, both of which contain * whitespace, comments and other features that can be reduced. - * <p> + * * The service configuration maps a MIME content type (e.g., "text/javascript") to an appropriate implementation of this * interface. The master service has the @{@link Primary} marker interface. * http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/package-info.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/package-info.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/package-info.java index 651e184..c330180 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/package-info.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/package-info.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 @@ -13,6 +11,6 @@ // limitations under the License. /** - * Various services for assets (e.g., images, JavaScript & CSS files) + * Various services for assets (e.g., images, JavaScript and CSS files) */ package org.apache.tapestry5.services.assets; http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/compatibility/Compatibility.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/compatibility/Compatibility.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/compatibility/Compatibility.java index 6825282..6ab45cb 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/compatibility/Compatibility.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/compatibility/Compatibility.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 @@ -19,7 +17,7 @@ import org.apache.tapestry5.ioc.annotations.UsesMappedConfiguration; /** * Used globally to track what compatibility traits are enabled. By default, in Tapestry 5.4, * all traits are enabled unless explicitly disabled. This behavior may change in Tapestry 5.5. - * <p/> + * * The configuration allows traits to be explicitly enabled or disabled. * * @since 5.4 http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/compatibility/Trait.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/compatibility/Trait.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/compatibility/Trait.java index 00023fb..752da85 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/compatibility/Trait.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/compatibility/Trait.java @@ -1,5 +1,3 @@ -// Copyright 2012, 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 @@ -14,6 +12,8 @@ package org.apache.tapestry5.services.compatibility; +import org.apache.tapestry5.SymbolConstants; + /** * Defines different traits that may be enabled or disabled. This was introduced in Tapestry 5.4 to allow certain * features that exist in Tapestry 5.3 to be optionally enabled for compatibility. @@ -24,13 +24,13 @@ public enum Trait * Indicates that the Scriptaculous JavaScript libraries should be included. Tapestry 5.3 includes options for performing * some kinds of animations when certain elements were updated or removed; that is no longer present in Tapestry 5.4 * and Scriptaculous is not used. This trait is only used if the - * {@linkplain org.apache.tapestry5.SymbolConstants#JAVASCRIPT_INFRASTRUCTURE_PROVIDER JavaScript infrastructure provider} + * {@linkplain SymbolConstants#JAVASCRIPT_INFRASTRUCTURE_PROVIDER JavaScript infrastructure provider} * is set to "prototype". */ SCRIPTACULOUS, /** - * Support for Tapestry 5.3 style initializers (the client-side {@code T5.initializers} namespace).</code> + * Support for Tapestry 5.3 style initializers (the client-side {@code T5.initializers} namespace). */ - INITIALIZERS; + INITIALIZERS } http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/AMDWrapper.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/AMDWrapper.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/AMDWrapper.java index 3783a65..ee98504 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/AMDWrapper.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/AMDWrapper.java @@ -1,5 +1,3 @@ -// Copyright 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,6 +12,14 @@ package org.apache.tapestry5.services.javascript; +import org.apache.tapestry5.func.F; +import org.apache.tapestry5.func.Flow; +import org.apache.tapestry5.func.Mapper; +import org.apache.tapestry5.func.Predicate; +import org.apache.tapestry5.internal.util.VirtualResource; +import org.apache.tapestry5.ioc.Resource; +import org.apache.tapestry5.ioc.internal.util.InternalUtils; + import java.io.ByteArrayInputStream; import java.io.IOException; import java.io.InputStream; @@ -24,25 +30,17 @@ import java.util.Map; import java.util.Map.Entry; import java.util.Vector; -import org.apache.tapestry5.func.F; -import org.apache.tapestry5.func.Flow; -import org.apache.tapestry5.func.Mapper; -import org.apache.tapestry5.func.Predicate; -import org.apache.tapestry5.internal.util.VirtualResource; -import org.apache.tapestry5.ioc.Resource; -import org.apache.tapestry5.ioc.internal.util.InternalUtils; - /** * Used to wrap plain JavaScript libraries as AMD modules. The underlying * resource is transformed before it is sent to the client. - * <p> + * * This is an alternative to configuring RequireJS module shims for the * libraries. As opposed to shimmed libraries, the modules created using the * AMDWrapper can be added to JavaScript stacks. - * <p> + * * If the library depends on global variables, these can be added as module * dependencies. For a library that expects jQuery to be available as - * <code>$<code>, the wrapper should be setup calling <code>require("jQuery", "$")<code> + * <code>$</code>, the wrapper should be setup calling <code>require("jQuery", "$")</code> * on the respective wrapper. * * @since 5.4 http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/ExtensibleJavaScriptStack.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/ExtensibleJavaScriptStack.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/ExtensibleJavaScriptStack.java index 1e1afce..8fa030f 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/ExtensibleJavaScriptStack.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/ExtensibleJavaScriptStack.java @@ -32,7 +32,7 @@ import java.util.List; * {@link ServiceBinder#bind(Class, Class)} and {@link ServiceBindingOptions#withMarker(Class...)} to construct the * service, then use the marker annotation to inject the service when contributing the service into to the * {@link JavaScriptStackSource}. - * <p/> + * * A limitation of this implementation is that the contributed assets are not localized at all. * * @see StackExtension http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/Initialization.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/Initialization.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/Initialization.java index 64cb880..a633722 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/Initialization.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/Initialization.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 @@ -35,7 +33,7 @@ public interface Initialization /** * Changes the initialization priority of the initialization from its default, {@link InitializationPriority#NORMAL}. - * <p/> + * * Note: it is possible that this method may be removed before release 5.4 is final. * * @param priority http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/InitializationPriority.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/InitializationPriority.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/InitializationPriority.java index 31848d2..e7babbf 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/InitializationPriority.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/InitializationPriority.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 @@ -29,7 +27,7 @@ public enum InitializationPriority * Provided JavaScript will be executed immediately (it is not deferred until the page loads). Execution occur via * JavaScript's {@code eval}, and occurs once all {@linkplain JavaScriptSupport#importJavaScriptLibrary(org.apache.tapestry5.Asset) JavaScript libraries} * (but not modules) for the page have been loaded. - * <p/> + * * * @deprecated Deprecated in 5.4; this is now treated as "earlier than {@linkplain #EARLY early}". */ http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/84053397/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/JavaScriptModuleConfiguration.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/JavaScriptModuleConfiguration.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/JavaScriptModuleConfiguration.java index 2fb1478..8b7427e 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/JavaScriptModuleConfiguration.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/JavaScriptModuleConfiguration.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 @@ -23,10 +21,10 @@ import java.util.List; * Used to define a <a href="http://requirejs.org/docs/api.html#config-shim";>module shim</a>, used to adapt non-AMD JavaScript libraries * to operate like proper modules. This information is used to build up a list of dependencies for the contributed JavaScript module, * and to identify the resource to be streamed to the client. - * <p/> + * * Instances of this class are contributed to the {@link ModuleManager} service; the contribution key is the module name * (typically, a single word). - * <p/> + * * In some cases, an instance may be created and contributed to override a default module; if the module has no dependencies, * exports, or initExpression (that is, if it is a proper AMD module, where such dependencies are provided inside * the module itself), then no client-side shim configuration will be written for the module, but requests for the @@ -111,7 +109,7 @@ public final class JavaScriptModuleConfiguration * Used as an alternative to {@linkplain #exports(String)}, this allows a short expression to be specified; the * expression is used to initialize, clean up, and (usually) return the module's export value. For Underscore, this * would be "_.noConflict()". If the expression returns null, then the exports value is used. - * <p/> + * * In RequireJS 2.1.1 (the version shipped with Tapestry, currently), an init function is not invoked unless * the shim also defines an exports. See <a href="https://github.com/jrburke/requirejs/issues/517";>RequireJS issue 517</a>. * At this time, you should specify {@link #exports} even if you provide a {@link #initializeWith(String)}}.
