[HBASE-21243] Correct java-doc for the method RpcServer.getRemoteAddress()

• Type: Improvement
• Status: Resolved
• Priority: Trivial
• Resolution: Fixed
• Affects Version/s: 3.0.0-alpha-1, 2.0.0
• Fix Version/s: 2.6.0, 2.4.18, 3.0.0-beta-1, 2.5.8
• Labels: beginner beginners documentaion
• Hadoop Flags: Reviewed
• Assignee: Nihal Jain
• Reporter: Nihal Jain
• Created: 27/Sep/18 09:16
• Updated: 17/Dec/23 20:04
• Resolved: 16/Dec/23 13:36

Description

Correct the java-doc for the method RpcServer.getRemoteAddress().
Currently it look like as below:

  /**
   * @return Address of remote client if a request is ongoing, else null
   */
  public static Optional<InetAddress> getRemoteAddress() {
    return getCurrentCall().map(RpcCall::getRemoteAddress);
  }

Contrary to the doc the method will never return null. Rather it may return an empty Optional.