You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tapestry.apache.org by hl...@apache.org on 2007/03/09 16:30:39 UTC
svn commit: r516434 - in
/tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt: case.apt command.apt
configuration.apt decorator.apt module.apt order.apt pipeline.apt
provider.apt run.apt service.apt shadow.apt strategy.apt
Author: hlship
Date: Fri Mar 9 07:30:34 2007
New Revision: 516434
URL: http://svn.apache.org/viewvc?view=rev&rev=516434
Log:
Fix links from site documentation to Javadoc.
Modified:
tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/case.apt
tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/command.apt
tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/configuration.apt
tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/decorator.apt
tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/module.apt
tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/order.apt
tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/pipeline.apt
tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/provider.apt
tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/run.apt
tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/service.apt
tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/shadow.apt
tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/strategy.apt
Modified: tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/case.apt
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/case.apt?view=diff&rev=516434&r1=516433&r2=516434
==============================================================================
--- tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/case.apt (original)
+++ tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/case.apt Fri Mar 9 07:30:34 2007
@@ -24,4 +24,4 @@
Just case is ignored --
other punctuation, as well as whitespace, must exactly match.
- Under the covers, this is supported by the {{{../apidocs/org/apache/tapestry/ioc/CaseInsensitiveMap.html}CaseInsensitiveMap}} class.
\ No newline at end of file
+ Under the covers, this is supported by the {{{apidocs/org/apache/tapestry/ioc/CaseInsensitiveMap.html}CaseInsensitiveMap}} class.
\ No newline at end of file
Modified: tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/command.apt
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/command.apt?view=diff&rev=516434&r1=516433&r2=516434
==============================================================================
--- tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/command.apt (original)
+++ tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/command.apt Fri Mar 9 07:30:34 2007
@@ -32,7 +32,7 @@
Because this pattern is used so often inside Tapestry, a built-in service exists
to create implementations of the pattern as needed. The
- {{{../apidocs/org/apache/tapestry/ioc/services/ChainBuilder.html}tapestry.ioc.ChainBuilder}}
+ {{{apidocs/org/apache/tapestry/ioc/services/ChainBuilder.html}tapestry.ioc.ChainBuilder}}
service takes care of all the work:
+----+
Modified: tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/configuration.apt
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/configuration.apt?view=diff&rev=516434&r1=516433&r2=516434
==============================================================================
--- tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/configuration.apt (original)
+++ tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/configuration.apt Fri Mar 9 07:30:34 2007
@@ -131,7 +131,7 @@
of the service.
On the contribution side, a service contribution method sees a
- {{{../apidocs/org/apache/tapestry/ioc/Configuration.html}Configuration}} object:
+ {{{apidocs/org/apache/tapestry/ioc/Configuration.html}Configuration}} object:
+------+
@Contribute("some.module.Startup")
@@ -191,7 +191,7 @@
For our service contribution methods, we must provide a parameter
of type
- {{{../apidocs/org/apache/tapestry/ioc/OrderedConfiguration.html}OrderedConfiguration}}:
+ {{{apidocs/org/apache/tapestry/ioc/OrderedConfiguration.html}OrderedConfiguration}}:
+------+
@Contribute("some.module.Startup")
@@ -237,7 +237,7 @@
other things to be injected.
- * {{{../apidocs/org/apache/tapestry/ioc/ServiceLocator.html}ServiceLocator}}: access to other services visible
+ * {{{apidocs/org/apache/tapestry/ioc/ServiceLocator.html}ServiceLocator}}: access to other services visible
to the contributing module
[]
Modified: tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/decorator.apt
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/decorator.apt?view=diff&rev=516434&r1=516433&r2=516434
==============================================================================
--- tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/decorator.apt (original)
+++ tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/decorator.apt Fri Mar 9 07:30:34 2007
@@ -133,7 +133,7 @@
Targetting Multiple Services
By using the
- {{{../apidocs/org/apache/tapestry/ioc/annotations/Match.html}@Match annnotation}},
+ {{{apidocs/org/apache/tapestry/ioc/annotations/Match.html}@Match annnotation}},
you may identify which services are to be decorated.
The value specified in the Match annotation is one or more patterns. These patterns
@@ -175,7 +175,7 @@
In cases where multiple decorators will apply to a single service, you can control
the order in which decorators are applied using an additional annotation:
- {{{../apidocs/org/apache/tapestry/ioc/annotations/Order.html}@Order}}.
+ {{{apidocs/org/apache/tapestry/ioc/annotations/Order.html}@Order}}.
This annotation allows any number of {{{order.html}ordering constraints}}
to be specified for the decorator, to order it relative to
Modified: tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/module.apt
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/module.apt?view=diff&rev=516434&r1=516433&r2=516434
==============================================================================
--- tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/module.apt (original)
+++ tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/module.apt Fri Mar 9 07:30:34 2007
@@ -44,7 +44,7 @@
Overriding the Module id
- Adding an {{{../apidocs/org/apache/tapestry/ioc/annotations/Id.html}@Id annnotation}}
+ Adding an {{{apidocs/org/apache/tapestry/ioc/annotations/Id.html}@Id annnotation}}
to the module builder class will control the module's id.
+-----------------------------------------------------------------------------------+
@@ -120,7 +120,7 @@
* org.apache.commons.logging.Log: log for the module
- * {{{../apidocs/org/apache/tapestry/ioc/ServiceLocator.html}ServiceLocator}}: access to other services
+ * {{{apidocs/org/apache/tapestry/ioc/ServiceLocator.html}ServiceLocator}}: access to other services
[]
@@ -193,7 +193,7 @@
or packages).
A better alternative is the
- {{{../apidocs/org/apache/tapestry/ioc/annotations/SubModule.html}@SubModule annotation}}.
+ {{{apidocs/org/apache/tapestry/ioc/annotations/SubModule.html}@SubModule annotation}}.
The value for this annotation is a list of <additional> classes to be treated as module builder classes,
exactly as if they were identified in the manifest. For example:
Modified: tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/order.apt
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/order.apt?view=diff&rev=516434&r1=516433&r2=516434
==============================================================================
--- tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/order.apt (original)
+++ tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/order.apt Fri Mar 9 07:30:34 2007
@@ -27,7 +27,7 @@
control what other objects must come before a contribution, or come after.
The constraints are specified using the
- {{{../apidocs/org/apache/tapestry/ioc/annotations/Order.html}Order}} annotation (for
+ {{{apidocs/org/apache/tapestry/ioc/annotations/Order.html}Order}} annotation (for
service decorator methods), or as variable arguments at the end of the add() method
for ordered configurations.
Modified: tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/pipeline.apt
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/pipeline.apt?view=diff&rev=516434&r1=516433&r2=516434
==============================================================================
--- tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/pipeline.apt (original)
+++ tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/pipeline.apt Fri Mar 9 07:30:34 2007
@@ -59,7 +59,7 @@
+-----+
The
- {{{../apidocs/org/apache/tapestry/ioc/services/PipelineBuilder.html}tapestry.ioc.PipelineBuilder}}
+ {{{apidocs/org/apache/tapestry/ioc/services/PipelineBuilder.html}tapestry.ioc.PipelineBuilder}}
service is useful for constructing pipelines. The service is often injected
into a service builder method, along with an ordered configuration of services.
Modified: tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/provider.apt
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/provider.apt?view=diff&rev=516434&r1=516433&r2=516434
==============================================================================
--- tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/provider.apt (original)
+++ tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/provider.apt Fri Mar 9 07:30:34 2007
@@ -5,7 +5,7 @@
Object Providers
The
- {{{../apidocs/org/apache/tapestry/ioc/annotations/Inject.html}@Inject annotation}}
+ {{{apidocs/org/apache/tapestry/ioc/annotations/Inject.html}@Inject annotation}}
is a flexible way to inject dependencies into a service. With this annotation
the value to be injected is not identified by a service id <per se>. Instead
the annotation's value is an <<object reference>>: a combination of a
@@ -13,7 +13,7 @@
The provider prefix
maps to a particular instance of
- {{{../apidocs/org/apache/tapestry/ioc/ObjectProvider.html}ObjectProvider}}, which
+ {{{apidocs/org/apache/tapestry/ioc/ObjectProvider.html}ObjectProvider}}, which
understands the expression.
In practice, @InjectService("Foo") and @Inject("service:Foo") work identically,
Modified: tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/run.apt
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/run.apt?view=diff&rev=516434&r1=516433&r2=516434
==============================================================================
--- tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/run.apt (original)
+++ tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/run.apt Fri Mar 9 07:30:34 2007
@@ -6,7 +6,7 @@
Primarily, you will use the IoC Registry as part of a Tapestry application.
In those situations, the
- {{{../apidocs/org/apache/tapestry/TapestryFilter.html}TapestryFilter}} will
+ {{{apidocs/org/apache/tapestry/TapestryFilter.html}TapestryFilter}} will
be responsible for starting and stopping the registry.
However, you may want to do some integration testing using the Registry
@@ -16,7 +16,7 @@
Building the Registry
The class
- {{{../apidocs/org/apache/tapestry/ioc/RegistryBuilder.html}RegistryBuilder}}
+ {{{apidocs/org/apache/tapestry/ioc/RegistryBuilder.html}RegistryBuilder}}
is used to create a Registry.
+---+
@@ -32,13 +32,13 @@
Using this approach, you will form a Registry containing
the builtin services from the
- {{{../apidocs/org/apache/tapestry/ioc/services/TapestryIoCModule.html}tapestry.ioc module}}, plus
+ {{{apidocs/org/apache/tapestry/ioc/services/TapestryIoCModule.html}tapestry.ioc module}}, plus
the modules you explicitly list.
Building the Default Registry
The default registry is available by invoking the static method
- {{{../apidocs/org/apache/tapestry/ioc/IoCUtilities.html#buildDefaultRegistry()}IoCUtilities.buildDefaultRegistry()}}.
+ {{{apidocs/org/apache/tapestry/ioc/IoCUtilities.html#buildDefaultRegistry()}IoCUtilities.buildDefaultRegistry()}}.
This method builds a Registry using
{{{module.html#Autoloading modules}autoloading logic}}, where modules to load
are identified via a JAR Manifest entry.
@@ -46,7 +46,7 @@
Shutting down the Registry
The method
- {{{../apidocs/org/apache/tapestry/ioc/Registry.html#shutdown()}Registry.shutdown()}}
+ {{{apidocs/org/apache/tapestry/ioc/Registry.html#shutdown()}Registry.shutdown()}}
will shutdown the Registry. This immediately invalidates all service proxies.
Some services may have chosen to register for shutdown notification (for example,
to do cleanup work such as closing a database connection).
Modified: tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/service.apt
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/service.apt?view=diff&rev=516434&r1=516433&r2=516434
==============================================================================
--- tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/service.apt (original)
+++ tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/service.apt Fri Mar 9 07:30:34 2007
@@ -76,7 +76,7 @@
Injecting Dependencies with @Inject
A second approach to injection uses the more general purpose
- {{{../apidocs/org/apache/tapestry/ioc/annotations/Inject.html}@Inject annotation}}.
+ {{{apidocs/org/apache/tapestry/ioc/annotations/Inject.html}@Inject annotation}}.
@Inject doesn't specify a service id <em>per se</em>. With inject, you provide
an {{{provider.html}object reference}}. Different prefixes on the reference
@@ -105,7 +105,7 @@
In some cases, it is desirable to mark a service a private, in which case, it is only
visible within the same module.
- The {{{../apidocs/org/apache/tapestry/ioc/annotations/Private.html}@Private annotation}} can
+ The {{{apidocs/org/apache/tapestry/ioc/annotations/Private.html}@Private annotation}} can
be attached to a service builder method to indicate that the service in question is private.
Defining Service Lifecycle
@@ -115,7 +115,7 @@
more can be added.
Service lifecycle is specified using the
- {{{../apidocs/org/apache/tapestry/ioc/annotations/Lifeycle.html}@Lifecycle annotation}},
+ {{{apidocs/org/apache/tapestry/ioc/annotations/Lifeycle.html}@Lifecycle annotation}},
which is attached to a builder method. When this annotation is not present, the
default lifecycle, "singleton" is used.
@@ -125,7 +125,7 @@
is created when the service is first referenced. By reference, we mean any situation in which
the service is requested by name, such as using the @InjectService annotation on a
service builder method, or by using the
- {{{../apidocs/org/apache/tapestry/ioc/Registry.html}Registry}} API from outside the
+ {{{apidocs/org/apache/tapestry/ioc/Registry.html}Registry}} API from outside the
container.
In any case, the service proxy will only create the service implementation when a method
@@ -168,7 +168,7 @@
Services are normally created only as needed (per the lifecycle discussion above).
This can be tweaked slightly; by adding the
- {{{../apidocs/org/apache/tapestry/ioc/annotations/EagerLoad.html}EagerLoad}} annotation to
+ {{{apidocs/org/apache/tapestry/ioc/annotations/EagerLoad.html}EagerLoad}} annotation to
the service builder method, Tapestry will instantiate the service when the Registry is first created.
This will cause the service builder method to be invoked, as well as any service decorator methods.
@@ -195,7 +195,7 @@
* java.lang.Class: service interface implemented by the service to be constructed
- * {{{../apidocs/org/apache/tapestry/ioc/ServiceResources.html}ServiceResources}}: access to other services
+ * {{{apidocs/org/apache/tapestry/ioc/ServiceResources.html}ServiceResources}}: access to other services
[]
@@ -272,13 +272,13 @@
*----------------------------------+-----------------------------------------------------------------------------------------+
| <<Service Id>> | <<Service Interface>> |
*----------------------------------+-----------------------------------------------------------------------------------------+
-| tapestry.ioc.ClassFactory | {{{../apidocs/org/apache/tapestry/ioc/services/ClassFactory.html}ClassFactory}} |
+| tapestry.ioc.ClassFactory | {{{apidocs/org/apache/tapestry/ioc/services/ClassFactory.html}ClassFactory}} |
*----------------------------------+-----------------------------------------------------------------------------------------+
-| tapestry.ioc.LogSource | {{{../apidocs/org/apache/tapestry/ioc/LogSource.html}LogSource}} |
+| tapestry.ioc.LogSource | {{{apidocs/org/apache/tapestry/ioc/LogSource.html}LogSource}} |
*----------------------------------+-----------------------------------------------------------------------------------------+
-| tapestry.ioc.RegistryShutdownHub | {{{../apidocs/org/apache/tapestry/ioc/RegistryShutdownHub.html}RegistryShutdownHub}} |
+| tapestry.ioc.RegistryShutdownHub | {{{apidocs/org/apache/tapestry/ioc/RegistryShutdownHub.html}RegistryShutdownHub}} |
*----------------------------------+-----------------------------------------------------------------------------------------+
-| tapestry.ioc.ThreadCleanupHub | {{{../apidocs/org/apache/tapestry/ioc/services/ThreadCleanupHub.html}ThreadCleanupHub}} |
+| tapestry.ioc.ThreadCleanupHub | {{{apidocs/org/apache/tapestry/ioc/services/ThreadCleanupHub.html}ThreadCleanupHub}} |
*----------------------------------+-----------------------------------------------------------------------------------------+
Modified: tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/shadow.apt
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/shadow.apt?view=diff&rev=516434&r1=516433&r2=516434
==============================================================================
--- tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/shadow.apt (original)
+++ tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/shadow.apt Fri Mar 9 07:30:34 2007
@@ -5,7 +5,7 @@
Shadow Services
The
- {{{../apidocs/org/apache/tapestry/ioc/services/PropertyShadowBuilder.html}tapestry.ioc.PropertyShadowBuilder}}
+ {{{apidocs/org/apache/tapestry/ioc/services/PropertyShadowBuilder.html}tapestry.ioc.PropertyShadowBuilder}}
service is used to build a special, delegating kind of service implementation.
Effectively, it is used to allow a property of another service to be exposed as its own service.
Modified: tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/strategy.apt
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/strategy.apt?view=diff&rev=516434&r1=516433&r2=516434
==============================================================================
--- tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/strategy.apt (original)
+++ tapestry/tapestry5/tapestry-ioc/trunk/src/site/apt/strategy.apt Fri Mar 9 07:30:34 2007
@@ -7,7 +7,7 @@
Another of the Gang Of Four patterns, the strategy pattern as implemented in Tapestry IoC is a kind of late binding.
The idea is that <adapters> for objects are accessed based on the <actual type> of an object. These adapters supply additional functionality. The adapters
- are located using an {{{../apidocs/org/apache/tapestry/util/StrategyRegistry.html}StrategyRegistry}}.
+ are located using an {{{apidocs/org/apache/tapestry/util/StrategyRegistry.html}StrategyRegistry}}.
The lookup of adapters is based on an inheritance search; thus providing an adapter for type java.util.Map will match any object that implements the Map interface.
The inheritance search works its way up the class hierarchy looking for a matching registration. If nothing is found, then all the interfaces directly or indirectly
@@ -17,7 +17,7 @@
As a special case, the value null is search for as if it was an instance of the class void.
- The {{{../apidocs/org/apache/tapestry/ioc/services/StrategyBuilder.html}tapestry.ioc.StrategyBuilder}} service creates a service implementation around a strategy registry.
+ The {{{apidocs/org/apache/tapestry/ioc/services/StrategyBuilder.html}tapestry.ioc.StrategyBuilder}} service creates a service implementation around a strategy registry.
+---+
public interface StrategyBuilder