Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8255594

Javadoc clean up in HttpHandler, HttpPrincipal, HttpContext, and HttpsConfigurator

    XMLWordPrintable

Details

    • CSR
    • Status: Closed
    • P4
    • Resolution: Approved
    • 16
    • core-libs
    • source
    • minimal
    • Documentation updated to inform user of the pre-existing behavior of method within class.
    • Java API
    • JDK

    Description

      Summary

      In the specification for com.sun.net.httpserver.HttpPrincipal the @param tag is missing for the equals method's sole parameter, i.e. Object another.

      Problem

      Currently, the equals method for HttpPrincipal does not not specify that it takes a parameter.

      Solution

      Add in an @param tag along with the parameter name and description to inform the user of its use.

      Specification

        /**
         * Compare two instances of {@code HttpPrincipal}. Returns {@code true} if
         * <i>another</i> is an instance of {@code HttpPrincipal}, and its username
         * and realm are equal to this object's username and realm. Returns {@code false}
         * otherwise.
         *
      +  * @param another the object to compare this instance of {@code HttpPrincipal} against
         * @return {@code true} or {@code false} depending on whether objects are
         * equal or not
         */
        public boolean equals(Object another) {

      Attachments

        Issue Links

          Activity

            People

              pconcannon Patrick Concannon (Inactive)
              pconcannon Patrick Concannon (Inactive)
              Daniel Fuchs
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: