CVS: Tapestry/framework/src/net/sf/tapestry/spec IApplicationSpecification.java,1.2,1.2.2.1 ILibrarySpecification.java,1.4.2.3,1.4.2.4 LibrarySpecification.java,1.8.2.2,1.8.2.3

Update of /cvsroot/tapestry/Tapestry/framework/src/net/sf/tapestry/spec
In directory sc8-pr-cvs1:/tmp/cvs-serv9858/framework/src/net/sf/tapestry/spec

Modified Files:
      Tag: hship-2-3
	IApplicationSpecification.java ILibrarySpecification.java 
	LibrarySpecification.java 
Log Message:
Add missing JavaDoc comments, deprecate old, poorly named methods.

Index: IApplicationSpecification.java
===================================================================
RCS file: /cvsroot/tapestry/Tapestry/framework/src/net/sf/tapestry/spec/IApplicationSpecification.java,v
retrieving revision 1.2
retrieving revision 1.2.2.1
diff -C2 -d -r1.2 -r1.2.2.1
*** IApplicationSpecification.java	27 Nov 2002 17:58:52 -0000	1.2
--- IApplicationSpecification.java	2 Jan 2003 03:12:44 -0000	1.2.2.1
***************
*** 15,27 ****
  public interface IApplicationSpecification extends ILibrarySpecification
  {
!  
      public String getName();
  
      public void setEngineClassName(String value);
      
      public String getEngineClassName();
      
      public void setName(String name);
- 
- 
  }
--- 15,35 ----
  public interface IApplicationSpecification extends ILibrarySpecification
  {
!     /**
!      *  Returns a "user friendly" name for the application (which is optional).
!      * 
!      **/
!     
      public String getName();
  
      public void setEngineClassName(String value);
      
+     /**
+      *  Returns the name of the class (which implements {@link net.sf.tapestry.IEngine}).
+      *  May return null, in which case a default is used.
+      * 
+      **/
+     
      public String getEngineClassName();
      
      public void setName(String name);
  }

Index: ILibrarySpecification.java
===================================================================
RCS file: /cvsroot/tapestry/Tapestry/framework/src/net/sf/tapestry/spec/ILibrarySpecification.java,v
retrieving revision 1.4.2.3
retrieving revision 1.4.2.4
diff -C2 -d -r1.4.2.3 -r1.4.2.4
*** ILibrarySpecification.java	16 Dec 2002 12:56:35 -0000	1.4.2.3
--- ILibrarySpecification.java	2 Jan 2003 03:12:44 -0000	1.4.2.4
***************
*** 21,25 ****
  {
  
! 
      public String getLibrarySpecificationPath(String id);
  
--- 21,31 ----
  {
  
!     /**
!      *  Returns the specification path (within the classpath) for
!      *  an embedded library, or null if
!      *  no such library has been defined.
!      * 
!      **/
!     
      public String getLibrarySpecificationPath(String id);
  
***************
*** 34,37 ****
--- 40,48 ----
      public void setLibrarySpecificationPath(String id, String path);
  
+     /**
+      *  Returns a sorted list of library ids (or the empty list, but not null).
+      * 
+      **/
+     
      public List getLibraryIds();
      
***************
*** 40,43 ****
--- 51,60 ----
      public void setPageSpecificationPath(String name, String path);
  
+     /**
+      *  Returns a sorted list of page names explicitly defined by this library,
+      *  or an empty list (but not null).
+      * 
+      **/
+     
      public List getPageNames();
      
***************
*** 50,59 ****
--- 67,96 ----
       *  all components defined in this library.
       * 
+      *  @deprecated To be removed after release 2.4, use
+      *  {@link #getComponentTypes()} instead.
+      * 
       **/
      
      public List getComponentAliases();
  
+     /**
+      *  Returns the simple types of all components defined in
+      *  this library.  Returns a list of strings in sorted order,
+      *  or an empty list (but not null).
+      * 
+      *  @since 2.4
+      * 
+      **/
+ 
+     public List getComponentTypes();
+     
      public String getServiceClassName(String name);
  
+     /**
+      *  Returns a sorted list of service names (or an empty list, but
+      *  not null).
+      * 
+      **/
+     
      public List getServiceNames();
  

Index: LibrarySpecification.java
===================================================================
RCS file: /cvsroot/tapestry/Tapestry/framework/src/net/sf/tapestry/spec/LibrarySpecification.java,v
retrieving revision 1.8.2.2
retrieving revision 1.8.2.3
diff -C2 -d -r1.8.2.2 -r1.8.2.3
*** LibrarySpecification.java	16 Dec 2002 12:56:35 -0000	1.8.2.2
--- LibrarySpecification.java	2 Jan 2003 03:12:44 -0000	1.8.2.3
***************
*** 167,170 ****
--- 167,180 ----
      }
  
+     /**
+      *  @since 2.4
+      * 
+      **/
+     
+    public List getComponentTypes()
+     {
+         return getComponentAliases();
+     }
+     
      public String getServiceClassName(String name)
      {



-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf