[jboss-jira] [JBoss JIRA] Commented: (JBPORTAL-1548) More Yodaspeak

[Andrew Oliver (JIRA)]

    [ http://jira.jboss.com/jira/browse/JBPORTAL-1548?page=comments#action_12368315 ] 
            
Andrew Oliver commented on JBPORTAL-1548:
-----------------------------------------

"The PortalNodeEvent onEvent(PortalNodeEventContext context, PortalNodeEvent event)  declare a PortalNodeEvent as return type. In normal circumstances it will return the null value, however if the method call returns an event then this event should be considered by the portal as behavior replacing the current one."

10.7.1.2.
"The PortalNodeEvent onEvent(PortalNodeEventContext context, PortalNodeEvent event) method declares a PortalNodeEvent as return type.  Commonly the method returns null; however, a returned PortalNodeEvent replaces the event in the listeners subsequently called durring the event bubbling process."

method declares (number agreement, missing word)
the latter sentence is vague and "In normal circumstances" is actually "Under normal circumstances" but more commonly "Normally"

> More Yodaspeak
> --------------
>
>                 Key: JBPORTAL-1548
>                 URL: http://jira.jboss.com/jira/browse/JBPORTAL-1548
>             Project: JBoss Portal
>          Issue Type: Sub-task
>      Security Level: Public(Everyone can see) 
>          Components: Portal Reference Guide
>    Affects Versions: 2.6 Final
>            Reporter: Andrew Oliver
>         Assigned To: Julien Viet
>            Priority: Minor
>             Fix For: 2.8 Final, 2.6.1 Final
>
>         Attachments: 200px-Porky_Pig1.jpg
>
>
> "The Portal API package prefix is org.jboss.portal.api and all the classes part of the API are prefixed with that package except for two of them which are the org.jboss.portal.Mode  and org.jboss.portal.WindowState classes, the main reason being that twose two classes were defined very early before the official Portal API framework was created."
> Actually twose is more like porky pig...  
> Suggest (refactored for length, structure, and deporkification):
> The Portal API package prefix is org.jboss.portal.api.  All of the classes that are part of this API are prefixed with this package name except for the org.jboss.portal.Mode and org.jboss.portal.WindowState classes.  These two classes were defined before the official Portal API framework was created and so the names have been maintained for backward compatibility.

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