[ 
https://issues.apache.org/jira/browse/OAK-801?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Lukas Eder updated OAK-801:
---------------------------

    Description: 
When browsing code, I was surprised to find a factory method 
JsonObject.create(JsopTokenizer), which operates on a tokenizer that is 
expected to be in some post-initialisation state. I.e. the following doesn't 
work:

{code}
JsonObject.create(new JsopTokenizer("{}"));
{code}

This does:

{code}
JsonObject.create(new JsopTokenizer("}"));
{code}

I understand that the goal of this method is to be used in larger JSON parsing 
contexts, where JsopTokenizer has already consumed a '{'. Since JsonObject is 
public and OSGi-exported, I think this method deserves at least some Javadoc.

It might be better, of course, to provide a more predictable / reusable API.

  was:
When browsing code, I was surprised to find a factory method 
JsonObject.create(JsopTokenizer), which operates on a tokenizer that is 
expected to be in some post-initialisation state. I.e. the following doesn't 
work:

    JsonObject.create(new JsopTokenizer("{}"));

This does:

    JsonObject.create(new JsopTokenizer("}"));

I understand that the goal of this method is to be used in larger JSON parsing 
contexts, where JsopTokenizer has already consumed a '{'. Since JsonObject is 
public and OSGi-exported, I think this method deserves at least some Javadoc.

It might be better, of course, to provide a more predictable / reusable API.

    
> Add Javadoc to JsonObject.create(JsopTokenizer)
> -----------------------------------------------
>
>                 Key: OAK-801
>                 URL: https://issues.apache.org/jira/browse/OAK-801
>             Project: Jackrabbit Oak
>          Issue Type: Improvement
>          Components: mk
>    Affects Versions: 0.7
>            Reporter: Lukas Eder
>            Priority: Trivial
>
> When browsing code, I was surprised to find a factory method 
> JsonObject.create(JsopTokenizer), which operates on a tokenizer that is 
> expected to be in some post-initialisation state. I.e. the following doesn't 
> work:
> {code}
> JsonObject.create(new JsopTokenizer("{}"));
> {code}
> This does:
> {code}
> JsonObject.create(new JsopTokenizer("}"));
> {code}
> I understand that the goal of this method is to be used in larger JSON 
> parsing contexts, where JsopTokenizer has already consumed a '{'. Since 
> JsonObject is public and OSGi-exported, I think this method deserves at least 
> some Javadoc.
> It might be better, of course, to provide a more predictable / reusable API.

--
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

Reply via email to