Uploaded image for project: 'Java Driver'
  1. Java Driver
  2. JAVA-19

BasicDBList missing javadoc on methods

    XMLWordPrintableJSON

Details

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Minor - P4 Minor - P4
    • 0.8
    • None
    • None
    • None

    Description

      This method is not documented. I assume it is simply a convenience method for setting the index.

      Object put(int key, Object v)

      Why would someone use a string value to specify the index? This is obviously here to support the interface. You may want to specify this in the JavaDocs (i.e., use the int).

      Object put(String key, Object v)
      Put a value at an index.

      Perhaps the example at the top of the class should also include:

      BasicDBList list = new BasicDBList();
      while (something) {
      list.add(new BasicDBObject("foo", "bar"));
      }

      myObj.put("list", list);

      Attachments

        Activity

          People

            kristina Kristina Chodorow (Inactive)
            rn@deftlabs.com Ryan Nitz
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: