Skip to content

Remove Booleans use from XContent and ToXContent #28768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Mar 9, 2018
Merged

Remove Booleans use from XContent and ToXContent #28768

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3e5b46f
Remove Booleans use from XContent and ToXContent
dakrone Feb 21, 2018
5c6d545
Fix incorrect parameter retrieval
dakrone Feb 21, 2018
429f6a4
Use a small helper rather than duplicating code three times
dakrone Mar 8, 2018
3dda9a7
Merge remote-tracking branch 'origin/master' into xc-remove-booleans
dakrone Mar 8, 2018
fd0c6eb
Small javadoc tweak
dakrone Mar 8, 2018
e4bd246
Factor boolean parsing into separate package-private class
dakrone Mar 9, 2018
660997e
Merge remote-tracking branch 'origin/master' into xc-remove-booleans
dakrone Mar 9, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 22 additions & 4 deletions server/src/main/java/org/elasticsearch/common/xcontent/ToXContent.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@

package org.elasticsearch.common.xcontent;

import org.elasticsearch.common.Booleans;

import java.io.IOException;
import java.util.Map;

Expand Down Expand Up @@ -88,12 +86,12 @@ public String param(String key, String defaultValue) {

@Override
public boolean paramAsBoolean(String key, boolean defaultValue) {
return Booleans.parseBoolean(param(key), defaultValue);
return parseBoolean(param(key), defaultValue);
}

@Override
public Boolean paramAsBoolean(String key, Boolean defaultValue) {
return Booleans.parseBoolean(param(key), defaultValue);
return parseBoolean(param(key), defaultValue);
}
}

Expand Down Expand Up @@ -132,4 +130,24 @@ public Boolean paramAsBoolean(String key, Boolean defaultValue) {
default boolean isFragment() {
return true;
}

/**
* Parse {@code value} with values "true", "false", or null, returning the
* default value if null or the empty string is used. Any other input
* results in an {@link IllegalArgumentException} being thrown.
*/
static boolean parseBoolean(String value, Boolean defaultValue) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you move this to a package-visible class named Booleans? There is no confusion with the other Booleans because of package visibility. It does not make sense on this class, it does not make sense on the other class, and the name will help for ease of finding in the future if needed.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Certainly, I'll do that.

if (value != null && value.length() > 0) {
switch (value) {
case "true":
return true;
case "false":
return false;
default:
throw new IllegalArgumentException("Failed to parse param [" + value + "] as only [true] or [false] are allowed.");
}
} else {
return defaultValue;
}
}
}
4 changes: 1 addition & 3 deletions server/src/main/java/org/elasticsearch/common/xcontent/XContent.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@

package org.elasticsearch.common.xcontent;

import org.elasticsearch.common.Booleans;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
Expand Down Expand Up @@ -51,7 +49,7 @@ public interface XContent {
*/
static boolean isStrictDuplicateDetectionEnabled() {
// Don't allow duplicate keys in JSON content by default but let the user opt out
return Booleans.parseBoolean(System.getProperty("es.xcontent.strict_duplicate_detection", "true"));
return ToXContent.parseBoolean(System.getProperty("es.xcontent.strict_duplicate_detection", "true"), true);
}

/**
Expand Down