QDox
  1. QDox
  2. QDOX-44

Expose the NamedParameter map via a public accessor

    Details

    • Type: Improvement Improvement
    • Status: Closed Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 1.3
    • Fix Version/s: 1.4
    • Component/s: Java API
    • Labels:
      None
    • Number of attachments :
      0

      Description

      The DocletTag interface exposes the parameters for an entity, but not the namedParameter map:

      String[] getParameters();

      The interface allows access to the parameters, as long as you know its name:

      String getNamedParameter(String key);

      It would be useful to expose the namedParameter map in the interface as well so developers that want to abstract qdox don't have to recreate the map themselves:

      Map getNamedParameterMap();

        Activity

        Hide
        Mike Williams added a comment -

        Sounds like a good idea to me.

        Any objections?

        Show
        Mike Williams added a comment - Sounds like a good idea to me. Any objections?
        Mike Williams made changes -
        Field Original Value New Value
        Assignee Mike Williams [ mdub ]
        Fix Version/s 1.4 [ 10304 ]
        Description The DocletTag interface exposes the parameters for an entity, but not the namedParameter map:

            String[] getParameters();

        The interface allows access to the parameters, as long as you know its name:

            String getNamedParameter(String key);

        It would be useful to expose the namedParameter map in the interface as well so developers that want to abstract qdox don't have to recreate the map themselves:

            Map getNamedParameterMap();
        The DocletTag interface exposes the parameters for an entity, but not the namedParameter map:

            String[] getParameters();

        The interface allows access to the parameters, as long as you know its name:

            String getNamedParameter(String key);

        It would be useful to expose the namedParameter map in the interface as well so developers that want to abstract qdox don't have to recreate the map themselves:

            Map getNamedParameterMap();
        Hide
        Mike Williams added a comment -

        Done.

        This is a change to the DocletTag interface, so there's a chance that existing user code may need to change. However, I suspect that most DocletTag implentations will extend DefaultDocletTag; XDoclet's does, anyway.

        Show
        Mike Williams added a comment - Done. This is a change to the DocletTag interface, so there's a chance that existing user code may need to change. However, I suspect that most DocletTag implentations will extend DefaultDocletTag; XDoclet's does, anyway.
        Mike Williams made changes -
        Resolution Fixed [ 1 ]
        Status Open [ 1 ] Resolved [ 5 ]
        Hide
        Mike Williams added a comment -

        Close old resolved issues.

        Show
        Mike Williams added a comment - Close old resolved issues.
        Mike Williams made changes -
        Status Resolved [ 5 ] Closed [ 6 ]

          People

          • Assignee:
            Mike Williams
            Reporter:
            Jim Cook
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: