[ http://issues.apache.org/jira/browse/BEEHIVE-917?page=all ]
     
Jeremiah Johnson reopened BEEHIVE-917:
--------------------------------------

     Assign To: Steve Hanson  (was: Jeremiah Johnson)

There are two examples that I think were missed:

Section 12.1 (Composition Using Declarative Instantiation) has a control 
implementation example that I think could cause confusion if left as is.  If 
you agree, please replace 'public class OrderRouterImpl' with 
@ControlImplementation public class OrderRouterImpl implements OrderRouter.  
The same issue exists in the example in Section 12.1.1 (Composition using 
Programmatic Mechanisms).

In both of those examples, a Controls container is expected (first uses 
@Control and second uses @Context), so I think that it is important to be 
consistent and mark these as ControlImplementations.

> Controls Programming leaves off @ControlImplementation
> ------------------------------------------------------
>
>          Key: BEEHIVE-917
>          URL: http://issues.apache.org/jira/browse/BEEHIVE-917
>      Project: Beehive
>         Type: Bug
>   Components: Documentation
>  Environment: going through docs on dist built from SVN 279793
>     Reporter: Jeremiah Johnson
>     Assignee: Steve Hanson
>     Priority: Minor
>      Fix For: V1

>
> In Section 5 of Controls Programming 
> (trunk/docs/forrest/release/src/documentation/context/xdocs/controls/programming.xml),
>  it doesn't mention the ControlImplementation annotation.  The Control 
> Implementation Class example doesn't use the annotation.  The text should be 
> updated to speak of the annotation and the example should use it.
> --- current text
> The only basic rule for a Control Implementation Class is that it must always 
> implement the associated Control Public Interface.
> --- change that to something like this
> The basic rules for a Control Implementation Class are that it must be 
> annotated with ControlImplementation and it must implement the associated 
> Control Public Interface.
> ---
> Don't forget to update the example.  The example source as it is will 
> compile, but if a person were walking through the document and attempted 
> instantiation of their new control (Section 6) it would fail at runtime with 
> 'ControlImplementation is missing from control implementation class'.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira

Reply via email to