Details
-
Bug
-
Status: Closed
-
Normal
-
Resolution: Fixed
-
2.26.09
-
None
-
None
Description
The following class: Mount
Has a method: getContentPath()
That has incorrect javadoc.
The javadoc states that this method will never return null, but when a mount does not have a contentPath then null is returned.
Solution1: update javadoc that it will return null when no contentPath is set
Solution2: return an empty string instead of null (also update javadoc) - this is more preferable because of regression
Its about the following code piece:
/**
- <p>
- Returns the content path for this
{@link Mount} object. The content path is the absolute jcr path to the root site node content, for example
* something like '/content/documents/myproject'. The {@link #getContentPath()} can be the same as {@link #getMountPoint()}, but
* this is in general only for {@link Mount}'s that have
{@link #isMapped()} returning false. When the {@link Mount} does have
* {@link #isMapped()}equal to true, the
{@link #getContentPath()}can return a different path than
{@link #getMountPoint()}.
- </p>
* - @return the content path for this
{@link Mount}
. It cannot be <code>null</code>
*/
String getContentPath();