From a03013ea25db12573f94edc0593c24107291c722 Mon Sep 17 00:00:00 2001 From: Alexander Reelsen Date: Mon, 7 Oct 2013 10:35:34 +0200 Subject: [PATCH] Remove @Required annotation The @Required annotation is used for documentation purposes only anyway. --- .../mapping/put/PutMappingRequest.java | 5 --- .../mapping/put/PutMappingRequestBuilder.java | 2 -- .../validate/query/ValidateQueryRequest.java | 8 ----- .../action/count/CountRequest.java | 8 ----- .../action/delete/DeleteRequest.java | 3 -- .../deletebyquery/DeleteByQueryRequest.java | 7 ---- .../elasticsearch/action/get/GetRequest.java | 2 -- .../action/index/IndexRequest.java | 13 ------- .../action/mlt/MoreLikeThisRequest.java | 3 -- .../org/elasticsearch/common/Required.java | 35 ------------------- 10 files changed, 86 deletions(-) delete mode 100644 src/main/java/org/elasticsearch/common/Required.java diff --git a/src/main/java/org/elasticsearch/action/admin/indices/mapping/put/PutMappingRequest.java b/src/main/java/org/elasticsearch/action/admin/indices/mapping/put/PutMappingRequest.java index 6600a3f2327..8433f406434 100644 --- a/src/main/java/org/elasticsearch/action/admin/indices/mapping/put/PutMappingRequest.java +++ b/src/main/java/org/elasticsearch/action/admin/indices/mapping/put/PutMappingRequest.java @@ -23,7 +23,6 @@ import org.elasticsearch.ElasticSearchGenerationException; import org.elasticsearch.ElasticSearchIllegalArgumentException; import org.elasticsearch.action.ActionRequestValidationException; import org.elasticsearch.action.support.master.MasterNodeOperationRequest; -import org.elasticsearch.common.Required; import org.elasticsearch.common.Strings; import org.elasticsearch.common.io.stream.StreamInput; import org.elasticsearch.common.io.stream.StreamOutput; @@ -111,7 +110,6 @@ public class PutMappingRequest extends MasterNodeOperationRequest { * * @see org.elasticsearch.index.query.QueryBuilders */ - @Required public CountRequest query(QueryBuilder queryBuilder) { this.querySource = queryBuilder.buildAsBytes(); this.querySourceUnsafe = false; @@ -135,7 +133,6 @@ public class CountRequest extends BroadcastOperationRequest { /** * The query source to execute in the form of a map. */ - @Required public CountRequest query(Map querySource) { try { XContentBuilder builder = XContentFactory.contentBuilder(contentType); @@ -146,7 +143,6 @@ public class CountRequest extends BroadcastOperationRequest { } } - @Required public CountRequest query(XContentBuilder builder) { this.querySource = builder.bytes(); this.querySourceUnsafe = false; @@ -157,7 +153,6 @@ public class CountRequest extends BroadcastOperationRequest { * The query source to execute. It is preferable to use either {@link #query(byte[])} * or {@link #query(org.elasticsearch.index.query.QueryBuilder)}. */ - @Required public CountRequest query(String querySource) { this.querySource = new BytesArray(querySource); this.querySourceUnsafe = false; @@ -167,7 +162,6 @@ public class CountRequest extends BroadcastOperationRequest { /** * The query source to execute. */ - @Required public CountRequest query(byte[] querySource) { return query(querySource, 0, querySource.length, false); } @@ -175,12 +169,10 @@ public class CountRequest extends BroadcastOperationRequest { /** * The query source to execute. */ - @Required public CountRequest query(byte[] querySource, int offset, int length, boolean unsafe) { return query(new BytesArray(querySource, offset, length), unsafe); } - @Required public CountRequest query(BytesReference querySource, boolean unsafe) { this.querySource = querySource; this.querySourceUnsafe = unsafe; diff --git a/src/main/java/org/elasticsearch/action/delete/DeleteRequest.java b/src/main/java/org/elasticsearch/action/delete/DeleteRequest.java index 6cc6ec20a6f..87a10f3e544 100644 --- a/src/main/java/org/elasticsearch/action/delete/DeleteRequest.java +++ b/src/main/java/org/elasticsearch/action/delete/DeleteRequest.java @@ -22,7 +22,6 @@ package org.elasticsearch.action.delete; import org.elasticsearch.action.ActionRequestValidationException; import org.elasticsearch.action.support.replication.ShardReplicationOperationRequest; import org.elasticsearch.common.Nullable; -import org.elasticsearch.common.Required; import org.elasticsearch.common.io.stream.StreamInput; import org.elasticsearch.common.io.stream.StreamOutput; import org.elasticsearch.index.VersionType; @@ -108,7 +107,6 @@ public class DeleteRequest extends ShardReplicationOperationRequest { /** * Sets the id of the document to fetch. */ - @Required public GetRequest id(String id) { this.id = id; return this; diff --git a/src/main/java/org/elasticsearch/action/index/IndexRequest.java b/src/main/java/org/elasticsearch/action/index/IndexRequest.java index d31fe364dba..4b36970b0f2 100644 --- a/src/main/java/org/elasticsearch/action/index/IndexRequest.java +++ b/src/main/java/org/elasticsearch/action/index/IndexRequest.java @@ -31,7 +31,6 @@ import org.elasticsearch.client.Requests; import org.elasticsearch.cluster.metadata.MappingMetaData; import org.elasticsearch.cluster.metadata.MetaData; import org.elasticsearch.common.Nullable; -import org.elasticsearch.common.Required; import org.elasticsearch.common.Strings; import org.elasticsearch.common.bytes.BytesArray; import org.elasticsearch.common.bytes.BytesReference; @@ -208,7 +207,6 @@ public class IndexRequest extends ShardReplicationOperationRequest /** * Sets the type of the indexed document. */ - @Required public IndexRequest type(String type) { this.type = type; return this; @@ -322,7 +320,6 @@ public class IndexRequest extends ShardReplicationOperationRequest * * @param source The map to index */ - @Required public IndexRequest source(Map source) throws ElasticSearchGenerationException { return source(source, contentType); } @@ -332,7 +329,6 @@ public class IndexRequest extends ShardReplicationOperationRequest * * @param source The map to index */ - @Required public IndexRequest source(Map source, XContentType contentType) throws ElasticSearchGenerationException { try { XContentBuilder builder = XContentFactory.contentBuilder(contentType); @@ -349,7 +345,6 @@ public class IndexRequest extends ShardReplicationOperationRequest *

Note, its preferable to either set it using {@link #source(org.elasticsearch.common.xcontent.XContentBuilder)} * or using the {@link #source(byte[])}. */ - @Required public IndexRequest source(String source) { this.source = new BytesArray(source.getBytes(Charsets.UTF_8)); this.sourceUnsafe = false; @@ -359,14 +354,12 @@ public class IndexRequest extends ShardReplicationOperationRequest /** * Sets the content source to index. */ - @Required public IndexRequest source(XContentBuilder sourceBuilder) { source = sourceBuilder.bytes(); sourceUnsafe = false; return this; } - @Required public IndexRequest source(String field1, Object value1) { try { XContentBuilder builder = XContentFactory.contentBuilder(contentType); @@ -377,7 +370,6 @@ public class IndexRequest extends ShardReplicationOperationRequest } } - @Required public IndexRequest source(String field1, Object value1, String field2, Object value2) { try { XContentBuilder builder = XContentFactory.contentBuilder(contentType); @@ -388,7 +380,6 @@ public class IndexRequest extends ShardReplicationOperationRequest } } - @Required public IndexRequest source(String field1, Object value1, String field2, Object value2, String field3, Object value3) { try { XContentBuilder builder = XContentFactory.contentBuilder(contentType); @@ -399,7 +390,6 @@ public class IndexRequest extends ShardReplicationOperationRequest } } - @Required public IndexRequest source(String field1, Object value1, String field2, Object value2, String field3, Object value3, String field4, Object value4) { try { XContentBuilder builder = XContentFactory.contentBuilder(contentType); @@ -410,7 +400,6 @@ public class IndexRequest extends ShardReplicationOperationRequest } } - @Required public IndexRequest source(Object... source) { try { XContentBuilder builder = XContentFactory.contentBuilder(contentType); @@ -449,7 +438,6 @@ public class IndexRequest extends ShardReplicationOperationRequest * @param offset The offset in the byte array * @param length The length of the data */ - @Required public IndexRequest source(byte[] source, int offset, int length) { return source(source, offset, length, false); } @@ -462,7 +450,6 @@ public class IndexRequest extends ShardReplicationOperationRequest * @param length The length of the data * @param unsafe Is the byte array safe to be used form a different thread */ - @Required public IndexRequest source(byte[] source, int offset, int length, boolean unsafe) { this.source = new BytesArray(source, offset, length); this.sourceUnsafe = unsafe; diff --git a/src/main/java/org/elasticsearch/action/mlt/MoreLikeThisRequest.java b/src/main/java/org/elasticsearch/action/mlt/MoreLikeThisRequest.java index 9affa0d1f0b..5065c58c1b1 100644 --- a/src/main/java/org/elasticsearch/action/mlt/MoreLikeThisRequest.java +++ b/src/main/java/org/elasticsearch/action/mlt/MoreLikeThisRequest.java @@ -27,7 +27,6 @@ import org.elasticsearch.action.ActionRequestValidationException; import org.elasticsearch.action.ValidateActions; import org.elasticsearch.action.search.SearchType; import org.elasticsearch.client.Requests; -import org.elasticsearch.common.Required; import org.elasticsearch.common.Strings; import org.elasticsearch.common.bytes.BytesArray; import org.elasticsearch.common.bytes.BytesReference; @@ -121,7 +120,6 @@ public class MoreLikeThisRequest extends ActionRequest { /** * The type of document to load from which the "like" query will execute with. */ - @Required public MoreLikeThisRequest type(String type) { this.type = type; return this; @@ -137,7 +135,6 @@ public class MoreLikeThisRequest extends ActionRequest { /** * The id of document to load from which the "like" query will execute with. */ - @Required public MoreLikeThisRequest id(String id) { this.id = id; return this; diff --git a/src/main/java/org/elasticsearch/common/Required.java b/src/main/java/org/elasticsearch/common/Required.java deleted file mode 100644 index c28807c8933..00000000000 --- a/src/main/java/org/elasticsearch/common/Required.java +++ /dev/null @@ -1,35 +0,0 @@ -/* - * Licensed to ElasticSearch and Shay Banon under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. ElasticSearch licenses this - * file to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ - -package org.elasticsearch.common; - -import java.lang.annotation.*; - -/** - * The presence of this annotation on a method parameter indicates that - * {@code null} is an acceptable value for that parameter. It should not be - * used for parameters of primitive types. - * - * - */ -@Documented -@Retention(RetentionPolicy.RUNTIME) -@Target({ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD}) -public @interface Required { -} \ No newline at end of file