[jira] [Created] (OAK-553) Add NameMapper#getValidOakName that never returns null

["angela (JIRA)" <ji...@apache.org>]

angela created OAK-553:
--------------------------

             Summary: Add NameMapper#getValidOakName that never returns null
                 Key: OAK-553
                 URL: https://issues.apache.org/jira/browse/OAK-553
             Project: Jackrabbit Oak
          Issue Type: Improvement
          Components: core
            Reporter: angela


we keep adding methods that convert a jcrName into an oak-name
and throw an exception if the value returned by NameMapper#getOakName is
null. instead of duplicating code i would like to add a second flavor
of the method that throws if the the jcrName cannot be resolved to an oak
name.

i even suspect that most usages of the getOakName call that don't throw
in case of null-value are susceptible to NPE. but we can still review those
and possible replace them with the save method call.

proposed patch for the interface:
{code}
/**
     * Returns the Oak name for the specified JCR name. In contrast to
     * {@link #getOakName(String)} this method will throw a {@code NamespaceException}
     * if the JCR name is invalid and cannot be resolved.
     *
     * @param jcrName The JCR name to be converted.
     * @return A valid Oak name.
     * @throws NamespaceException If the JCR name cannot be resolved.
     */
    @Nonnull
    String getValidOakName(@Nonnull String jcrName) throws NamespaceException;
{code}

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira