YARN-5429. Fix return related javadoc warnings in yarn-api (Vrushali C via Varun Saxena)
Project: http://git-wip-us.apache.org/repos/asf/hadoop/repo Commit: http://git-wip-us.apache.org/repos/asf/hadoop/commit/4a262210 Tree: http://git-wip-us.apache.org/repos/asf/hadoop/tree/4a262210 Diff: http://git-wip-us.apache.org/repos/asf/hadoop/diff/4a262210 Branch: refs/heads/YARN-2915 Commit: 4a26221021ec228a1726fd4905693473cd525796 Parents: ef43257 Author: Varun Saxena <varunsax...@apache.org> Authored: Fri Aug 5 16:27:53 2016 +0530 Committer: Varun Saxena <varunsax...@apache.org> Committed: Fri Aug 5 16:27:53 2016 +0530 ---------------------------------------------------------------------- .../apache/hadoop/yarn/api/ApplicationConstants.java | 2 ++ .../yarn/api/protocolrecords/AllocateRequest.java | 12 +++++++++++- .../yarn/api/protocolrecords/AllocateResponse.java | 3 +++ .../FinishApplicationMasterResponse.java | 4 ++++ .../api/protocolrecords/GetApplicationsRequest.java | 4 ++++ .../api/protocolrecords/GetClusterNodesRequest.java | 2 ++ .../protocolrecords/GetContainerStatusesResponse.java | 1 + .../api/protocolrecords/GetDelegationTokenResponse.java | 2 +- .../IncreaseContainersResourceResponse.java | 1 + .../api/protocolrecords/KillApplicationResponse.java | 2 ++ .../RegisterApplicationMasterResponse.java | 2 ++ .../api/protocolrecords/ReservationListRequest.java | 3 +++ .../api/protocolrecords/StartContainersResponse.java | 1 + .../api/protocolrecords/StopContainersResponse.java | 1 + .../apache/hadoop/yarn/api/records/LocalResource.java | 3 +++ .../main/java/org/apache/hadoop/yarn/conf/HAUtil.java | 5 ++++- 16 files changed, 45 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hadoop/blob/4a262210/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationConstants.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationConstants.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationConstants.java index 9442c53..760e251 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationConstants.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationConstants.java @@ -263,6 +263,7 @@ public interface ApplicationConstants { * Note: Use $$() method for cross-platform practice i.e. submit an * application from a Windows client to a Linux/Unix server or vice versa. * </p> + * @return expanded environment variable. */ public String $() { if (Shell.WINDOWS) { @@ -278,6 +279,7 @@ public interface ApplicationConstants { * expansion marker ('%' for Windows and '$' for Linux) by NodeManager on * container launch. For example: {{VAR}} will be replaced as $VAR on Linux, * and %VAR% on Windows. + * @return expanded environment variable. */ @Public @Unstable http://git-wip-us.apache.org/repos/asf/hadoop/blob/4a262210/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateRequest.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateRequest.java index 0b65e5c..e24ebdf 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateRequest.java @@ -199,6 +199,9 @@ public abstract class AllocateRequest { /** * Get the list of container resource increase requests being sent by the * <code>ApplicationMaster</code>. + * @return the list of {@link ContainerResourceChangeRequest} + * being sent by the + * <code>ApplicationMaster</code>. */ @Public @Unstable @@ -207,7 +210,9 @@ public abstract class AllocateRequest { /** * Set the list of container resource increase requests to inform the * <code>ResourceManager</code> about the containers whose resources need - * to be increased. + * to be increased. + * @param increaseRequests list of + * {@link ContainerResourceChangeRequest} */ @Public @Unstable @@ -217,6 +222,9 @@ public abstract class AllocateRequest { /** * Get the list of container resource decrease requests being sent by the * <code>ApplicationMaster</code>. + * @return list of {@link ContainerResourceChangeRequest} + * being sent by the + * <code>ApplicationMaster</code>. */ @Public @Unstable @@ -226,6 +234,8 @@ public abstract class AllocateRequest { * Set the list of container resource decrease requests to inform the * <code>ResourceManager</code> about the containers whose resources need * to be decreased. + * @param decreaseRequests list of + * {@link ContainerResourceChangeRequest} */ @Public @Unstable http://git-wip-us.apache.org/repos/asf/hadoop/blob/4a262210/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateResponse.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateResponse.java index 2567a51..4fba423 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateResponse.java @@ -279,6 +279,7 @@ public abstract class AllocateResponse { * AM will receive one NMToken per NM irrespective of the number of containers * issued on same NM. AM is expected to store these tokens until issued a * new token for the same NM. + * @return list of NMTokens required for communicating with NM */ @Public @Stable @@ -291,6 +292,7 @@ public abstract class AllocateResponse { /** * Get the list of newly increased containers by * <code>ResourceManager</code>. + * @return list of newly increased containers */ @Public @Unstable @@ -308,6 +310,7 @@ public abstract class AllocateResponse { /** * Get the list of newly decreased containers by * <code>ResourceManager</code>. + * @return the list of newly decreased containers */ @Public @Unstable http://git-wip-us.apache.org/repos/asf/hadoop/blob/4a262210/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterResponse.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterResponse.java index 6647a10..b2bac68 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterResponse.java @@ -59,6 +59,8 @@ public abstract class FinishApplicationMasterResponse { /** * Get the flag which indicates that the application has successfully * unregistered with the RM and the application can safely stop. + * @return true if the application has unregistered with the RM, + * false otherwise */ @Public @Stable @@ -67,6 +69,8 @@ public abstract class FinishApplicationMasterResponse { /** * Set the flag which indicates that the application has successfully * unregistered with the RM and the application can safely stop. + * @param isUnregistered boolean flag to indicate that the application has + * successfully unregistered with the RM */ @Private @Unstable http://git-wip-us.apache.org/repos/asf/hadoop/blob/4a262210/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationsRequest.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationsRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationsRequest.java index 35392e4..5cc9cc1 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationsRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationsRequest.java @@ -116,6 +116,7 @@ public abstract class GetApplicationsRequest { * * @param scope {@link ApplicationsRequestScope} to filter by * @see ApplicationClientProtocol#getApplications(GetApplicationsRequest) + * @return a report of Applications in {@link GetApplicationsRequest} */ @Public @Stable @@ -136,6 +137,7 @@ public abstract class GetApplicationsRequest { * * * @see ApplicationClientProtocol#getApplications(GetApplicationsRequest) + * @return a report of Applications in {@link GetApplicationsRequest} */ @Public @Stable @@ -156,6 +158,7 @@ public abstract class GetApplicationsRequest { * * * @see ApplicationClientProtocol#getApplications(GetApplicationsRequest) + * @return a report of Applications in {@link GetApplicationsRequest} */ @Public @Stable @@ -176,6 +179,7 @@ public abstract class GetApplicationsRequest { * * * @see ApplicationClientProtocol#getApplications(GetApplicationsRequest) + * @return a report of Applications in <code>GetApplicationsRequest</code> */ @Public @Stable http://git-wip-us.apache.org/repos/asf/hadoop/blob/4a262210/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodesRequest.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodesRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodesRequest.java index bf642cc..32e3d3a 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodesRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodesRequest.java @@ -56,11 +56,13 @@ public abstract class GetClusterNodesRequest { /** * The state to filter the cluster nodes with. + * @return the set of {@link NodeState} */ public abstract EnumSet<NodeState> getNodeStates(); /** * The state to filter the cluster nodes with. + * @param states the set of {@link NodeState} */ public abstract void setNodeStates(EnumSet<NodeState> states); } http://git-wip-us.apache.org/repos/asf/hadoop/blob/4a262210/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesResponse.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesResponse.java index 68e6a8c..75baf6e 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesResponse.java @@ -73,6 +73,7 @@ public abstract class GetContainerStatusesResponse { /** * Get the containerId-to-exception map in which the exception indicates error * from per container for failed requests + * @return map of containerId-to-exception */ @Public @Stable http://git-wip-us.apache.org/repos/asf/hadoop/blob/4a262210/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetDelegationTokenResponse.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetDelegationTokenResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetDelegationTokenResponse.java index bb7fcf0..9e396e7 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetDelegationTokenResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetDelegationTokenResponse.java @@ -49,7 +49,7 @@ public abstract class GetDelegationTokenResponse { /** * The Delegation tokens have a identifier which maps to * {@link AbstractDelegationTokenIdentifier}. - * + * @return the delegation tokens */ @Public @Stable http://git-wip-us.apache.org/repos/asf/hadoop/blob/4a262210/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/IncreaseContainersResourceResponse.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/IncreaseContainersResourceResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/IncreaseContainersResourceResponse.java index aeb1e83..1d82120 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/IncreaseContainersResourceResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/IncreaseContainersResourceResponse.java @@ -77,6 +77,7 @@ public abstract class IncreaseContainersResourceResponse { /** * Get the containerId-to-exception map in which the exception indicates * error from each container for failed requests. + * @return map of containerId-to-exception */ @Public @Unstable http://git-wip-us.apache.org/repos/asf/hadoop/blob/4a262210/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/KillApplicationResponse.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/KillApplicationResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/KillApplicationResponse.java index 7225bf5..8349576 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/KillApplicationResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/KillApplicationResponse.java @@ -57,6 +57,8 @@ public abstract class KillApplicationResponse { /** * Get the flag which indicates that the process of killing application is completed or not. + * @return true if the process of killing application has completed, + * false otherwise */ @Public @Stable http://git-wip-us.apache.org/repos/asf/hadoop/blob/4a262210/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterResponse.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterResponse.java index 1a51ba6..0b886dd 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterResponse.java @@ -104,6 +104,7 @@ public abstract class RegisterApplicationMasterResponse { * <p>The ClientToAMToken master key is sent to <code>ApplicationMaster</code> * by <code>ResourceManager</code> via {@link RegisterApplicationMasterResponse} * , used to verify corresponding ClientToAMToken.</p> + * @return ClientToAMToken master key */ @Public @Stable @@ -118,6 +119,7 @@ public abstract class RegisterApplicationMasterResponse { /** * <p>Get the queue that the application was placed in.<p> + * @return the queue that the application was placed in. */ @Public @Stable http://git-wip-us.apache.org/repos/asf/hadoop/blob/4a262210/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/ReservationListRequest.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/ReservationListRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/ReservationListRequest.java index 0b5275c..6ab3360 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/ReservationListRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/ReservationListRequest.java @@ -52,6 +52,7 @@ public abstract class ReservationListRequest { * to be returned. Reservation allocations are subject to * change in the event of re-planning as described by * {@code ReservationDefinition}. + * @return the list of reservations via {@link ReservationListRequest} */ @Public @Unstable @@ -84,6 +85,7 @@ public abstract class ReservationListRequest { * to be returned. Reservation allocations are subject to * change in the event of re-planning as described by * {@code ReservationDefinition}. + * @return the list of reservations via {@link ReservationListRequest} */ @Public @Unstable @@ -105,6 +107,7 @@ public abstract class ReservationListRequest { * @param reservationId Optional. String representation of * {@code ReservationId} If provided, other fields will * be ignored. + * @return the list of reservations via {@link ReservationListRequest} */ @Public @Unstable http://git-wip-us.apache.org/repos/asf/hadoop/blob/4a262210/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StartContainersResponse.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StartContainersResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StartContainersResponse.java index 8dfda45..8905ae2 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StartContainersResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StartContainersResponse.java @@ -78,6 +78,7 @@ public abstract class StartContainersResponse { /** * Get the containerId-to-exception map in which the exception indicates error * from per container for failed requests + * @return map of containerId-to-exception */ @Public @Stable http://git-wip-us.apache.org/repos/asf/hadoop/blob/4a262210/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StopContainersResponse.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StopContainersResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StopContainersResponse.java index a0f54d1..2763bc9 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StopContainersResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StopContainersResponse.java @@ -74,6 +74,7 @@ public abstract class StopContainersResponse { /** * Get the containerId-to-exception map in which the exception indicates error * from per container for failed requests + * @return map of containerId-to-exception */ @Public @Stable http://git-wip-us.apache.org/repos/asf/hadoop/blob/4a262210/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResource.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResource.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResource.java index 726d969..e243e90 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResource.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResource.java @@ -193,6 +193,9 @@ public abstract class LocalResource { /** * NM uses it to decide whether if it is necessary to upload the resource to * the shared cache + * @return true if it is necessary to upload the resource + * to the shared cache, + * false otherwise */ @Public @Unstable http://git-wip-us.apache.org/repos/asf/hadoop/blob/4a262210/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/HAUtil.java ---------------------------------------------------------------------- diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/HAUtil.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/HAUtil.java index 8c5d00b..594832e 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/HAUtil.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/HAUtil.java @@ -263,7 +263,10 @@ public class HAUtil { return (value == null) ? defaultValue : value; } - /** Add non empty and non null suffix to a key */ + /** + * Add non empty and non null suffix to a key. + * @return the suffixed key + */ public static String addSuffix(String key, String suffix) { if (suffix == null || suffix.isEmpty()) { return key; --------------------------------------------------------------------- To unsubscribe, e-mail: common-commits-unsubscr...@hadoop.apache.org For additional commands, e-mail: common-commits-h...@hadoop.apache.org