Skip to main content

[JIRA] Created: (PORTLETSPEC3-3) Errata: Clarification in Javadoc for CacheControl.getExpirationTime()

  • From: "msnicklous (JIRA)" < >
  • To:
  • Subject: [JIRA] Created: (PORTLETSPEC3-3) Errata: Clarification in Javadoc for CacheControl.getExpirationTime()
  • Date: Tue, 30 Apr 2013 14:16:58 +0000 (UTC)
  • Auto-submitted: auto-generated

Errata: Clarification in Javadoc for CacheControl.getExpirationTime()
---------------------------------------------------------------------

                 Key: PORTLETSPEC3-3
                 URL: https://java.net/jira/browse/PORTLETSPEC3-3
             Project: portletspec3
          Issue Type: Improvement
          Components: JSR 286 Portlet Specification Errata
            Reporter: msnicklous
            Priority: Minor


In the Javadoc for the CacheControl class, the following is stated for 
getExpirationTime() and setExpirationTime().
Taken together, it's a bit unclear as to what a return value of 0 from 
getExpirationTime() actually means - does
it mean "hasn't been set" or does it mean "disabled"? 

The description for getExpirationTime() should be changed as indicated. The 
description for setExpirationTime() would remain unchanged.

Original:
-------------------------
getExpirationTime

int getExpirationTime()

    Get the currently set expiration time. If no expiration time is set on 
this response 
    the default defined in the portlet deployment descriptor with the 
expiration-cache tag is returned, or 0 if no default is defined.

    This call returns the same value as the getProperty(EXPIRATION_CACHE) 
call.

    Returns:
        the currently set expiration time in seconds, or 0 if no expiration 
time is set.

setExpirationTime

void setExpirationTime(int time)

    Sets a new expiration time for the current response in seconds.

    If the expiration value is set to 0, caching is disabled for this 
portlet; if the value is set to -1, the cache does not expire.

    This call is equivalent to calling setProperty(EXPIRATION_CACHE).

    Parameters:
        time - expiration time in seconds
-------------------------

Corrected:
-------------------------
getExpirationTime

int getExpirationTime()

    Get the currently set expiration time. If no expiration time has been 
explicitly set on this response, 
    the default defined in the portlet deployment descriptor with the 
expiration-cache tag is returned; If
    no default value is provided, 0 is assumed.

    This call returns the same value as the getProperty(EXPIRATION_CACHE) 
call.

    Returns:
        the currently set expiration time in seconds; 0 indicates caching is 
disabled for this portlet; 
        -1 indicates the cache does not expire.

setExpirationTime

(unchanged)
-------------------------


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

        


[JIRA] Created: (PORTLETSPEC3-3) Errata: Clarification in Javadoc for CacheControl.getExpirationTime()

msnicklous (JIRA) 04/30/2013
 
 
Close
loading
Please Confirm
Close