ok2c commented on a change in pull request #299:
URL:
https://github.com/apache/httpcomponents-core/pull/299#discussion_r724446893
##########
File path: httpcore5/src/main/java/org/apache/hc/core5/net/URIBuilder.java
##########
@@ -98,47 +98,59 @@ public URIBuilder() {
}
/**
- * Construct an instance from the string which must be a valid URI.
+ * Constructs an instance from the string which must be a valid URI.
*
- * @param string a valid URI in string form
- * @throws URISyntaxException if the input is not a valid URI
+ * @param uriString a valid URI in string form.
+ * @throws URISyntaxException if the input is not a valid URI.
*/
- public URIBuilder(final String string) throws URISyntaxException {
- this(new URI(string), StandardCharsets.UTF_8);
+ public URIBuilder(final String uriString) throws URISyntaxException {
+ this(new URI(uriString), StandardCharsets.UTF_8);
}
/**
- * Construct an instance from the provided URI.
- * @param uri
+ * Constructs an instance from the provided URI.
+ * @param uri a URI.
*/
public URIBuilder(final URI uri) {
this(uri, StandardCharsets.UTF_8);
}
/**
- * Construct an instance from the string which must be a valid URI.
+ * Constructs an instance from the string which must be a valid URI.
*
- * @param string a valid URI in string form
+ * @param uriString a valid URI in string form.
* @throws URISyntaxException if the input is not a valid URI
*/
- public URIBuilder(final String string, final Charset charset) throws
URISyntaxException {
- this(new URI(string), charset);
+ public URIBuilder(final String uriString, final Charset charset) throws
URISyntaxException {
+ this(new URI(uriString), charset);
}
/**
- * Construct an instance from the provided URI.
- * @param uri
+ * Constructs an instance from the provided URI.
+ *
+ * @param uri a URI.
*/
public URIBuilder(final URI uri, final Charset charset) {
super();
digestURI(uri, charset);
}
+ /**
+ * Sets the Charset.
+ *
+ * @param charset the Charset.
+ * @return this.
+ */
public URIBuilder setCharset(final Charset charset) {
this.charset = charset;
return this;
}
+ /**
+ * Gets the Charset.
Review comment:
@garydgregory I personally do not find such javadocs super useful, but I
will not stand in your way should you choose to keep them. Looks good otherwise.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
