portals-jetspeed-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pau...@apache.org
Subject cvs commit: jakarta-jetspeed/src/java/org/apache/jetspeed/services/portletcache Cacheable.java
Date Fri, 18 Jan 2002 23:31:37 GMT
paulsp      02/01/18 15:31:37

  Modified:    src/java/org/apache/jetspeed/services/portletcache
                        Cacheable.java
  Log:
  o Javadoc updates
  
  Revision  Changes    Path
  1.5       +37 -27    jakarta-jetspeed/src/java/org/apache/jetspeed/services/portletcache/Cacheable.java
  
  Index: Cacheable.java
  ===================================================================
  RCS file: /home/cvs/jakarta-jetspeed/src/java/org/apache/jetspeed/services/portletcache/Cacheable.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- Cacheable.java	7 Oct 2001 12:29:15 -0000	1.4
  +++ Cacheable.java	18 Jan 2002 23:31:37 -0000	1.5
  @@ -64,57 +64,67 @@
    *
    * @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
    * @author <a href="mailto:raphael@apache.org">RaphaŽl Luta</a>
  - * @version $Id: Cacheable.java,v 1.4 2001/10/07 12:29:15 paulsp Exp $
  + * @version $Id: Cacheable.java,v 1.5 2002/01/18 23:31:37 paulsp Exp $
    */
   public interface Cacheable
   {
       /**
  -    Return true if this Cacheable is allowed to be cached.  
  -    */
  +     * Return true if this Cacheable is allowed to be cached.
  +     *
  +     * @return <CODE>TRUE</CODE> if object is cachable<br>
  +     * <CODE>FALSE</CODE> if object is not cacheable
  +     */
       public boolean isCacheable();
       
       /**
  -    Set this cacheable status.
  -    */
  +     * Set this cacheable status.
  +     *
  +     * @param cacheable Set the cacheability of the object
  +     */
       public void setCacheable(boolean cacheable);
       
       /**
  -    Used by a Cacheable object to determine when it should expire itself from 
  -    the cache.
  -    */
  +     * Used by a Cacheable object to determine when it should expire itself from
  +     * the cache.
  +     *
  +     * @return Expire handle
  +     */
       public Expire getExpire();
   
       /**
  -    <p>Used by the cache to get a unique reference on what you want to add
  -    and then retrieve in the future from the cache</p>
  -    
  -    <p>Most implementations should just call the CacheHandleManager with
  -    the given params within the implementation and just return this.</p>
  -    * @deprecated cacheable classes should now implement a static getHandle(config) method
  -    */
  +     * <p>Used by the cache to get a unique reference on what you want to add
  +     * and then retrieve in the future from the cache</p>
  +     *
  +     * <p>Most implementations should just call the CacheHandleManager with
  +     * the given params within the implementation and just return this.</p>
  +     *
  +     * @deprecated cacheable classes should now implement a static getHandle(config) method
  +     */
       public String getHandle();
   
  -    /**
  -    <p>Set the handle for this Cacheable.</p>
  -    
  -    <p>Note that factories should call setHandle() so that getHandle() always
  -    returns a value correctly.</p>
  -    * @deprecated cacheable classes should now implement a static getHandle(config) method
  -    */
  +    /***
  +     * <p>Set the handle for this Cacheable.</p>
  +     *
  +     * <p>Note that factories should call setHandle() so that getHandle() always
  +     * returns a value correctly.</p>
  +     *
  +     * @deprecated cacheable classes should now implement a static getHandle(config) method
  +     */
       public void setHandle( String handle );
     
       /**
        * Return the expiration time in milliseconds.
  -     @return Expiration time in milliseconds since epoch, or null if the 
  +     *
  +     * @return Expiration time in milliseconds since epoch, or null if the 
        *         expiration was not set
        */
       public Long getExpirationMillis();
   
       /**
  -    * Set the expiration time in milliseconds.
  -    @param setExpirationMillis Expiration in milliseconds since epoch
  -    */
  +     * Set the expiration time in milliseconds.
  +     *
  +     * @param expirationMillis Set expiration in millis
  +     */
       public void setExpirationMillis( long expirationMillis);
  -
   
   }
  
  
  

--
To unsubscribe, e-mail:   <mailto:jetspeed-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:jetspeed-dev-help@jakarta.apache.org>


Mime
View raw message