Repository: tez Updated Branches: refs/heads/master 373793b01 -> 4842c3a67
TEZ-1436. Fix javadoc warnings (Jonathan Eagles via bikas) Project: http://git-wip-us.apache.org/repos/asf/tez/repo Commit: http://git-wip-us.apache.org/repos/asf/tez/commit/4842c3a6 Tree: http://git-wip-us.apache.org/repos/asf/tez/tree/4842c3a6 Diff: http://git-wip-us.apache.org/repos/asf/tez/diff/4842c3a6 Branch: refs/heads/master Commit: 4842c3a6784f8b20c4f62e52dc220c64614e0045 Parents: 373793b Author: Bikas Saha <[email protected]> Authored: Thu Aug 21 13:45:00 2014 -0700 Committer: Bikas Saha <[email protected]> Committed: Thu Aug 21 13:45:00 2014 -0700 ---------------------------------------------------------------------- .../tez/common/security/DAGAccessControls.java | 16 ++++++++-------- .../apache/tez/dag/api/DataSourceDescriptor.java | 2 +- .../src/main/java/org/apache/tez/dag/api/Edge.java | 2 +- .../org/apache/tez/dag/api/EntityDescriptor.java | 3 ++- .../java/org/apache/tez/dag/api/PreWarmVertex.java | 2 +- .../main/java/org/apache/tez/dag/api/Vertex.java | 5 ++++- .../java/org/apache/tez/dag/api/VertexGroup.java | 3 ++- .../org/apache/tez/runtime/api/InputSpecUpdate.java | 4 ++-- .../runtime/api/ProcessorFrameworkInterface.java | 1 - .../org/apache/tez/dag/history/SummaryEvent.java | 2 +- .../apache/tez/mapreduce/hadoop/InputSplitInfo.java | 4 ++-- .../apache/tez/mapreduce/hadoop/MRInputHelpers.java | 2 +- .../tez/runtime/library/common/sort/impl/IFile.java | 5 +++-- .../tez/runtime/library/conf/BaseConfigBuilder.java | 6 +++--- .../library/conf/OrderedGroupedKVInputConfig.java | 6 +++--- .../conf/OrderedPartitionedKVEdgeConfig.java | 4 ++-- .../conf/OrderedPartitionedKVOutputConfig.java | 4 ++-- .../runtime/library/conf/UnorderedKVEdgeConfig.java | 4 ++-- .../library/conf/UnorderedKVInputConfig.java | 4 ++-- .../library/conf/UnorderedKVOutputConfig.java | 4 ++-- .../conf/UnorderedPartitionedKVEdgeConfig.java | 4 ++-- .../conf/UnorderedPartitionedKVOutputConfig.java | 4 ++-- .../library/shuffle/common/HttpConnection.java | 10 ++++++---- 23 files changed, 54 insertions(+), 47 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-api/src/main/java/org/apache/tez/common/security/DAGAccessControls.java ---------------------------------------------------------------------- diff --git a/tez-api/src/main/java/org/apache/tez/common/security/DAGAccessControls.java b/tez-api/src/main/java/org/apache/tez/common/security/DAGAccessControls.java index 1b1e90e..87e08c3 100644 --- a/tez-api/src/main/java/org/apache/tez/common/security/DAGAccessControls.java +++ b/tez-api/src/main/java/org/apache/tez/common/security/DAGAccessControls.java @@ -85,10 +85,10 @@ public class DAGAccessControls { } /** - * Set the list of users that view permissions on the DAG. If all users are allowed, + * Sets the list of users with view permissions on the DAG. If all users are allowed, * pass in a single entry "*" * @param users Set of users with view permissions - * @return + * @return this object for further chained method calls */ public synchronized DAGAccessControls setUsersWithViewACLs(Collection<String> users) { this.usersWithViewACLs.clear(); @@ -97,10 +97,10 @@ public class DAGAccessControls { } /** - * Set the list of users that have modify permissions on the DAG. If all users are allowed, + * Sets the list of users with modify permissions on the DAG. If all users are allowed, * pass in a single entry "*" * @param users Set of users with modify permissions - * @return + * @return this object for further chained method calls */ public synchronized DAGAccessControls setUsersWithModifyACLs(Collection<String> users) { this.usersWithModifyACLs.clear(); @@ -109,9 +109,9 @@ public class DAGAccessControls { } /** - * Set the list of groups that have view permissions on the DAG. + * Sets the list of groups with view permissions on the DAG. * @param groups Set of groups with view permissions - * @return + * @return this object for further chained method calls */ public synchronized DAGAccessControls setGroupsWithViewACLs(Collection<String> groups) { this.groupsWithViewACLs.clear(); @@ -120,9 +120,9 @@ public class DAGAccessControls { } /** - * Set the list of groups that have modify permissions on the DAG. + * Sets the list of groups with modify permissions on the DAG. * @param groups Set of groups with modify permissions - * @return + * @return this object for further chained method calls */ public synchronized DAGAccessControls setGroupsWithModifyACLs(Collection<String> groups) { this.groupsWithModifyACLs.clear(); http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-api/src/main/java/org/apache/tez/dag/api/DataSourceDescriptor.java ---------------------------------------------------------------------- diff --git a/tez-api/src/main/java/org/apache/tez/dag/api/DataSourceDescriptor.java b/tez-api/src/main/java/org/apache/tez/dag/api/DataSourceDescriptor.java index f8e6072..8d03705 100644 --- a/tez-api/src/main/java/org/apache/tez/dag/api/DataSourceDescriptor.java +++ b/tez-api/src/main/java/org/apache/tez/dag/api/DataSourceDescriptor.java @@ -161,7 +161,7 @@ public class DataSourceDescriptor { /** * Get the list of additional local files which were specified during creation. - * @return + * @return Map of additional local files or null if there are none */ @InterfaceAudience.Private public @Nullable Map<String, LocalResource> getAdditionalLocalFiles() { http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-api/src/main/java/org/apache/tez/dag/api/Edge.java ---------------------------------------------------------------------- diff --git a/tez-api/src/main/java/org/apache/tez/dag/api/Edge.java b/tez-api/src/main/java/org/apache/tez/dag/api/Edge.java index 151d0db..e348fa1 100644 --- a/tez-api/src/main/java/org/apache/tez/dag/api/Edge.java +++ b/tez-api/src/main/java/org/apache/tez/dag/api/Edge.java @@ -70,7 +70,7 @@ public class Edge { /** * The @link {@link Vertex} that reads output from the edge - * @retur {@link Vertex} + * @return {@link Vertex} */ public Vertex getOutputVertex() { return outputVertex; http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-api/src/main/java/org/apache/tez/dag/api/EntityDescriptor.java ---------------------------------------------------------------------- diff --git a/tez-api/src/main/java/org/apache/tez/dag/api/EntityDescriptor.java b/tez-api/src/main/java/org/apache/tez/dag/api/EntityDescriptor.java index 6c86207..1ad004f 100644 --- a/tez-api/src/main/java/org/apache/tez/dag/api/EntityDescriptor.java +++ b/tez-api/src/main/java/org/apache/tez/dag/api/EntityDescriptor.java @@ -60,7 +60,7 @@ public abstract class EntityDescriptor<T extends EntityDescriptor<T>> implements /** * Set user payload for this entity descriptor * @param userPayload User Payload - * @return + * @return this object for further chained method calls */ public T setUserPayload(UserPayload userPayload) { Preconditions.checkNotNull(userPayload); @@ -72,6 +72,7 @@ public abstract class EntityDescriptor<T extends EntityDescriptor<T>> implements * Provide a human-readable version of the user payload that can be * used in the History UI * @param historyText History text + * @return this object for further chained method calls */ public T setHistoryText(String historyText) { this.historyText = historyText; http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-api/src/main/java/org/apache/tez/dag/api/PreWarmVertex.java ---------------------------------------------------------------------- diff --git a/tez-api/src/main/java/org/apache/tez/dag/api/PreWarmVertex.java b/tez-api/src/main/java/org/apache/tez/dag/api/PreWarmVertex.java index 4ec553a..62979b5 100644 --- a/tez-api/src/main/java/org/apache/tez/dag/api/PreWarmVertex.java +++ b/tez-api/src/main/java/org/apache/tez/dag/api/PreWarmVertex.java @@ -69,7 +69,7 @@ public class PreWarmVertex extends Vertex { * Create a config builder for the @link {@link PreWarmVertex}. This may be used to construct the * pre-warm vertex more flexibly. * @param conf - * @return + * @return a new config builder for {@link PreWarmVertex} */ public static PreWarmVertexConfigBuilder createConfigBuilder(Configuration conf) { return new PreWarmVertexConfigBuilder(conf); http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-api/src/main/java/org/apache/tez/dag/api/Vertex.java ---------------------------------------------------------------------- diff --git a/tez-api/src/main/java/org/apache/tez/dag/api/Vertex.java b/tez-api/src/main/java/org/apache/tez/dag/api/Vertex.java index 6397c82..1df548a 100644 --- a/tez-api/src/main/java/org/apache/tez/dag/api/Vertex.java +++ b/tez-api/src/main/java/org/apache/tez/dag/api/Vertex.java @@ -121,6 +121,7 @@ public class Vertex { * @param taskResource * Physical resources like memory/cpu thats used by each task of this * vertex. + * @return a new Vertex with the given parameters */ public static Vertex create(String vertexName, ProcessorDescriptor processorDescriptor, @@ -145,6 +146,7 @@ public class Vertex { * @param processorDescriptor * Description of the processor that is executed in every task of * this vertex + * @return a new Vertex with the given parameters */ public static Vertex create(String vertexName, ProcessorDescriptor processorDescriptor) { return new Vertex(vertexName, processorDescriptor); @@ -169,6 +171,7 @@ public class Vertex { * Number of tasks in this vertex. Set to -1 if this is going to be * decided at runtime. Parallelism may change at runtime due to graph * reconfigurations. + * @return a new Vertex with the given parameters */ public static Vertex create(String vertexName, ProcessorDescriptor processorDescriptor, int parallelism) { @@ -186,7 +189,7 @@ public class Vertex { /** * Get the vertex task processor descriptor - * @return + * @return process descriptor */ public ProcessorDescriptor getProcessorDescriptor() { return this.processorDescriptor; http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-api/src/main/java/org/apache/tez/dag/api/VertexGroup.java ---------------------------------------------------------------------- diff --git a/tez-api/src/main/java/org/apache/tez/dag/api/VertexGroup.java b/tez-api/src/main/java/org/apache/tez/dag/api/VertexGroup.java index 0594835..f1887a1 100644 --- a/tez-api/src/main/java/org/apache/tez/dag/api/VertexGroup.java +++ b/tez-api/src/main/java/org/apache/tez/dag/api/VertexGroup.java @@ -89,7 +89,8 @@ public class VertexGroup { /** * Add an common data sink to the group of vertices. - * Refer to {@link Vertex#addDataSink(String, OutputDescriptor, OutputCommitterDescriptor)} + * Refer to {@link Vertex#addDataSink(String, DataSinkDescriptor)} + * @return this object for further chained method calls */ public VertexGroup addDataSink(String outputName, DataSinkDescriptor dataSinkDescriptor) { RootInputLeafOutput<OutputDescriptor, OutputCommitterDescriptor> leafOutput = http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-api/src/main/java/org/apache/tez/runtime/api/InputSpecUpdate.java ---------------------------------------------------------------------- diff --git a/tez-api/src/main/java/org/apache/tez/runtime/api/InputSpecUpdate.java b/tez-api/src/main/java/org/apache/tez/runtime/api/InputSpecUpdate.java index f0d166f..b81f15c 100644 --- a/tez-api/src/main/java/org/apache/tez/runtime/api/InputSpecUpdate.java +++ b/tez-api/src/main/java/org/apache/tez/runtime/api/InputSpecUpdate.java @@ -48,7 +48,7 @@ public class InputSpecUpdate { * * @param numPhysicalInputs * the number of physical inputs for all work units which will use the LogicalInput - * @return + * @return a new InputSpecUpdate instance given the parameters */ public static InputSpecUpdate createAllTaskInputSpecUpdate(int numPhysicalInputs) { return new InputSpecUpdate(numPhysicalInputs); @@ -61,7 +61,7 @@ public class InputSpecUpdate { * @param perWorkUnitNumPhysicalInputs * A list containing one entry per work unit. The order in the list corresponds to task * index or equivalently the order of {@link InputDataInformationEvent}s being sent. - * @return + * @return a new InputSpecUpdate instance given the parameters */ public static InputSpecUpdate createPerTaskInputSpecUpdate( List<Integer> perWorkUnitNumPhysicalInputs) { http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-api/src/main/java/org/apache/tez/runtime/api/ProcessorFrameworkInterface.java ---------------------------------------------------------------------- diff --git a/tez-api/src/main/java/org/apache/tez/runtime/api/ProcessorFrameworkInterface.java b/tez-api/src/main/java/org/apache/tez/runtime/api/ProcessorFrameworkInterface.java index 317ba39..f0ba9c9 100644 --- a/tez-api/src/main/java/org/apache/tez/runtime/api/ProcessorFrameworkInterface.java +++ b/tez-api/src/main/java/org/apache/tez/runtime/api/ProcessorFrameworkInterface.java @@ -36,7 +36,6 @@ public interface ProcessorFrameworkInterface { /** * Initializes the <code>Processor</code> * - * @param processorContext * @throws java.io.IOException * if an error occurs */ http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-dag/src/main/java/org/apache/tez/dag/history/SummaryEvent.java ---------------------------------------------------------------------- diff --git a/tez-dag/src/main/java/org/apache/tez/dag/history/SummaryEvent.java b/tez-dag/src/main/java/org/apache/tez/dag/history/SummaryEvent.java index eaae813..bdbea59 100644 --- a/tez-dag/src/main/java/org/apache/tez/dag/history/SummaryEvent.java +++ b/tez-dag/src/main/java/org/apache/tez/dag/history/SummaryEvent.java @@ -32,7 +32,7 @@ public interface SummaryEvent { /** * Whether to write this event immediately to the DAG recovery file * Summary events are always written immediately to summary file. - * @return + * @return true if event should be written immediately to the DAG recovery file */ public boolean writeToRecoveryImmediately(); http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/hadoop/InputSplitInfo.java ---------------------------------------------------------------------- diff --git a/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/hadoop/InputSplitInfo.java b/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/hadoop/InputSplitInfo.java index 15fe463..cb362ac 100644 --- a/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/hadoop/InputSplitInfo.java +++ b/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/hadoop/InputSplitInfo.java @@ -88,13 +88,13 @@ public interface InputSplitInfo { /** * Get new format splits. Should only be used if the mapreduce API is being used - * @return + * @return array of mapreduce format splits */ public org.apache.hadoop.mapreduce.InputSplit[] getNewFormatSplits(); /** * Get old format splits. Should only be used if the mapred API is being used - * @return + * @return array of mapred format splits */ public org.apache.hadoop.mapred.InputSplit[] getOldFormatSplits(); } http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/hadoop/MRInputHelpers.java ---------------------------------------------------------------------- diff --git a/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/hadoop/MRInputHelpers.java b/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/hadoop/MRInputHelpers.java index 71d294f..9d6d56a 100644 --- a/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/hadoop/MRInputHelpers.java +++ b/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/hadoop/MRInputHelpers.java @@ -253,7 +253,7 @@ public class MRInputHelpers { } /** - * Generates Input splits and stores them in a {@link org.apache.hadoop.mapreduce.v2.proto.MRProtos} instance. + * Generates Input splits and stores them in a {@link org.apache.tez.mapreduce.protos.MRRuntimeProtos.MRSplitsProto} instance. * * Returns an instance of {@link InputSplitInfoMem} * http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/sort/impl/IFile.java ---------------------------------------------------------------------- diff --git a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/sort/impl/IFile.java b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/sort/impl/IFile.java index c9b6df4..f96f9ed 100644 --- a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/sort/impl/IFile.java +++ b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/sort/impl/IFile.java @@ -642,7 +642,7 @@ public class IFile { } /** - * Read upto len bytes into buf starting at offset off. + * Read up to len bytes into buf starting at offset off. * * @param buf buffer * @param off offset @@ -687,7 +687,8 @@ public class IFile { * Reset key length and value length for next record in the file * * @param dIn - * @return + * @return true if key length and value length were set to the next + * false if end of file (EOF) marker was reached * @throws IOException */ protected boolean positionToNextRecord(DataInput dIn) throws IOException { http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/BaseConfigBuilder.java ---------------------------------------------------------------------- diff --git a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/BaseConfigBuilder.java b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/BaseConfigBuilder.java index c172804..d991e89 100644 --- a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/BaseConfigBuilder.java +++ b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/BaseConfigBuilder.java @@ -34,7 +34,7 @@ interface BaseConfigBuilder<T> { * * @param key the key to set * @param value the corresponding value - * @return + * @return this object for further chained method calls */ public T setAdditionalConfiguration(String key, String value); @@ -45,7 +45,7 @@ interface BaseConfigBuilder<T> { * made available to the combiner. * * @param confMap map of configuration key-value pairs - * @return + * @return this object for further chained method calls */ public T setAdditionalConfiguration(Map<String, String> confMap); @@ -55,7 +55,7 @@ interface BaseConfigBuilder<T> { * compatibility and ease of use for existing systems which rely heavily on Configuration. * * @param conf - * @return + * @return this object for further chained method calls */ @InterfaceAudience.LimitedPrivate({"hive, pig"}) public T setFromConfiguration(Configuration conf); http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/OrderedGroupedKVInputConfig.java ---------------------------------------------------------------------- diff --git a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/OrderedGroupedKVInputConfig.java b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/OrderedGroupedKVInputConfig.java index 27817ef..9a81f2e 100644 --- a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/OrderedGroupedKVInputConfig.java +++ b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/OrderedGroupedKVInputConfig.java @@ -93,7 +93,7 @@ public class OrderedGroupedKVInputConfig { * Enable the memory to memory merger * * @param enable whether to enable the memory to memory merger - * @return + * @return instance of the current builder */ public T setMemToMemMerger(boolean enable); // Not super useful until additional params are used. @@ -460,7 +460,7 @@ public class OrderedGroupedKVInputConfig { * @param serializerConf the serializer configuration. This can be null, and is a * {@link java.util.Map} of key-value pairs. The keys should be limited * to the ones required by the comparator. - * @return + * @return this object for further chained method calls */ public Builder setKeySerializationClass(String serializationClassName, String comparatorClassName, @Nullable Map<String, String> serializerConf) { @@ -486,7 +486,7 @@ public class OrderedGroupedKVInputConfig { * @param serializerConf the serializer configuration. This can be null, and is a * {@link java.util.Map} of key-value pairs. The keys should be limited * to the ones required by the comparator. - * @return + * @return this object for further chained method calls */ public Builder setValueSerializationClass(String serializationClassName, @Nullable Map<String, String> serializerConf) { http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/OrderedPartitionedKVEdgeConfig.java ---------------------------------------------------------------------- diff --git a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/OrderedPartitionedKVEdgeConfig.java b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/OrderedPartitionedKVEdgeConfig.java index c495c12..76f73ac 100644 --- a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/OrderedPartitionedKVEdgeConfig.java +++ b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/OrderedPartitionedKVEdgeConfig.java @@ -210,7 +210,7 @@ public class OrderedPartitionedKVEdgeConfig * @param serializerConf the serializer configuration. This can be null, and is a * {@link java.util.Map} of key-value pairs. The keys should be limited * to the ones required by the comparator. - * @return + * @return this object for further chained method calls */ public Builder setKeySerializationClass(String serializationClassName, String comparatorClassName, @Nullable Map<String, String> serializerConf) { @@ -226,7 +226,7 @@ public class OrderedPartitionedKVEdgeConfig * @param serializerConf the serializer configuration. This can be null, and is a * {@link java.util.Map} of key-value pairs. The keys should be limited * to the ones required by the comparator. - * @return + * @return this object for further chained method calls */ public Builder setValueSerializationClass(String serializationClassName, @Nullable Map<String, String> serializerConf) { http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/OrderedPartitionedKVOutputConfig.java ---------------------------------------------------------------------- diff --git a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/OrderedPartitionedKVOutputConfig.java b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/OrderedPartitionedKVOutputConfig.java index f9b468c..4a8e38f 100644 --- a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/OrderedPartitionedKVOutputConfig.java +++ b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/OrderedPartitionedKVOutputConfig.java @@ -386,7 +386,7 @@ public class OrderedPartitionedKVOutputConfig { * @param serializerConf the serializer configuration. This can be null, and is a * {@link java.util.Map} of key-value pairs. The keys should be limited * to the ones required by the comparator. - * @return + * @return this object for further chained method calls */ public Builder setKeySerializationClass(String serializationClassName, String comparatorClassName, @Nullable Map<String, String> serializerConf) { @@ -412,7 +412,7 @@ public class OrderedPartitionedKVOutputConfig { * @param serializerConf the serializer configuration. This can be null, and is a * {@link java.util.Map} of key-value pairs. The keys should be limited * to the ones required by the comparator. - * @return + * @return this object for further chained method calls */ public Builder setValueSerializationClass(String serializationClassName, @Nullable Map<String, String> serializerConf) { http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedKVEdgeConfig.java ---------------------------------------------------------------------- diff --git a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedKVEdgeConfig.java b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedKVEdgeConfig.java index 66b2ded..3864565 100644 --- a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedKVEdgeConfig.java +++ b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedKVEdgeConfig.java @@ -207,7 +207,7 @@ public class UnorderedKVEdgeConfig extends HadoopKeyValuesBasedBaseEdgeConfig { * @param serializerConf the serializer configuration. This can be null, and is a * {@link java.util.Map} of key-value pairs. The keys should be limited * to the ones required by the comparator. - * @return + * @return this object for further chained method calls */ public Builder setKeySerializationClass(String serializationClassName, @Nullable Map<String, String> serializerConf) { @@ -223,7 +223,7 @@ public class UnorderedKVEdgeConfig extends HadoopKeyValuesBasedBaseEdgeConfig { * @param serializerConf the serializer configuration. This can be null, and is a * {@link java.util.Map} of key-value pairs. The keys should be limited * to the ones required by the comparator. - * @return + * @return this object for further chained method calls */ public Builder setValueSerializationClass(String serializationClassName, @Nullable Map<String, String> serializerConf) { http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedKVInputConfig.java ---------------------------------------------------------------------- diff --git a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedKVInputConfig.java b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedKVInputConfig.java index 9686cbe..e541341 100644 --- a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedKVInputConfig.java +++ b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedKVInputConfig.java @@ -307,7 +307,7 @@ public class UnorderedKVInputConfig { * @param serializerConf the serializer configuration. This can be null, and is a * {@link java.util.Map} of key-value pairs. The keys should be limited * to the ones required by the comparator. - * @return + * @return this object for further chained method calls */ public Builder setKeySerializationClass(String serializationClassName, @Nullable Map<String, String> serializerConf) { @@ -330,7 +330,7 @@ public class UnorderedKVInputConfig { * @param serializerConf the serializer configuration. This can be null, and is a * {@link java.util.Map} of key-value pairs. The keys should be limited * to the ones required by the comparator. - * @return + * @return this object for further chained method calls */ public Builder setValueSerializationClass(String serializationClassName, @Nullable Map<String, String> serializerConf) { http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedKVOutputConfig.java ---------------------------------------------------------------------- diff --git a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedKVOutputConfig.java b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedKVOutputConfig.java index b4e2c2c..3c3a7cf 100644 --- a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedKVOutputConfig.java +++ b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedKVOutputConfig.java @@ -217,7 +217,7 @@ public class UnorderedKVOutputConfig { * @param serializerConf the serializer configuration. This can be null, and is a * {@link java.util.Map} of key-value pairs. The keys should be limited * to the ones required by the comparator. - * @return + * @return this object for further chained method calls */ public Builder setKeySerializationClass(String serializationClassName, @Nullable Map<String, String> serializerConf) { @@ -240,7 +240,7 @@ public class UnorderedKVOutputConfig { * @param serializerConf the serializer configuration. This can be null, and is a * {@link java.util.Map} of key-value pairs. The keys should be limited * to the ones required by the comparator. - * @return + * @return this object for further chained method calls */ public Builder setValueSerializationClass(String serializationClassName, @Nullable Map<String, String> serializerConf) { http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedPartitionedKVEdgeConfig.java ---------------------------------------------------------------------- diff --git a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedPartitionedKVEdgeConfig.java b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedPartitionedKVEdgeConfig.java index 54ea5ce..44ca74e 100644 --- a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedPartitionedKVEdgeConfig.java +++ b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedPartitionedKVEdgeConfig.java @@ -212,7 +212,7 @@ public class UnorderedPartitionedKVEdgeConfig * @param serializerConf the serializer configuration. This can be null, and is a * {@link java.util.Map} of key-value pairs. The keys should be limited * to the ones required by the comparator. - * @return + * @return this object for further chained method calls */ public Builder setKeySerializationClass(String serializationClassName, @Nullable Map<String, String> serializerConf) { @@ -228,7 +228,7 @@ public class UnorderedPartitionedKVEdgeConfig * @param serializerConf the serializer configuration. This can be null, and is a * {@link java.util.Map} of key-value pairs. The keys should be limited * to the ones required by the comparator. - * @return + * @return this object for further chained method calls */ public Builder setValueSerializationClass(String serializationClassName, @Nullable Map<String, String> serializerConf) { outputBuilder.setValueSerializationClass(serializationClassName, serializerConf); http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedPartitionedKVOutputConfig.java ---------------------------------------------------------------------- diff --git a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedPartitionedKVOutputConfig.java b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedPartitionedKVOutputConfig.java index fbadc58..74fb209 100644 --- a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedPartitionedKVOutputConfig.java +++ b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/conf/UnorderedPartitionedKVOutputConfig.java @@ -277,7 +277,7 @@ public class UnorderedPartitionedKVOutputConfig { * @param serializerConf the serializer configuration. This can be null, and is a * {@link java.util.Map} of key-value pairs. The keys should be limited * to the ones required by the comparator. - * @return + * @return this object for further chained method calls */ public Builder setKeySerializationClass(String serializationClassName, @Nullable Map<String, String> serializerConf) { @@ -299,7 +299,7 @@ public class UnorderedPartitionedKVOutputConfig { * @param serializerConf the serializer configuration. This can be null, and is a * {@link java.util.Map} of key-value pairs. The keys should be limited * to the ones required by the comparator. - * @return + * @return this object for further chained method calls */ public Builder setValueSerializationClass(String serializationClassName, @Nullable Map<String, String> serializerConf) { http://git-wip-us.apache.org/repos/asf/tez/blob/4842c3a6/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/shuffle/common/HttpConnection.java ---------------------------------------------------------------------- diff --git a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/shuffle/common/HttpConnection.java b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/shuffle/common/HttpConnection.java index 1dd36b4..7208c16 100644 --- a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/shuffle/common/HttpConnection.java +++ b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/shuffle/common/HttpConnection.java @@ -122,8 +122,9 @@ public class HttpConnection { /** * Connect to source * - * @return - * @throws IOException + * @return true if connection was successful + * false if connection was previously cleaned up + * @throws IOException upon connection failure */ public boolean connect() throws IOException { return connect(httpConnParams.connectionTimeout); @@ -133,8 +134,9 @@ public class HttpConnection { * Connect to source with specific timeout * * @param connectionTimeout - * @return - * @throws IOException + * @return true if connection was successful + * false if connection was previously cleaned up + * @throws IOException upon connection failure */ public boolean connect(int connectionTimeout) throws IOException { stopWatch.reset().start();
