From f230349f8b7994e4b2f35b06ebe417e8cf294945 Mon Sep 17 00:00:00 2001 From: Jinmei Liao Date: Fri, 22 Jul 2016 09:01:35 -0700 Subject: [PATCH] GEODE-17: fix javadoc warnings --- .../gms/mgr/GMSMembershipManager.java | 63 ++++++++++++++----- .../internal/security/GeodeSecurityUtil.java | 4 +- .../geode/security/GeodePermission.java | 13 ++-- .../templates/SamplePostProcessor.java | 2 +- 4 files changed, 57 insertions(+), 25 deletions(-) diff --git a/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/membership/gms/mgr/GMSMembershipManager.java b/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/membership/gms/mgr/GMSMembershipManager.java index e6ca8e16a0d9..4ed30a4473a4 100644 --- a/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/membership/gms/mgr/GMSMembershipManager.java +++ b/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/membership/gms/mgr/GMSMembershipManager.java @@ -16,17 +16,63 @@ */ package com.gemstone.gemfire.distributed.internal.membership.gms.mgr; -import com.gemstone.gemfire.*; +import java.io.IOException; +import java.io.NotSerializableException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import java.util.HashMap; +import java.util.HashSet; +import java.util.Iterator; +import java.util.LinkedHashMap; +import java.util.LinkedList; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; +import java.util.concurrent.locks.Lock; +import java.util.concurrent.locks.ReadWriteLock; +import java.util.concurrent.locks.ReentrantReadWriteLock; + +import org.apache.logging.log4j.Logger; + +import com.gemstone.gemfire.CancelException; +import com.gemstone.gemfire.ForcedDisconnectException; +import com.gemstone.gemfire.GemFireConfigException; +import com.gemstone.gemfire.InternalGemFireError; +import com.gemstone.gemfire.SystemConnectException; +import com.gemstone.gemfire.SystemFailure; +import com.gemstone.gemfire.ToDataException; import com.gemstone.gemfire.cache.Cache; import com.gemstone.gemfire.distributed.DistributedMember; import com.gemstone.gemfire.distributed.DistributedSystem; import com.gemstone.gemfire.distributed.DistributedSystemDisconnectedException; import com.gemstone.gemfire.distributed.Locator; -import com.gemstone.gemfire.distributed.internal.*; +import com.gemstone.gemfire.distributed.internal.AdminMessageType; +import com.gemstone.gemfire.distributed.internal.DMStats; +import com.gemstone.gemfire.distributed.internal.DSClock; +import com.gemstone.gemfire.distributed.internal.DistributionConfig; +import com.gemstone.gemfire.distributed.internal.DistributionException; +import com.gemstone.gemfire.distributed.internal.DistributionManager; +import com.gemstone.gemfire.distributed.internal.DistributionMessage; +import com.gemstone.gemfire.distributed.internal.InternalDistributedSystem; +import com.gemstone.gemfire.distributed.internal.InternalLocator; +import com.gemstone.gemfire.distributed.internal.OverflowQueueWithDMStats; +import com.gemstone.gemfire.distributed.internal.SizeableRunnable; +import com.gemstone.gemfire.distributed.internal.StartupMessage; import com.gemstone.gemfire.distributed.internal.direct.DirectChannel; import com.gemstone.gemfire.distributed.internal.direct.DirectChannelListener; import com.gemstone.gemfire.distributed.internal.direct.ShunnedMemberException; -import com.gemstone.gemfire.distributed.internal.membership.*; +import com.gemstone.gemfire.distributed.internal.membership.DistributedMembershipListener; +import com.gemstone.gemfire.distributed.internal.membership.InternalDistributedMember; +import com.gemstone.gemfire.distributed.internal.membership.MembershipManager; +import com.gemstone.gemfire.distributed.internal.membership.MembershipTestHook; +import com.gemstone.gemfire.distributed.internal.membership.NetView; +import com.gemstone.gemfire.distributed.internal.membership.QuorumChecker; import com.gemstone.gemfire.distributed.internal.membership.gms.GMSMember; import com.gemstone.gemfire.distributed.internal.membership.gms.Services; import com.gemstone.gemfire.distributed.internal.membership.gms.SuspectMember; @@ -51,16 +97,6 @@ import com.gemstone.gemfire.internal.tcp.ConnectExceptions; import com.gemstone.gemfire.internal.tcp.MemberShunnedException; import com.gemstone.gemfire.internal.util.Breadcrumbs; -import org.apache.logging.log4j.Logger; - -import java.io.IOException; -import java.io.NotSerializableException; -import java.util.*; -import java.util.concurrent.ConcurrentHashMap; -import java.util.concurrent.CountDownLatch; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; -import java.util.concurrent.locks.*; public class GMSMembershipManager implements MembershipManager, Manager { @@ -2034,7 +2070,6 @@ public void run() { * * Concurrency: protected by {@link #latestViewLock} ReentrantReadWriteLock * - * @guarded.By latestViewLock * @return true if the given member is a zombie */ public boolean isShunned(DistributedMember m) { diff --git a/geode-core/src/main/java/com/gemstone/gemfire/internal/security/GeodeSecurityUtil.java b/geode-core/src/main/java/com/gemstone/gemfire/internal/security/GeodeSecurityUtil.java index ead82e5d2450..0d5e70115906 100644 --- a/geode-core/src/main/java/com/gemstone/gemfire/internal/security/GeodeSecurityUtil.java +++ b/geode-core/src/main/java/com/gemstone/gemfire/internal/security/GeodeSecurityUtil.java @@ -378,7 +378,7 @@ public static Object postProcess(String regionPath, Object key, Object result){ * @param className * @param expectedClazz * @param - * @return + * @return the expected object loadded by using the className */ public static T getObjectOfTypeFromClassName(String className, Class expectedClazz) { Class actualClass = null; @@ -407,7 +407,7 @@ public static T getObjectOfTypeFromClassName(String className, Class expe * @param factoryMethodName * @param expectedClazz * @param - * @return + * @return the expected object loaded by the factory method */ public static T getObjectOfTypeFromFactoryMethod(String factoryMethodName, Class expectedClazz){ T actualObject = null; diff --git a/geode-core/src/main/java/org/apache/geode/security/GeodePermission.java b/geode-core/src/main/java/org/apache/geode/security/GeodePermission.java index 0a777a860fa0..9f0ce2d26592 100644 --- a/geode-core/src/main/java/org/apache/geode/security/GeodePermission.java +++ b/geode-core/src/main/java/org/apache/geode/security/GeodePermission.java @@ -43,32 +43,29 @@ public enum Operation { } /** - * Returns the resource, could be either DATA or CLUSTER - * @return + * Returns + * @return the resource, could be either DATA or CLUSTER */ public Resource getResource() { return resource; } /** - * Returns the operation, could be either MANAGE, WRITE or READ - * @return + * @return the operation, could be either MANAGE, WRITE or READ */ public Operation getOperation() { return operation; } /** - * returns the regionName, could be "*", meaning all regions - * @return + * @return the regionName, could be "*", meaning all regions */ public String getRegionName() { return regionName; } /** - * returns the key, could be "*" meaning all keys. - * @return + * @return the key, could be "*" meaning all keys. */ public String getKey() { return key; diff --git a/geode-core/src/main/java/org/apache/geode/security/templates/SamplePostProcessor.java b/geode-core/src/main/java/org/apache/geode/security/templates/SamplePostProcessor.java index 8f61db75aec3..5eca74481844 100644 --- a/geode-core/src/main/java/org/apache/geode/security/templates/SamplePostProcessor.java +++ b/geode-core/src/main/java/org/apache/geode/security/templates/SamplePostProcessor.java @@ -42,7 +42,7 @@ public void init(final Properties securityProps) { * the key of the value that's been accessed. This could be null. * @param value * the value, this could be null. - * @return + * @return the processed value */ @Override public Object processRegionValue(Principal principal,