[Yanel-commits] rev 26339 - public/yanel/trunk/src/core/java/org/wyona/yanel/core/api/attributes

[michi at wyona.com]

Author: michi
Date: 2007-07-27 09:41:37 +0200 (Fri, 27 Jul 2007)
New Revision: 26339

Modified:
   public/yanel/trunk/src/core/java/org/wyona/yanel/core/api/attributes/ViewableV2.java
Log:
javadoc added

Modified: public/yanel/trunk/src/core/java/org/wyona/yanel/core/api/attributes/ViewableV2.java
===================================================================
--- public/yanel/trunk/src/core/java/org/wyona/yanel/core/api/attributes/ViewableV2.java	2007-07-27 06:49:06 UTC (rev 26338)
+++ public/yanel/trunk/src/core/java/org/wyona/yanel/core/api/attributes/ViewableV2.java	2007-07-27 07:41:37 UTC (rev 26339)
@@ -1,5 +1,5 @@
 /*
- * Copyright 2006 Wyona
+ * Copyright 2007 Wyona
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -27,29 +27,27 @@
 public interface ViewableV2 {
 
     /**
-     *
+     * List of all view types of this resource
      */
     public ViewDescriptor[] getViewDescriptors();
 
+    /**
+     * View of this resource
+     */
     public View getView(String viewId) throws Exception;
     
     /**
-     * NOTE: A resource does not necessarily have a path
+     * Allows to check if a view of this resource exists
      */
-    //public View getView(Path path, OutputStream out, String viewId) throws Exception;
-
-    /**
-     * 
-     */
     public boolean exists() throws Exception;
     
     /**
-     * 
+     * Size of view. Return -1 in case the size is unknown.
      */
     public long getSize() throws Exception;
     
     /**
-     * 
+     * Mime type of resource, e.g. application/xhtml+xml, whereas it can depend on view id
      */
     public String getMimeType(String viewId) throws Exception;
 }