[jboss-cvs] jboss-seam/src/main/org/jboss/seam/annotations ...

[Gavin King]

  User: gavin   
  Date: 06/10/09 23:48:19

  Modified:    src/main/org/jboss/seam/annotations   Factory.java Out.java
  Log:
  javadoc and minor refactor
  
  Revision  Changes    Path
  1.6       +7 -1      jboss-seam/src/main/org/jboss/seam/annotations/Factory.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: Factory.java
  ===================================================================
  RCS file: /cvsroot/jboss/jboss-seam/src/main/org/jboss/seam/annotations/Factory.java,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -b -r1.5 -r1.6
  --- Factory.java	3 Jul 2006 16:57:44 -0000	1.5
  +++ Factory.java	10 Oct 2006 03:48:19 -0000	1.6
  @@ -1,4 +1,4 @@
  -//$Id: Factory.java,v 1.5 2006/07/03 16:57:44 gavin Exp $
  +//$Id: Factory.java,v 1.6 2006/10/10 03:48:19 gavin Exp $
   package org.jboss.seam.annotations;
   
   import static java.lang.annotation.ElementType.METHOD;
  @@ -41,6 +41,12 @@
       * take responsibility for outjecting the value,
       * and then scope() is ignored.
       * 
  +    * If the factory method returns a value, but no 
  +    * scope is explicitly specified, the scope of 
  +    * the component with the @Factory attribute is used. 
  +    * But if the component scope is STATELESS, the EVENT 
  +    * scope is used.
  +    * 
       * @return the scope to outject any returned value
       */
      ScopeType scope() default ScopeType.UNSPECIFIED;
  
  
  
  1.8       +7 -2      jboss-seam/src/main/org/jboss/seam/annotations/Out.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: Out.java
  ===================================================================
  RCS file: /cvsroot/jboss/jboss-seam/src/main/org/jboss/seam/annotations/Out.java,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -b -r1.7 -r1.8
  --- Out.java	18 Apr 2006 08:42:32 -0000	1.7
  +++ Out.java	10 Oct 2006 03:48:19 -0000	1.8
  @@ -36,8 +36,13 @@
       */
      boolean required() default true;
      /**
  -    * Specifies the scope, for values which are not
  -    * instances of a Seam component.
  +    * Specifies the scope to outject to. If no scope is
  +    * explicitly specified, the default scope depends
  +    * upon whether the value is an instance of a Seam 
  +    * component. If it is, the component scope is 
  +    * used. Otherwise, the scope of the component with
  +    * the @Out attribute is used. But if the component
  +    * scope is STATELESS, the EVENT scope is used.
       */
      ScopeType scope() default ScopeType.UNSPECIFIED;
   }