Skip to content

Migrates more ToXContentClasses #26321

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
colings86 merged 6 commits into from
Aug 23, 2017
Merged

Migrates more ToXContentClasses #26321

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f4731d3
More XContent migrations
colings86 Aug 16, 2017
7dd4bfa
Removes ToXContentToBytes
colings86 Aug 22, 2017
8b39d20
Adds toString to classes that used to extend ToXContentToBytes
colings86 Aug 22, 2017
e14c83e
use XContentHelper
colings86 Aug 22, 2017
e32a3a5
more review comments
colings86 Aug 22, 2017
d000aa2
prettify tostring output
colings86 Aug 22, 2017
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
16 changes: 14 additions & 2 deletions core/src/main/java/org/elasticsearch/action/admin/indices/recovery/RecoveryResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,15 @@

package org.elasticsearch.action.admin.indices.recovery;

import org.elasticsearch.ElasticsearchException;
import org.elasticsearch.action.ShardOperationFailedException;
import org.elasticsearch.action.support.broadcast.BroadcastResponse;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.common.xcontent.ToXContent;
import org.elasticsearch.common.xcontent.ToXContentFragment;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.common.xcontent.XContentHelper;
import org.elasticsearch.common.xcontent.XContentType;
import org.elasticsearch.indices.recovery.RecoveryState;

import java.io.IOException;
Expand All @@ -36,7 +39,7 @@
/**
* Information regarding the recovery state of indices and their associated shards.
*/
public class RecoveryResponse extends BroadcastResponse implements ToXContent {
public class RecoveryResponse extends BroadcastResponse implements ToXContentFragment {

private boolean detailed = false;
private Map<String, List<RecoveryState>> shardRecoveryStates = new HashMap<>();
Expand Down Expand Up @@ -126,4 +129,13 @@ public void readFrom(StreamInput in) throws IOException {
shardRecoveryStates.put(s, list);
}
}

@Override
public String toString() {
try {
return XContentHelper.toXContent(this, XContentType.JSON, true).utf8ToString();
Copy link
Member

@javanna javanna Aug 22, 2017

Choose a reason for hiding this comment

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

Strings.toString already catches IOException. there is a variant of it where you can pass in pretty and himanReadable flags.

} catch (IOException e) {
throw new ElasticsearchException(e);
}
}
}
4 changes: 2 additions & 2 deletions core/src/main/java/org/elasticsearch/action/ingest/SimulateDocumentResult.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
package org.elasticsearch.action.ingest;

import org.elasticsearch.common.io.stream.Writeable;
import org.elasticsearch.common.xcontent.ToXContent;
import org.elasticsearch.common.xcontent.ToXContentObject;

public interface SimulateDocumentResult extends Writeable, ToXContent {
public interface SimulateDocumentResult extends Writeable, ToXContentObject {

}
1 change: 1 addition & 0 deletions core/src/main/java/org/elasticsearch/action/search/SearchRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,7 @@ public String getDescription() {
sb.append("], ");
sb.append("search_type[").append(searchType).append("], ");
if (source != null) {

sb.append("source[").append(source.toString(FORMAT_PARAMS)).append("]");
} else {
sb.append("source[]");
Expand Down
88 changes: 0 additions & 88 deletions core/src/main/java/org/elasticsearch/action/support/ToXContentToBytes.java
View file
Open in desktop

This file was deleted.

3 changes: 1 addition & 2 deletions core/src/main/java/org/elasticsearch/cluster/ClusterState.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.common.xcontent.ToXContent;
import org.elasticsearch.common.xcontent.ToXContentFragment;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.common.xcontent.XContentHelper;
Expand Down Expand Up @@ -91,7 +90,7 @@ public class ClusterState implements ToXContentFragment, Diffable<ClusterState>

public static final ClusterState EMPTY_STATE = builder(ClusterName.CLUSTER_NAME_SETTING.getDefault(Settings.EMPTY)).build();

public interface Custom extends NamedDiffable<Custom>, ToXContent {
public interface Custom extends NamedDiffable<Custom>, ToXContentFragment {

/**
* Returns <code>true</code> iff this {@link Custom} is private to the cluster and should never be send to a client.
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/org/elasticsearch/cluster/metadata/MetaData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ public enum XContentContext {
*/
public static EnumSet<XContentContext> ALL_CONTEXTS = EnumSet.allOf(XContentContext.class);

public interface Custom extends NamedDiffable<Custom>, ToXContent {
public interface Custom extends NamedDiffable<Custom>, ToXContentFragment {

EnumSet<XContentContext> context();
}
Expand Down
4 changes: 2 additions & 2 deletions ...src/main/java/org/elasticsearch/cluster/routing/allocation/command/AllocationCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import org.elasticsearch.cluster.routing.allocation.RoutingAllocation;
import org.elasticsearch.common.io.stream.NamedWriteable;
import org.elasticsearch.common.network.NetworkModule;
import org.elasticsearch.common.xcontent.ToXContent;
import org.elasticsearch.common.xcontent.ToXContentObject;
import org.elasticsearch.common.xcontent.XContentParser;

import java.io.IOException;
Expand All @@ -34,7 +34,7 @@
*
* Commands are registered in {@link NetworkModule}.
*/
public interface AllocationCommand extends NamedWriteable, ToXContent {
public interface AllocationCommand extends NamedWriteable, ToXContentObject {
interface Parser<T extends AllocationCommand> {
/**
* Reads an {@link AllocationCommand} of type <code>T</code> from a {@link XContentParser}.
Expand Down
16 changes: 14 additions & 2 deletions ...rc/main/java/org/elasticsearch/cluster/routing/allocation/command/AllocationCommands.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,17 @@

package org.elasticsearch.cluster.routing.allocation.command;

import org.elasticsearch.ElasticsearchException;
import org.elasticsearch.ElasticsearchParseException;
import org.elasticsearch.action.support.ToXContentToBytes;
import org.elasticsearch.cluster.routing.allocation.RoutingAllocation;
import org.elasticsearch.cluster.routing.allocation.RoutingExplanations;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.common.xcontent.ToXContentFragment;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.common.xcontent.XContentHelper;
import org.elasticsearch.common.xcontent.XContentParser;
import org.elasticsearch.common.xcontent.XContentType;

import java.io.IOException;
import java.util.ArrayList;
Expand All @@ -38,7 +41,7 @@
* A simple {@link AllocationCommand} composite managing several
* {@link AllocationCommand} implementations
*/
public class AllocationCommands extends ToXContentToBytes {
public class AllocationCommands implements ToXContentFragment {
private final List<AllocationCommand> commands = new ArrayList<>();

/**
Expand Down Expand Up @@ -196,4 +199,13 @@ public int hashCode() {
// Override equals and hashCode for testing
return Objects.hashCode(commands);
}

@Override
public String toString() {
try {
return XContentHelper.toXContent(this, XContentType.JSON, true).utf8ToString();
} catch (IOException e) {
throw new ElasticsearchException(e);
}
}
}
15 changes: 13 additions & 2 deletions core/src/main/java/org/elasticsearch/common/geo/builders/ShapeBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@

import org.apache.logging.log4j.Logger;
import org.elasticsearch.Assertions;
import org.elasticsearch.ElasticsearchException;
import org.elasticsearch.ElasticsearchParseException;
import org.elasticsearch.action.support.ToXContentToBytes;
import org.elasticsearch.common.io.stream.NamedWriteable;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
Expand All @@ -35,7 +35,9 @@
import org.elasticsearch.common.xcontent.ToXContentObject;
import org.elasticsearch.common.xcontent.XContent;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.common.xcontent.XContentHelper;
import org.elasticsearch.common.xcontent.XContentParser;
import org.elasticsearch.common.xcontent.XContentType;
import org.elasticsearch.index.mapper.GeoShapeFieldMapper;
import org.locationtech.spatial4j.context.jts.JtsSpatialContext;
import org.locationtech.spatial4j.exception.InvalidShapeException;
Expand All @@ -52,7 +54,7 @@
/**
* Basic class for building GeoJSON shapes like Polygons, Linestrings, etc
*/
public abstract class ShapeBuilder extends ToXContentToBytes implements NamedWriteable {
public abstract class ShapeBuilder implements NamedWriteable, ToXContentObject {

protected static final Logger LOGGER = ESLoggerFactory.getLogger(ShapeBuilder.class.getName());

Expand Down Expand Up @@ -708,4 +710,13 @@ protected static GeometryCollectionBuilder parseGeometries(XContentParser parser
public String getWriteableName() {
return type().shapeName();
}

@Override
public String toString() {
try {
return XContentHelper.toXContent(this, XContentType.JSON, true).utf8ToString();
} catch (IOException e) {
throw new ElasticsearchException(e);
}
}
}
14 changes: 12 additions & 2 deletions core/src/main/java/org/elasticsearch/common/settings/Setting.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
import org.apache.logging.log4j.Logger;
import org.elasticsearch.ElasticsearchException;
import org.elasticsearch.ElasticsearchParseException;
import org.elasticsearch.action.support.ToXContentToBytes;
import org.elasticsearch.common.Booleans;
import org.elasticsearch.common.Nullable;
import org.elasticsearch.common.Strings;
Expand All @@ -31,8 +30,10 @@
import org.elasticsearch.common.unit.MemorySizeValue;
import org.elasticsearch.common.unit.TimeValue;
import org.elasticsearch.common.xcontent.NamedXContentRegistry;
import org.elasticsearch.common.xcontent.ToXContentObject;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.common.xcontent.XContentFactory;
import org.elasticsearch.common.xcontent.XContentHelper;
import org.elasticsearch.common.xcontent.XContentParser;
import org.elasticsearch.common.xcontent.XContentType;

Expand Down Expand Up @@ -78,7 +79,7 @@
* }
* </pre>
*/
public class Setting<T> extends ToXContentToBytes {
public class Setting<T> implements ToXContentObject {

public enum Property {
/**
Expand Down Expand Up @@ -425,6 +426,15 @@ public final XContentBuilder toXContent(XContentBuilder builder, Params params)
return builder;
}

@Override
public String toString() {
try {
return XContentHelper.toXContent(this, XContentType.JSON, true).utf8ToString();
} catch (IOException e) {
throw new ElasticsearchException(e);
}
}

/**
* Returns the value for this setting but falls back to the second provided settings object
*/
Expand Down
16 changes: 14 additions & 2 deletions core/src/main/java/org/elasticsearch/index/query/InnerHitBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,19 @@
*/
package org.elasticsearch.index.query;

import org.elasticsearch.ElasticsearchException;
import org.elasticsearch.Version;
import org.elasticsearch.action.support.ToXContentToBytes;
import org.elasticsearch.common.ParseField;
import org.elasticsearch.common.ParsingException;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.common.io.stream.Writeable;
import org.elasticsearch.common.xcontent.ObjectParser;
import org.elasticsearch.common.xcontent.ToXContentObject;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.common.xcontent.XContentHelper;
import org.elasticsearch.common.xcontent.XContentParser;
import org.elasticsearch.common.xcontent.XContentType;
import org.elasticsearch.script.Script;
import org.elasticsearch.search.builder.SearchSourceBuilder;
import org.elasticsearch.search.builder.SearchSourceBuilder.ScriptField;
Expand All @@ -47,7 +50,7 @@

import static org.elasticsearch.common.xcontent.XContentParser.Token.END_OBJECT;

public final class InnerHitBuilder extends ToXContentToBytes implements Writeable {
public final class InnerHitBuilder implements Writeable, ToXContentObject {
Copy link
Member

@javanna javanna Aug 22, 2017

Choose a reason for hiding this comment

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

should we add toString impl to this class now that it doesn't inherit anymore from ToXContentToBytes?

Copy link
Member

@javanna javanna Aug 22, 2017

Choose a reason for hiding this comment

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

this applies to all the classes that don't extend from ToXCOntentToBytes anymore and don't declare their own toString .


public static final ParseField NAME_FIELD = new ParseField("name");
public static final ParseField IGNORE_UNMAPPED = new ParseField("ignore_unmapped");
Expand Down Expand Up @@ -544,4 +547,13 @@ public int hashCode() {
public static InnerHitBuilder fromXContent(XContentParser parser) throws IOException {
return PARSER.parse(parser, new InnerHitBuilder(), null);
}

@Override
public String toString() {
try {
return XContentHelper.toXContent(this, XContentType.JSON, true).utf8ToString();
} catch (IOException e) {
throw new ElasticsearchException(e);
}
}
}
Loading