From e7cac727a9231ff3602e61a4ea678e0463eb0e39 Mon Sep 17 00:00:00 2001
From: Jean-Noel Rouvignac <jean-noel.rouvignac@forgerock.com>
Date: Tue, 24 Mar 2015 09:41:42 +0000
Subject: [PATCH] Autorefactored javadocs
---
opendj-server-legacy/src/main/java/org/opends/server/api/DirectoryThread.java | 20
opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/ProgressPanel.java | 27
opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/QuickSetupStepPanel.java | 8
opendj-server-legacy/src/main/java/org/opends/server/api/EntryCache.java | 14
opendj-server-legacy/src/main/java/org/opends/server/api/plugin/PluginResult.java | 101
opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumBindRuleKeyword.java | 10
opendj-server-legacy/src/main/java/org/opends/server/admin/client/ldap/LDAPDriver.java | 66
opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/AttributeIndex.java | 2
opendj-server-legacy/src/main/java/org/opends/quicksetup/Installation.java | 4
opendj-server-legacy/src/main/java/org/opends/server/admin/ManagedObjectPath.java | 144 -
opendj-server-legacy/src/main/java/org/opends/quicksetup/util/PlainTextProgressMessageFormatter.java | 10
opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObjectAddListenerAdaptor.java | 10
opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryContainer.java | 2
opendj-server-legacy/src/main/java/org/opends/server/admin/condition/IsPresentCondition.java | 18
opendj-server-legacy/src/main/java/org/opends/server/admin/OptionalRelationDefinition.java | 30
opendj-server-legacy/src/main/java/org/opends/server/admin/client/spi/PropertySet.java | 50
opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyNotFoundException.java | 3
opendj-server-legacy/src/main/java/org/opends/server/admin/server/DelayedConfigAddListener.java | 29
opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/PatternIP.java | 22
opendj-server-legacy/src/main/java/org/opends/server/admin/AggregationPropertyDefinition.java | 204 +-
opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumAuthMethod.java | 8
opendj-server-legacy/src/main/java/org/opends/server/admin/condition/ContainsCondition.java | 40
opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/InstallWelcomePanel.java | 16
opendj-server-legacy/src/main/java/org/opends/server/admin/DefaultManagedObject.java | 11
opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/GlobalAdministratorPanel.java | 28
opendj-server-legacy/src/main/java/org/opends/server/admin/DefinedDefaultBehaviorProvider.java | 7
opendj-server-legacy/src/main/java/org/opends/server/admin/condition/ORCondition.java | 16
opendj-server-legacy/src/main/java/org/opends/server/api/plugin/DirectoryServerPlugin.java | 12
opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumTargetOperator.java | 5
opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/ParentInheritance.java | 26
opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/UIFactory.java | 16
opendj-server-legacy/src/main/java/org/opends/server/admin/ACIPropertyDefinition.java | 30
opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/InstallProgressStep.java | 10
opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/offline/OfflineInstaller.java | 25
opendj-server-legacy/src/main/java/org/opends/server/api/CompressedSchema.java | 10
opendj-server-legacy/src/main/java/org/opends/server/admin/RelationDefinition.java | 18
opendj-server-legacy/src/main/java/org/opends/quicksetup/CliUserInteraction.java | 54
opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/FinishedPanel.java | 8
opendj-server-legacy/src/main/java/org/opends/server/config/BooleanConfigAttribute.java | 6
opendj-server-legacy/src/main/java/org/opends/server/admin/client/ldap/LDAPManagementContext.java | 10
opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/RuntimeOptionsPanel.java | 37
opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyException.java | 8
opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObjectDecodingException.java | 8
opendj-server-legacy/src/main/java/org/opends/server/config/DNConfigAttribute.java | 4
opendj-server-legacy/src/main/java/org/opends/server/admin/StringPropertyDefinition.java | 56
opendj-server-legacy/src/main/java/org/opends/server/backends/task/TaskScheduler.java | 32
opendj-server-legacy/src/main/java/org/opends/server/admin/EnumPropertyDefinition.java | 36
opendj-server-legacy/src/main/java/org/opends/server/admin/RelativeInheritedDefaultBehaviorProvider.java | 15
opendj-server-legacy/src/main/java/org/opends/server/admin/SizePropertyDefinition.java | 58
opendj-server-legacy/src/main/java/org/opends/quicksetup/SplashScreen.java | 18
opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/TargetFilter.java | 14
opendj-server-legacy/src/main/java/org/opends/server/backends/SchemaBackend.java | 2
opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/EntryCachePreloader.java | 8
opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/IndexInputBuffer.java | 2
opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObject.java | 72
opendj-server-legacy/src/main/java/org/opends/server/config/ReadOnlyConfigAttribute.java | 4
opendj-server-legacy/src/main/java/org/opends/server/admin/client/IllegalManagedObjectNameException.java | 8
opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/InstallReviewPanel.java | 31
opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/RemoteReplicationPortsPanel.java | 46
opendj-server-legacy/src/main/java/org/opends/server/admin/AdministratorAction.java | 24
opendj-server-legacy/src/main/java/org/opends/server/admin/UndefinedDefaultBehaviorProvider.java | 5
opendj-server-legacy/src/main/java/org/opends/server/config/StringConfigAttribute.java | 4
opendj-server-legacy/src/main/java/org/opends/quicksetup/util/FileManager.java | 24
opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/QuickSetup.java | 14
opendj-server-legacy/src/main/java/org/opends/server/admin/client/OperationRejectedException.java | 13
opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/VLVIndex.java | 2
opendj-server-legacy/src/main/java/org/opends/server/admin/AbstractManagedObjectDefinition.java | 84
opendj-server-legacy/src/main/java/org/opends/quicksetup/util/ExtensionFileFilter.java | 12
opendj-server-legacy/src/main/java/org/opends/server/config/ConfigAttribute.java | 32
opendj-server-legacy/src/main/java/org/opends/server/admin/GenericConstraint.java | 40
opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryIDSet.java | 4
opendj-server-legacy/src/main/java/org/opends/server/admin/ClassPropertyDefinition.java | 44
opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/ConfigurableEnvironment.java | 6
opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagementContext.java | 79
opendj-server-legacy/src/main/java/org/opends/server/config/JMXMBean.java | 5
opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyDefinitionUsageBuilder.java | 73
opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/DataOptionsPanel.java | 27
opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/Importer.java | 2
opendj-server-legacy/src/main/java/org/opends/quicksetup/UserData.java | 6
opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObjectDeleteListenerAdaptor.java | 10
opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConfigAddListenerAdaptor.java | 20
opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/ButtonsPanel.java | 6
opendj-server-legacy/src/main/java/org/opends/server/config/MultiChoiceConfigAttribute.java | 6
opendj-server-legacy/src/main/java/org/opends/server/api/plugin/InternalDirectoryServerPlugin.java | 15
opendj-server-legacy/src/main/java/org/opends/server/admin/AttributeTypePropertyDefinition.java | 40
opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryCachePreloader.java | 2
opendj-server-legacy/src/main/java/org/opends/quicksetup/util/URLWorker.java | 11
opendj-server-legacy/src/main/java/org/opends/server/admin/client/ldap/LDAPNameBuilder.java | 21
opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/ReviewPanel.java | 6
opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConstraintViolationException.java | 10
opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/CustomHTMLEditorKit.java | 16
opendj-server-legacy/src/main/java/org/opends/server/backends/BackupBackend.java | 2
opendj-server-legacy/src/main/java/org/opends/server/admin/condition/Conditions.java | 28
opendj-server-legacy/src/main/java/org/opends/server/admin/AliasDefaultBehaviorProvider.java | 18
opendj-server-legacy/src/main/java/org/opends/quicksetup/BuildInformation.java | 16
opendj-server-legacy/src/main/java/org/opends/server/admin/DurationPropertyDefinition.java | 74
opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/AciTargets.java | 2
opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/BackendImpl.java | 3
opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/IndexInputBuffer.java | 2
opendj-server-legacy/src/main/java/org/opends/server/admin/DefinitionDecodingException.java | 8
opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/ServerSettingsPanel.java | 27
opendj-server-legacy/src/main/java/org/opends/server/config/IntegerWithUnitConfigAttribute.java | 32
opendj-server-legacy/src/main/java/org/opends/server/admin/LDAPProfile.java | 9
opendj-server-legacy/src/main/java/org/opends/server/admin/server/DNBuilder.java | 4
opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/TargAttrFilters.java | 4
opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyDefinition.java | 22
opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/AttributeIndex.java | 2
opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConfigExceptionFactory.java | 6
opendj-server-legacy/src/main/java/org/opends/server/admin/doc/ConfigGuideGeneration.java | 8
opendj-server-legacy/src/main/java/org/opends/server/backends/task/Task.java | 60
opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumAccessType.java | 17
opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumBooleanTypes.java | 8
opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/AciListenerManager.java | 52
opendj-server-legacy/src/main/java/org/opends/server/backends/persistit/PersistItStorage.java | 2
opendj-server-legacy/src/main/java/org/opends/server/admin/IntegerPropertyDefinition.java | 58
opendj-server-legacy/src/main/java/org/opends/server/admin/client/spi/Driver.java | 45
opendj-server-legacy/src/main/java/org/opends/server/admin/client/MissingMandatoryPropertiesException.java | 12
opendj-server-legacy/src/main/java/org/opends/server/admin/AbsoluteInheritedDefaultBehaviorProvider.java | 18
opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConfigChangeListenerAdaptor.java | 59
opendj-server-legacy/src/main/java/org/opends/server/admin/client/spi/AbstractManagedObject.java | 155 -
opendj-server-legacy/src/main/java/org/opends/server/config/IntegerConfigAttribute.java | 12
opendj-server-legacy/src/main/java/org/opends/server/admin/client/ldap/LDAPManagedObject.java | 36
opendj-server-legacy/src/main/java/org/opends/server/admin/condition/ANDCondition.java | 16
opendj-server-legacy/src/main/java/org/opends/server/admin/DNPropertyDefinition.java | 40
opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConfigDeleteListenerAdaptor.java | 20
opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/InstallLicensePanel.java | 19
opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/EntryContainer.java | 2
opendj-server-legacy/src/main/java/org/opends/server/admin/Reference.java | 24
opendj-server-legacy/src/main/java/org/opends/server/admin/InstantiableRelationDefinition.java | 38
opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/SuffixesToReplicatePanel.java | 34
opendj-server-legacy/src/main/java/org/opends/guitools/controlpanel/datamodel/VLVIndexDescriptor.java | 16
opendj-server-legacy/src/main/java/org/opends/server/admin/BooleanPropertyDefinition.java | 30
opendj-server-legacy/src/main/java/org/opends/server/api/MonitorProvider.java | 15
opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/webstart/WebStartInstaller.java | 21
opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumDayOfWeek.java | 6
opendj-server-legacy/src/main/java/org/opends/server/api/plugin/PluginType.java | 13
opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumTargetKeyword.java | 5
opendj-server-legacy/src/main/java/org/opends/server/admin/SetRelationDefinition.java | 36
opendj-server-legacy/src/main/java/org/opends/server/admin/condition/NOTCondition.java | 16
opendj-server-legacy/src/main/java/org/opends/server/admin/TopCfgDefn.java | 3
opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/DataReplicationPanel.java | 28
opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/SetupLauncher.java | 31
opendj-server-legacy/src/main/java/org/opends/server/admin/ClassLoaderProvider.java | 46
opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/Importer.java | 2
opendj-server-legacy/src/main/java/org/opends/server/admin/ManagedObjectDefinitionResource.java | 13
opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/UserDNTypeURL.java | 9
opendj-server-legacy/src/main/java/org/opends/server/admin/ManagedObjectDefinitionI18NResource.java | 16
opendj-server-legacy/src/main/java/org/opends/server/admin/SingletonRelationDefinition.java | 30
opendj-server-legacy/src/main/java/org/opends/server/admin/IPAddressPropertyDefinition.java | 34
opendj-server-legacy/src/main/java/org/opends/server/admin/client/ManagedObjectDecodingException.java | 8
opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObjectChangeListenerAdaptor.java | 6
opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyProvider.java | 4
opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/AciContainer.java | 204 --
opendj-server-legacy/src/main/java/org/opends/server/admin/IPAddressMaskPropertyDefinition.java | 30
opendj-server-legacy/src/main/java/org/opends/server/admin/Tag.java | 27
opendj-server-legacy/src/main/java/org/opends/quicksetup/Step.java | 69
opendj-server-legacy/src/main/java/org/opends/quicksetup/util/BackgroundTaskThread.java | 8
opendj-server-legacy/src/main/java/org/opends/quicksetup/ApplicationException.java | 8
158 files changed, 1,517 insertions(+), 2,463 deletions(-)
diff --git a/opendj-server-legacy/src/main/java/org/opends/guitools/controlpanel/datamodel/VLVIndexDescriptor.java b/opendj-server-legacy/src/main/java/org/opends/guitools/controlpanel/datamodel/VLVIndexDescriptor.java
index 1091316..323758d 100644
--- a/opendj-server-legacy/src/main/java/org/opends/guitools/controlpanel/datamodel/VLVIndexDescriptor.java
+++ b/opendj-server-legacy/src/main/java/org/opends/guitools/controlpanel/datamodel/VLVIndexDescriptor.java
@@ -70,17 +70,13 @@
recalculateHashCode();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int compareTo(AbstractIndexDescriptor o)
{
return getName().toLowerCase().compareTo(o.getName().toLowerCase());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int hashCode()
{
return hashCode;
@@ -122,9 +118,7 @@
return sortOrder;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean equals(Object o)
{
if (o == this)
@@ -155,9 +149,7 @@
&& getBackend().getBackendID().equals(index.getBackend().getBackendID());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void recalculateHashCode()
{
StringBuilder sb = new StringBuilder();
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/ApplicationException.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/ApplicationException.java
index 3c1dead..a0d319a 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/ApplicationException.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/ApplicationException.java
@@ -22,9 +22,8 @@
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
-
package org.opends.quicksetup;
import org.forgerock.i18n.LocalizableMessage;
@@ -37,7 +36,6 @@
* @see org.opends.quicksetup.installer.Installer
* @see org.opends.quicksetup.installer.webstart.WebStartInstaller
* @see org.opends.quicksetup.installer.offline.OfflineInstaller
- *
*/
public class ApplicationException extends OpenDsException {
@@ -84,9 +82,7 @@
return type;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String toString()
{
return getMessage();
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/BuildInformation.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/BuildInformation.java
index dfef502..b3dd793 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/BuildInformation.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/BuildInformation.java
@@ -318,9 +318,7 @@
return Integer.valueOf(values.get(REVISION_NUMBER));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
@@ -336,9 +334,7 @@
return sb.toString();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compareTo(BuildInformation bi) {
if (getMajorVersion().equals(bi.getMajorVersion())) {
@@ -361,9 +357,7 @@
return 1;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean equals(Object o) {
if (this == o) {
@@ -374,9 +368,7 @@
&& compareTo((BuildInformation)o) == 0;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
int hc = 11;
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/CliUserInteraction.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/CliUserInteraction.java
index f08a755..d7db99f 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/CliUserInteraction.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/CliUserInteraction.java
@@ -64,18 +64,14 @@
isForceOnError = ud != null && ud.isForceOnError();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Object confirm(LocalizableMessage summary, LocalizableMessage details,
LocalizableMessage title, MessageType type, LocalizableMessage[] options,
LocalizableMessage def) {
return confirm(summary, details, null, title, type, options, def, null);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Object confirm(LocalizableMessage summary, LocalizableMessage details, LocalizableMessage fineDetails,
LocalizableMessage title, MessageType type, LocalizableMessage[] options,
LocalizableMessage def, LocalizableMessage viewDetailsOption) {
@@ -152,9 +148,7 @@
return returnValue;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String createUnorderedList(List<?> list) {
StringBuilder sb = new StringBuilder();
if (list != null) {
@@ -174,70 +168,44 @@
getErrorStream().println(text);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isAdvancedMode() {
return false;
}
-
-
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isInteractive() {
return isInteractive;
}
-
-
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isMenuDrivenMode() {
return true;
}
-
-
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isQuiet() {
return false;
}
-
-
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isScriptFriendly() {
return false;
}
-
-
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isVerbose() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCLI()
{
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isForceOnError() {
return isForceOnError;
}
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/Installation.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/Installation.java
index f8fb188..e8d54a7 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/Installation.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/Installation.java
@@ -281,12 +281,12 @@
"set-java-home.bat";
/**
- * script utils file for UNIX systems.
+ * Script utils file for UNIX systems.
*/
public static final String SCRIPT_UTIL_FILE_UNIX = "_script-util.sh";
/**
- * script utils file for Windows.
+ * Script utils file for Windows.
*/
public static final String SCRIPT_UTIL_FILE_WINDOWS = "_script-util.bat";
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/SplashScreen.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/SplashScreen.java
index ba60f5a..ef302ec 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/SplashScreen.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/SplashScreen.java
@@ -22,8 +22,8 @@
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
-
package org.opends.quicksetup;
import static org.opends.messages.QuickSetupMessages.*;
@@ -64,7 +64,7 @@
private Class<?> quickSetupClass;
- // Constant for the display of the splash screen
+ /** Constant for the display of the splash screen. */
private static final int MIN_SPLASH_DISPLAY = 3000;
/**
@@ -78,26 +78,19 @@
screen.display(args);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void update(Graphics g)
{
paint(g);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void paint(Graphics g)
{
g.drawImage(image, 0, 0, this);
}
- /**
- * Protected constructor to force to use the main method.
- *
- */
+ /** Protected constructor to force to use the main method. */
protected SplashScreen()
{
super(new Frame());
@@ -113,7 +106,6 @@
setPreferredSize(new Dimension(width, height));
setSize(width, height);
Utilities.centerOnScreen(this);
-
} catch (Exception ex)
{
ex.printStackTrace(); // Bug
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/Step.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/Step.java
index 5d341d6..c25fb2e 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/Step.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/Step.java
@@ -22,9 +22,8 @@
*
*
* Copyright 2006-2010 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
-
package org.opends.quicksetup;
import org.forgerock.i18n.LocalizableMessage;
@@ -33,71 +32,45 @@
/**
* This enumeration just represents the different steps that we can have in
* the installation and uninstallation wizards.
- *
*/
public enum Step implements WizardStep
-
{
- /**
- * Welcome step for the installation.
- */
+ /** Welcome step for the installation. */
WELCOME(INFO_WELCOME_STEP.get()),
- /**
- * License approval step for the installation.
- */
+ /** License approval step for the installation. */
LICENSE(INFO_LICENSE_STEP.get()),
- /**
- * Confirmation panel for the uninstallation.
- */
+ /** Confirmation panel for the uninstallation. */
CONFIRM_UNINSTALL(INFO_CONFIRM_UNINSTALL_STEP.get()),
- /**
- * Server Settings step (path, port, etc.).
- */
+ /** Server Settings step (path, port, etc.). */
SERVER_SETTINGS(INFO_SERVER_SETTINGS_STEP.get()),
- /**
- * Data Replication panel (standalone or replicated).
- */
+ /** Data Replication panel (standalone or replicated). */
REPLICATION_OPTIONS(INFO_DATA_REPLICATION_STEP.get()),
- /**
- * Global Administrator creation panel.
- */
+ /** Global Administrator creation panel. */
CREATE_GLOBAL_ADMINISTRATOR(INFO_CREATE_GLOBAL_ADMINISTRATOR_STEP.get()),
- /**
- * Suffixes to Replicate.
- */
+ /** Suffixes to Replicate. */
SUFFIXES_OPTIONS(INFO_SUFFIXES_STEP.get()),
/**
* Panel when the user specifies the replication ports of the remote servers
* that have not defined it.
*/
REMOTE_REPLICATION_PORTS(INFO_REMOTE_REPLICATION_PORTS_STEP.get()),
- /**
- * Data Options panel (suffix dn, LDIF path, etc.).
- */
+ /** Data Options panel (suffix dn, LDIF path, etc.). */
NEW_SUFFIX_OPTIONS(INFO_DATA_OPTIONS_STEP.get()),
- /**
- * Runtime options panel for the install.
- */
+ /** Runtime options panel for the install. */
RUNTIME_OPTIONS(INFO_JAVA_RUNTIME_OPTIONS_PANEL_STEP.get()),
- /**
- * Review panel for the install.
- */
+ /** Review panel for the install. */
REVIEW(INFO_REVIEW_STEP.get()),
- /**
- * Progress panel.
- */
+ /** Progress panel. */
PROGRESS(INFO_PROGRESS_STEP.get()),
- /**
- * Finished panel.
- */
+ /** Finished panel. */
FINISHED(INFO_FINISHED_STEP.get());
private LocalizableMessage msg;
@@ -105,7 +78,7 @@
/**
* Creates a step.
* @param msg the message key used to access a message catalog to
- * retreive this step's display name
+ * retrieve this step's display name
*/
Step(LocalizableMessage msg) {
this.msg = msg;
@@ -114,29 +87,23 @@
/**
* Gets this steps message key.
* @return String message key used to access a message catalog to
- * retreive this step's display name
+ * retrieve this step's display name
*/
public LocalizableMessage getDisplayMessage() {
return msg;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isProgressStep() {
return this == PROGRESS;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isFinishedStep() {
return this == FINISHED;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isLicenseStep() {
return this == LICENSE;
}
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/UserData.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/UserData.java
index 053e9cb..dc3ef9c 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/UserData.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/UserData.java
@@ -672,8 +672,10 @@
final CountDownLatch latch = new CountDownLatch(1);
Thread t = new Thread(new Runnable()
{
- // Search for a host name of the form host.example.com on each
- // interface, except the loop back. Prefer interfaces of the form ethX.
+ /**
+ * Search for a host name of the form host.example.com on each
+ * interface, except the loop back. Prefer interfaces of the form ethX.
+ */
public void run()
{
try
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/InstallProgressStep.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/InstallProgressStep.java
index 210fc3e..87c8933 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/InstallProgressStep.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/InstallProgressStep.java
@@ -22,8 +22,8 @@
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
-
package org.opends.quicksetup.installer;
import org.opends.quicksetup.ProgressStep;
@@ -126,18 +126,14 @@
*/
FINISHED_WITH_ERROR;
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isLast() {
return this == FINISHED_SUCCESSFULLY ||
this == FINISHED_CANCELED ||
this == FINISHED_WITH_ERROR;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isError() {
return this.equals(FINISHED_WITH_ERROR);
}
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/SetupLauncher.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/SetupLauncher.java
index 5c6da13..9d9d76a 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/SetupLauncher.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/SetupLauncher.java
@@ -22,9 +22,8 @@
*
*
* Copyright 2008-2010 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
-
package org.opends.quicksetup.installer;
import static org.opends.messages.QuickSetupMessages.*;
@@ -115,9 +114,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void launch() {
try
{
@@ -176,16 +173,12 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ArgumentParser getArgumentParser() {
return this.argParser;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void guiLaunchFailed(String logFileName) {
if (logFileName != null)
{
@@ -198,34 +191,26 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void willLaunchGui() {
System.out.println(INFO_SETUP_LAUNCHER_LAUNCHING_GUI.get());
System.setProperty("org.opends.quicksetup.Application.class",
OfflineInstaller.class.getName());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getFrameTitle() {
return Utils.getCustomizedObject("INFO_FRAME_INSTALL_TITLE",
INFO_FRAME_INSTALL_TITLE.get(DynamicConstants.PRODUCT_NAME),
LocalizableMessage.class);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected CliApplication createCliApplication() {
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected boolean isCli() {
return argParser.isCli();
}
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/offline/OfflineInstaller.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/offline/OfflineInstaller.java
index 8c896d8..70ca280 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/offline/OfflineInstaller.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/offline/OfflineInstaller.java
@@ -22,9 +22,8 @@
*
*
* Copyright 2006-2010 Sun Microsystems, Inc.
- * Portions Copyright 2011-2014 ForgeRock AS
+ * Portions Copyright 2011-2015 ForgeRock AS
*/
-
package org.opends.quicksetup.installer.offline;
import org.forgerock.i18n.LocalizableMessage;
@@ -32,7 +31,6 @@
import static com.forgerock.opendj.util.OperatingSystem.isWindows;
import static com.forgerock.opendj.cli.Utils.getThrowableMsg;
-
import java.io.PrintStream;
import java.io.File;
import java.util.ArrayList;
@@ -72,11 +70,11 @@
*/
public class OfflineInstaller extends Installer
{
- /* This map contains the ratio associated with each step */
+ /** This map contains the ratio associated with each step. */
private final Map<ProgressStep, Integer> hmRatio =
new HashMap<ProgressStep, Integer>();
- /* This map contains the summary associated with each step */
+ /** This map contains the summary associated with each step. */
private final Map<ProgressStep, LocalizableMessage> hmSummary =
new HashMap<ProgressStep, LocalizableMessage>();
@@ -86,7 +84,6 @@
/**
* Actually performs the install in this thread. The thread is blocked.
- *
*/
@Override
public void run()
@@ -304,18 +301,14 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Integer getRatio(ProgressStep status)
{
return hmRatio.get(status);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage getSummary(ProgressStep status)
{
@@ -546,18 +539,14 @@
hmRatio.put(InstallProgressStep.FINISHED_CANCELED, 100);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getInstallationPath()
{
return Utils.getInstallPathFromClasspath();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getInstancePath()
{
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/DataOptionsPanel.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/DataOptionsPanel.java
index b23f59e..45b16ef 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/DataOptionsPanel.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/DataOptionsPanel.java
@@ -22,9 +22,8 @@
*
*
* Copyright 2006-2009 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
-
package org.opends.quicksetup.installer.ui;
import org.forgerock.i18n.LocalizableMessage;
@@ -99,9 +98,7 @@
addActionListeners();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Object getFieldValue(FieldName fieldName)
{
Object value = null;
@@ -129,9 +126,7 @@
return value;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void displayFieldInvalid(FieldName fieldName, boolean invalid)
{
JLabel label = getLabel(fieldName);
@@ -163,9 +158,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected Component createInputPanel()
{
JPanel panel = new JPanel(new GridBagLayout());
@@ -324,25 +317,19 @@
browseButton);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getInstructions()
{
return INFO_DATA_OPTIONS_PANEL_INSTRUCTIONS.get();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getTitle()
{
return INFO_DATA_OPTIONS_PANEL_TITLE.get();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void endDisplay()
{
if (lastFocusComponent != null)
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/DataReplicationPanel.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/DataReplicationPanel.java
index 04d754b..b998fbe 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/DataReplicationPanel.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/DataReplicationPanel.java
@@ -93,9 +93,7 @@
addActionListeners();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Object getFieldValue(FieldName fieldName)
{
Object value = null;
@@ -132,9 +130,7 @@
return value;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void displayFieldInvalid(FieldName fieldName, boolean invalid)
{
JLabel label = getLabel(fieldName);
@@ -154,9 +150,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected Component createInputPanel()
{
JPanel panel = new JPanel(new GridBagLayout());
@@ -267,25 +261,19 @@
return panel;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getInstructions()
{
return INFO_DATA_REPLICATION_OPTIONS_PANEL_INSTRUCTIONS.get();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getTitle()
{
return INFO_DATA_REPLICATION_OPTIONS_PANEL_TITLE.get();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void endDisplay()
{
if (lastFocusComponent != null)
@@ -294,9 +282,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getTextForIcon(UIFactory.IconType iconType)
{
LocalizableMessage text;
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/GlobalAdministratorPanel.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/GlobalAdministratorPanel.java
index a042875..4075a72 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/GlobalAdministratorPanel.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/GlobalAdministratorPanel.java
@@ -22,9 +22,8 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2013-2014 ForgeRock AS.
+ * Portions Copyright 2013-2015 ForgeRock AS.
*/
-
package org.opends.quicksetup.installer.ui;
import org.forgerock.i18n.LocalizableMessage;
@@ -80,9 +79,7 @@
addFocusListeners();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Object getFieldValue(FieldName fieldName)
{
Object value = null;
@@ -91,13 +88,10 @@
{
value = field.getText();
}
-
return value;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void displayFieldInvalid(FieldName fieldName, boolean invalid)
{
JLabel label = getLabel(fieldName);
@@ -115,9 +109,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected Component createInputPanel()
{
JPanel panel = new JPanel(new GridBagLayout());
@@ -180,25 +172,19 @@
return panel;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getInstructions()
{
return INFO_GLOBAL_ADMINISTRATOR_PANEL_INSTRUCTIONS.get();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getTitle()
{
return INFO_GLOBAL_ADMINISTRATOR_PANEL_TITLE.get();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void endDisplay()
{
if (lastFocusComponent != null)
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/InstallLicensePanel.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/InstallLicensePanel.java
index a9c03f2..fba2036 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/InstallLicensePanel.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/InstallLicensePanel.java
@@ -22,9 +22,8 @@
*
*
* Copyright 2006-2009 Sun Microsystems, Inc.
- * Portions Copyright 2013-2014 ForgeRock AS.
+ * Portions Copyright 2013-2015 ForgeRock AS.
*/
-
package org.opends.quicksetup.installer.ui;
import org.forgerock.i18n.LocalizableMessage;
@@ -60,17 +59,13 @@
super(app);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getTitle()
{
return INFO_LICENSE_PANEL_TITLE.get();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getInstructions()
{
return null;
@@ -78,9 +73,7 @@
private JCheckBox acceptCheck;
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected Component createInputPanel()
{
// No input in this panel
@@ -132,9 +125,7 @@
return panel;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected boolean requiresScroll()
{
return false;
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/InstallReviewPanel.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/InstallReviewPanel.java
index 1d23785..d8e45a5 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/InstallReviewPanel.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/InstallReviewPanel.java
@@ -22,9 +22,8 @@
*
*
* Copyright 2006-2010 Sun Microsystems, Inc.
- * Portions Copyright 2013-2014 ForgeRock AS.
+ * Portions Copyright 2013-2015 ForgeRock AS.
*/
-
package org.opends.quicksetup.installer.ui;
import org.forgerock.i18n.LocalizableMessage;
@@ -101,9 +100,7 @@
populateLabelAndFieldsMap();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void beginDisplay(UserData userData)
{
if (displayServerLocation)
@@ -201,17 +198,13 @@
return instructionsPanel;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected boolean requiresScroll()
{
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected Component createInputPanel()
{
JPanel panel = UIFactory.makeJPanel();
@@ -237,9 +230,7 @@
return panel;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Object getFieldValue(FieldName fieldName)
{
Object value = null;
@@ -254,17 +245,13 @@
return value;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getInstructions()
{
return INFO_REVIEW_PANEL_INSTRUCTIONS.get();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getTitle()
{
return INFO_REVIEW_PANEL_TITLE.get();
@@ -644,9 +631,7 @@
return equivalentCommandPane;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected JComponent getBottomComponent()
{
if (bottomComponent == null)
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/InstallWelcomePanel.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/InstallWelcomePanel.java
index 5a6cf9c..f24346f 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/InstallWelcomePanel.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/InstallWelcomePanel.java
@@ -22,9 +22,8 @@
*
*
* Copyright 2006-2009 Sun Microsystems, Inc.
- * Portions Copyright 2011-2014 ForgeRock AS
+ * Portions Copyright 2011-2015 ForgeRock AS
*/
-
package org.opends.quicksetup.installer.ui;
import org.forgerock.i18n.LocalizableMessage;
@@ -40,7 +39,6 @@
/**
* This panel is used to show a welcome message.
- *
*/
public class InstallWelcomePanel extends QuickSetupStepPanel
{
@@ -55,17 +53,13 @@
super(app);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getTitle()
{
return INFO_WELCOME_PANEL_TITLE.get();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getInstructions()
{
/*
@@ -82,9 +76,7 @@
LocalizableMessage.class);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected Component createInputPanel()
{
// No input in this panel
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/RemoteReplicationPortsPanel.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/RemoteReplicationPortsPanel.java
index 33839a9..076a05f 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/RemoteReplicationPortsPanel.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/RemoteReplicationPortsPanel.java
@@ -77,8 +77,10 @@
private JPanel fieldsPanel;
private TreeSet<ServerDescriptor> orderedServers =
new TreeSet<ServerDescriptor>(this);
- //The display of the server the user provided in the replication options
- // panel
+ /**
+ *The display of the server the user provided in the replication options
+ * panel.
+ */
private String serverToConnectDisplay;
/**
@@ -91,9 +93,7 @@
super(application);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Object getFieldValue(FieldName fieldName)
{
Object value = null;
@@ -119,9 +119,7 @@
return value;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void displayFieldInvalid(FieldName fieldName, boolean invalid)
{
if (fieldName == FieldName.REMOTE_REPLICATION_PORT)
@@ -159,25 +157,19 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected boolean requiresScroll()
{
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int compare(ServerDescriptor desc1, ServerDescriptor desc2)
{
return desc1.getHostPort(true).compareTo(desc2.getHostPort(true));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected Component createInputPanel()
{
JPanel panel = new JPanel(new GridBagLayout());
@@ -200,25 +192,19 @@
return panel;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getInstructions()
{
return INFO_REMOTE_REPLICATION_PORT_INSTRUCTIONS.get();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getTitle()
{
return INFO_REMOTE_REPLICATION_PORT_TITLE.get();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void beginDisplay(UserData data)
{
TreeSet<ServerDescriptor> array = orderServers(
@@ -238,9 +224,7 @@
!newServerDisplay.equals(serverToConnectDisplay))
{
serverToConnectDisplay = newServerDisplay;
- /**
- * Adds the required focus listeners to the fields.
- */
+ // Adds the required focus listeners to the fields.
final FocusListener l = new FocusListener()
{
public void focusGained(FocusEvent e)
@@ -324,9 +308,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void endDisplay()
{
if (lastFocusComponent != null)
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/RuntimeOptionsPanel.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/RuntimeOptionsPanel.java
index 82a7207..4880568 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/RuntimeOptionsPanel.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/RuntimeOptionsPanel.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2010 Sun Microsystems, Inc.
- * Portions Copyright 2013-2014 ForgeRock AS.
+ * Portions Copyright 2013-2015 ForgeRock AS.
*/
package org.opends.quicksetup.installer.ui;
@@ -80,9 +80,10 @@
private JavaArguments defaultServerJavaArgs;
private JavaArguments defaultImportJavaArgs;
- // The size of the LDIF file to be imported used as threshold to display
- // a warning message, telling the user to update the import runtime
- // settings.
+ /**
+ * The size of the LDIF file to be imported used as threshold to display
+ * a warning message, telling the user to update the import runtime settings.
+ */
private static final long WARNING_THRESOLD_FOR_IMPORT = 200 * 1024 * 1024;
private static final int WARNING_THRESOLD_AUTOMATICALLY_GENERATED_IMPORT
= 100000;
@@ -100,9 +101,7 @@
addFocusListeners();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected Component createInputPanel()
{
JPanel panel = new JPanel(new GridBagLayout());
@@ -182,25 +181,19 @@
return panel;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getInstructions()
{
return INFO_JAVA_RUNTIME_OPTIONS_PANEL_INSTRUCTIONS.get();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getTitle()
{
return INFO_JAVA_RUNTIME_OPTIONS_PANEL_TITLE.get();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Object getFieldValue(FieldName fieldName)
{
@@ -216,9 +209,7 @@
return value;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void beginDisplay(UserData uData)
{
@@ -256,9 +247,7 @@
updateWarningMessage(uData);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void endDisplay()
{
if (lastFocusComponent != null)
@@ -267,9 +256,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean requiresScroll()
{
return false;
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/ServerSettingsPanel.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/ServerSettingsPanel.java
index 4d41f27..b8d8da9 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/ServerSettingsPanel.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/ServerSettingsPanel.java
@@ -22,9 +22,8 @@
*
*
* Copyright 2006-2010 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
-
package org.opends.quicksetup.installer.ui;
import java.awt.Component;
@@ -113,9 +112,7 @@
addFocusListeners();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Object getFieldValue(FieldName fieldName)
{
Object value = null;
@@ -156,9 +153,7 @@
return value;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void displayFieldInvalid(FieldName fieldName, boolean invalid)
{
JLabel label = getLabel(fieldName);
@@ -176,9 +171,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected Component createInputPanel()
{
JPanel panel = new JPanel(new GridBagLayout());
@@ -344,9 +337,7 @@
return panel;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getInstructions()
{
if (Utils.isWebStart())
@@ -359,17 +350,13 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getTitle()
{
return INFO_SERVER_SETTINGS_PANEL_TITLE.get();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void endDisplay()
{
if (lastFocusComponent != null)
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/SuffixesToReplicatePanel.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/SuffixesToReplicatePanel.java
index 775130c..a8012c7 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/SuffixesToReplicatePanel.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/ui/SuffixesToReplicatePanel.java
@@ -74,8 +74,10 @@
new TreeSet<SuffixDescriptor>(this);
private HashMap<String, JCheckBox> hmCheckBoxes =
new HashMap<String, JCheckBox>();
- // The display of the server the user provided in the replication options
- // panel
+ /**
+ * The display of the server the user provided in the replication options
+ * panel.
+ */
private String serverToConnectDisplay;
private JLabel noSuffixLabel;
@@ -94,9 +96,7 @@
createComponents();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Object getFieldValue(FieldName fieldName)
{
Object value = null;
@@ -121,9 +121,7 @@
return value;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int compare(SuffixDescriptor desc1, SuffixDescriptor desc2)
{
int result = compareSuffixDN(desc1, desc2);
@@ -134,9 +132,7 @@
return result;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected Component createInputPanel()
{
JPanel panel = new JPanel(new GridBagLayout());
@@ -179,33 +175,25 @@
return panel;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected boolean requiresScroll()
{
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getInstructions()
{
return INFO_SUFFIXES_TO_REPLICATE_PANEL_INSTRUCTIONS.get();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getTitle()
{
return INFO_SUFFIXES_TO_REPLICATE_PANEL_TITLE.get();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void beginDisplay(UserData data)
{
TreeSet<SuffixDescriptor> array = orderSuffixes(
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/webstart/WebStartInstaller.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/webstart/WebStartInstaller.java
index 18e51fd..45a13b2 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/webstart/WebStartInstaller.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/webstart/WebStartInstaller.java
@@ -22,9 +22,8 @@
*
*
* Copyright 2006-2010 Sun Microsystems, Inc.
- * Portions Copyright 2011-2014 ForgeRock AS
+ * Portions Copyright 2011-2015 ForgeRock AS
*/
-
package org.opends.quicksetup.installer.webstart;
import java.io.File;
@@ -335,18 +334,14 @@
System.setOut(origOut);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Integer getRatio(ProgressStep status)
{
return hmRatio.get(status);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage getSummary(ProgressStep status)
{
@@ -619,23 +614,17 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getInstallationPath()
{
return getUserData().getServerLocation();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getInstancePath()
{
- // TODO
return getUserData().getServerLocation();
-
}
}
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/ButtonsPanel.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/ButtonsPanel.java
index d1e2fce..5198c38 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/ButtonsPanel.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/ButtonsPanel.java
@@ -22,9 +22,8 @@
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
-
package org.opends.quicksetup.ui;
import org.forgerock.i18n.LocalizableMessage;
@@ -168,9 +167,6 @@
return b;
}
- /*
- * Create the buttons.
- */
private void createButtons()
{
GuiApplication application = getApplication();
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/CustomHTMLEditorKit.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/CustomHTMLEditorKit.java
index 7a88632..e93704f 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/CustomHTMLEditorKit.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/CustomHTMLEditorKit.java
@@ -55,9 +55,7 @@
super();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ViewFactory getViewFactory()
{
return new MyHTMLFactory();
@@ -86,9 +84,7 @@
*/
class MyHTMLFactory extends HTMLFactory
{
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public View create(Element elem)
{
View v = super.create(elem);
@@ -115,9 +111,7 @@
super(elem);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void actionPerformed(ActionEvent ev)
{
if (ev != null && ev.getWhen() != lastActionWhen) {
@@ -129,9 +123,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected Component createComponent()
{
Component comp = super.createComponent();
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/FinishedPanel.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/FinishedPanel.java
index 950aaab..eef4858 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/FinishedPanel.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/FinishedPanel.java
@@ -22,9 +22,8 @@
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
-
package org.opends.quicksetup.ui;
import org.forgerock.i18n.LocalizableMessage;
@@ -32,7 +31,6 @@
/**
* This panel is used to show the application is finished.
- *
*/
public class FinishedPanel extends ProgressPanel
{
@@ -47,9 +45,7 @@
super(application);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getTitle()
{
return INFO_FINISHED_PANEL_TITLE.get();
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/ProgressPanel.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/ProgressPanel.java
index cf195c1..75b69b6 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/ProgressPanel.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/ProgressPanel.java
@@ -22,9 +22,8 @@
*
*
* Copyright 2006-2009 Sun Microsystems, Inc.
- * Portions Copyright 2013-2014 ForgeRock AS.
+ * Portions Copyright 2013-2015 ForgeRock AS.
*/
-
package org.opends.quicksetup.ui;
import java.awt.Component;
@@ -75,9 +74,7 @@
super(application);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected Component createInputPanel()
{
JPanel panel = new JPanel(new GridBagLayout());
@@ -163,33 +160,25 @@
return panel;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getInstructions()
{
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected LocalizableMessage getTitle()
{
return INFO_PROGRESS_PANEL_TITLE.get();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected boolean requiresScroll()
{
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void endDisplay()
{
if (lastFocusComponent != null)
@@ -198,9 +187,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void displayProgress(ProgressDescriptor descriptor)
{
ProgressStep status = descriptor.getProgressStep();
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/QuickSetup.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/QuickSetup.java
index 3fd5ade..e6d4917 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/QuickSetup.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/QuickSetup.java
@@ -22,9 +22,8 @@
*
*
* Copyright 2006-2010 Sun Microsystems, Inc.
- * Portions Copyright 2011-2014 ForgeRock AS
+ * Portions Copyright 2011-2015 ForgeRock AS
*/
-
package org.opends.quicksetup.ui;
import org.opends.quicksetup.event.ButtonActionListener;
@@ -95,10 +94,10 @@
private ProgressDescriptor descriptorToDisplay;
- // Update period of the dialogs.
+ /** Update period of the dialogs. */
private static final int UPDATE_PERIOD = 500;
- // The full pathname of the MacOS X LaunchServices OPEN(1) helper.
+ /** The full pathname of the MacOS X LaunchServices OPEN(1) helper. */
private static final String MAC_APPLICATIONS_OPENER = "/usr/bin/open";
/**
@@ -378,10 +377,7 @@
setCurrentStep(Step.WELCOME);
}
- /**
- * Method called when user clicks 'Close' button of the wizard.
- *
- */
+ /** Method called when user clicks 'Close' button of the wizard. */
private void closeClicked()
{
WizardStep cStep = getCurrentStep();
@@ -418,7 +414,7 @@
Map<String, String> env = pb.environment();
env.put(SetupUtils.OPENDJ_JAVA_HOME, System.getProperty("java.home"));
Process process = pb.start();
- /**
+ /*
* Wait for 3 seconds. Assume that if the process has not exited
* everything went fine.
*/
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/QuickSetupStepPanel.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/QuickSetupStepPanel.java
index 197b44d..1c195b4 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/QuickSetupStepPanel.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/QuickSetupStepPanel.java
@@ -22,9 +22,8 @@
*
*
* Copyright 2006-2010 Sun Microsystems, Inc.
- * Portions Copyright 2013-2014 ForgeRock AS.
+ * Portions Copyright 2013-2015 ForgeRock AS.
*/
-
package org.opends.quicksetup.ui;
import java.awt.CardLayout;
@@ -77,8 +76,9 @@
private boolean isCheckingVisible;
- /* We can use a HashMap (not multi-thread safe) because all
- the calls to this object are done in the event-thread.
+ /**
+ * We can use a HashMap (not multi-thread safe) because all
+ * the calls to this object are done in the event-thread.
*/
private HashMap<String, URLWorker> hmURLWorkers =
new HashMap<String, URLWorker>();
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/ReviewPanel.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/ReviewPanel.java
index 161f1d8..751e223 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/ReviewPanel.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/ReviewPanel.java
@@ -22,8 +22,8 @@
*
*
* Copyright 2006-2010 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
-
package org.opends.quicksetup.ui;
import javax.swing.*;
@@ -51,9 +51,7 @@
*/
protected abstract JPanel createFieldsPanel();
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected Component createInputPanel()
{
JPanel panel = UIFactory.makeJPanel();
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/UIFactory.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/UIFactory.java
index 8f7497a..7753303 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/UIFactory.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/ui/UIFactory.java
@@ -1773,9 +1773,7 @@
setBorder(new EmptyBorder(3, 3, 3, 3));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void setText(String text)
{
@@ -1797,9 +1795,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void scrollRectToVisible(Rectangle rect)
{
@@ -1827,9 +1823,7 @@
{
this.tf = tf;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void focusGained(FocusEvent e)
{
if ((tf.getText() == null) || "".equals(tf.getText()))
@@ -1844,9 +1838,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void focusLost(FocusEvent e)
{
}
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/util/BackgroundTaskThread.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/util/BackgroundTaskThread.java
index 41ab0e1..4321df7 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/util/BackgroundTaskThread.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/util/BackgroundTaskThread.java
@@ -22,23 +22,21 @@
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
package org.opends.quicksetup.util;
import javax.swing.SwingUtilities;
-
-
/**
* This class defines a thread that will be used to actually perform the
* processing for a background task.
- * @param <T> type of object returned by the background task fed to this
- * object
+ * @param <T> type of object returned by the background task fed to this object
*/
class BackgroundTaskThread<T>
extends Thread
{
- // The background task that is to be processed.
+ /** The background task that is to be processed. */
private final BackgroundTask<T> backgroundTask;
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/util/ExtensionFileFilter.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/util/ExtensionFileFilter.java
index 8a0c2b2..e2e37fe 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/util/ExtensionFileFilter.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/util/ExtensionFileFilter.java
@@ -22,9 +22,8 @@
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
-
package org.opends.quicksetup.util;
import java.io.File;
@@ -35,7 +34,6 @@
/**
* This is a class used to be able to filter on certain type of files
* in the File Browser dialog.
- *
*/
public class ExtensionFileFilter extends FileFilter
{
@@ -54,9 +52,7 @@
this.description = description;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean accept(File f)
{
boolean accept = false;
@@ -77,9 +73,7 @@
return accept;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getDescription()
{
return description;
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/util/FileManager.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/util/FileManager.java
index c110191..c5c4628 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/util/FileManager.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/util/FileManager.java
@@ -447,9 +447,7 @@
this.overwrite = overwrite;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public FileOperation copyForChild(File child) {
return new CopyOperation(child, destination, overwrite);
@@ -464,9 +462,7 @@
return this.destination;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void apply() throws ApplicationException {
File objectFile = getObjectFile();
@@ -568,17 +564,13 @@
this.deletionPolicy = deletionPolicy;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public FileOperation copyForChild(File child) {
return new DeleteOperation(child, deletionPolicy);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void apply() throws ApplicationException {
File file = getObjectFile();
@@ -663,17 +655,13 @@
this.destination = new File(newParent, objectFile.getName());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public FileOperation copyForChild(File child) {
return new MoveOperation(child, destination);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void apply() throws ApplicationException {
File objectFile = getObjectFile();
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/util/PlainTextProgressMessageFormatter.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/util/PlainTextProgressMessageFormatter.java
index d5049ba..da53d72 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/util/PlainTextProgressMessageFormatter.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/util/PlainTextProgressMessageFormatter.java
@@ -22,14 +22,13 @@
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
-
package org.opends.quicksetup.util;
+
import org.forgerock.i18n.LocalizableMessage;
import org.forgerock.i18n.LocalizableMessageBuilder;
-
import org.opends.quicksetup.Constants;
import static org.opends.messages.QuickSetupMessages.*;
@@ -37,7 +36,6 @@
/**
* This is an implementation of the ProgressMessageFormatter class that
* provides format in plain text.
- *
*/
public class PlainTextProgressMessageFormatter
implements ProgressMessageFormatter
@@ -285,9 +283,7 @@
Constants.LINE_SEPARATOR+Constants.LINE_SEPARATOR);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public LocalizableMessage getFormattedAfterUrlClick(String url, LocalizableMessage lastText)
{
throw new IllegalStateException(
diff --git a/opendj-server-legacy/src/main/java/org/opends/quicksetup/util/URLWorker.java b/opendj-server-legacy/src/main/java/org/opends/quicksetup/util/URLWorker.java
index 216e617..afaeb20 100644
--- a/opendj-server-legacy/src/main/java/org/opends/quicksetup/util/URLWorker.java
+++ b/opendj-server-legacy/src/main/java/org/opends/quicksetup/util/URLWorker.java
@@ -22,9 +22,8 @@
*
*
* Copyright 2006-2010 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
-
package org.opends.quicksetup.util;
import org.forgerock.i18n.LocalizableMessage;
@@ -64,9 +63,7 @@
this.url = url;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Object processBackgroundTask() throws WebBrowserException
{
try
@@ -80,9 +77,7 @@
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void backgroundTaskCompleted(Object returnValue,
Throwable throwable)
{
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/ACIPropertyDefinition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/ACIPropertyDefinition.java
index 2f94dfc..5dd9a6a 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/ACIPropertyDefinition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/ACIPropertyDefinition.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin;
@@ -48,15 +48,13 @@
public static class Builder extends
AbstractBuilder<Aci, ACIPropertyDefinition> {
- // Private constructor
+ /** Private constructor. */
private Builder(
AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
super(d, propertyName);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected ACIPropertyDefinition buildInstance(
AbstractManagedObjectDefinition<?, ?> d,
@@ -85,7 +83,7 @@
}
- // Private constructor.
+ /** Private constructor. */
private ACIPropertyDefinition(
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options,
@@ -96,9 +94,7 @@
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(Aci value)
throws PropertyException {
@@ -107,9 +103,7 @@
// No additional validation required.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Aci decodeValue(String value)
throws PropertyException {
@@ -124,26 +118,20 @@
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitACI(this, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, Aci value, P p) {
return v.visitACI(this, value, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compare(Aci o1, Aci o2) {
return o1.toString().compareTo(o2.toString());
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/AbsoluteInheritedDefaultBehaviorProvider.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/AbsoluteInheritedDefaultBehaviorProvider.java
index 52ae50e..abd862e 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/AbsoluteInheritedDefaultBehaviorProvider.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/AbsoluteInheritedDefaultBehaviorProvider.java
@@ -40,14 +40,16 @@
public final class AbsoluteInheritedDefaultBehaviorProvider<T> extends
DefaultBehaviorProvider<T> {
- // The absolute path to the managed object containing the property.
+ /** The absolute path to the managed object containing the property. */
private ManagedObjectPath<?, ?> path;
- // The string representation of the managed object path specifying
- // the absolute location of the managed object.
+ /**
+ * The string representation of the managed object path specifying
+ * the absolute location of the managed object.
+ */
private final String pathString;
- // The name of the property containing the inherited default values.
+ /** The name of the property containing the inherited default values. */
private final String propertyName;
@@ -71,9 +73,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <R, P> R accept(DefaultBehaviorProviderVisitor<T, R, P> v, P p) {
return v.visitAbsoluteInherited(this, p);
}
@@ -119,9 +119,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected void initialize() throws Exception {
// Decode the path.
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/AbstractManagedObjectDefinition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/AbstractManagedObjectDefinition.java
index ec9f288..d6c1134 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/AbstractManagedObjectDefinition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/AbstractManagedObjectDefinition.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2007-2010 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin;
@@ -65,58 +65,76 @@
public abstract class AbstractManagedObjectDefinition
<C extends ConfigurationClient, S extends Configuration> {
- // The name of the definition.
+ /** The name of the definition. */
private final String name;
- // The parent managed object definition if applicable.
+ /** The parent managed object definition if applicable. */
private final AbstractManagedObjectDefinition<? super C, ? super S> parent;
- // The set of constraints associated with this managed object
- // definition.
+ /**
+ * The set of constraints associated with this managed object
+ * definition.
+ */
private final Collection<Constraint> constraints;
- // The set of property definitions applicable to this managed object
- // definition.
+ /**
+ * The set of property definitions applicable to this managed object
+ * definition.
+ */
private final Map<String, PropertyDefinition<?>> propertyDefinitions;
- // The set of relation definitions applicable to this managed object
- // definition.
+ /**
+ * The set of relation definitions applicable to this managed object
+ * definition.
+ */
private final Map<String, RelationDefinition<?, ?>> relationDefinitions;
- // The set of relation definitions directly referencing this managed
- // object definition.
+ /**
+ * The set of relation definitions directly referencing this managed
+ * object definition.
+ */
private final Set<RelationDefinition<C, S>> reverseRelationDefinitions;
- // The set of all property definitions associated with this managed
- // object definition including inherited property definitions.
+ /**
+ * The set of all property definitions associated with this managed
+ * object definition including inherited property definitions.
+ */
private final Map<String, PropertyDefinition<?>> allPropertyDefinitions;
- // The set of all relation definitions associated with this managed
- // object definition including inherited relation definitions.
+ /**
+ * The set of all relation definitions associated with this managed
+ * object definition including inherited relation definitions.
+ */
private final Map<String, RelationDefinition<?, ?>> allRelationDefinitions;
- // The set of aggregation property definitions applicable to this
- // managed object definition.
+ /**
+ * The set of aggregation property definitions applicable to this
+ * managed object definition.
+ */
private final Map<String, AggregationPropertyDefinition<?, ?>>
aggregationPropertyDefinitions;
- // The set of aggregation property definitions directly referencing this
- // managed object definition.
+ /**
+ * The set of aggregation property definitions directly referencing this
+ * managed object definition.
+ */
private final Vector<AggregationPropertyDefinition<?, ?>>
reverseAggregationPropertyDefinitions;
- // The set of all aggregation property definitions associated with this
- // managed object definition including inherited relation definitions.
+ /**
+ * The set of all aggregation property definitions associated with this
+ * managed object definition including inherited relation definitions.
+ */
private final Map<String, AggregationPropertyDefinition<?, ?>>
allAggregationPropertyDefinitions;
- // The set of tags associated with this managed object.
+ /** The set of tags associated with this managed object. */
private final Set<Tag> allTags;
- // Options applicable to this definition.
+ /** Options applicable to this definition. */
private final Set<ManagedObjectOption> options;
- // The set of managed object definitions which inherit from this definition.
+ /** The set of managed object definitions which inherit from this definition. */
private final Map<String,
AbstractManagedObjectDefinition<? extends C, ? extends S>> children;
@@ -907,9 +925,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final String toString() {
StringBuilder builder = new StringBuilder();
@@ -1115,8 +1131,10 @@
- // Register a relation definition in the referenced managed object
- // definition's reverse lookup table.
+ /**
+ * Register a relation definition in the referenced managed object
+ * definition's reverse lookup table.
+ */
private <CC extends ConfigurationClient, SS extends Configuration>
void registerReverseRelationDefinition(RelationDefinition<CC, SS> rd) {
rd.getChildDefinition().reverseRelationDefinitions.add(rd);
@@ -1124,8 +1142,10 @@
- // Register a aggregation property definition in the referenced managed object
- // definition's reverse lookup table.
+ /**
+ * Register a aggregation property definition in the referenced managed object
+ * definition's reverse lookup table.
+ */
private void registerReverseAggregationPropertyDefinition(
AggregationPropertyDefinition<?, ?> apd) {
@@ -1135,7 +1155,7 @@
- // Recursively descend definition hierarchy to find the best match definition.
+ /** Recursively descend definition hierarchy to find the best match definition. */
private AbstractManagedObjectDefinition<? extends C, ? extends S>
resolveManagedObjectDefinitionAux(
AbstractManagedObjectDefinition<? extends C, ? extends S> d,
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/AdministratorAction.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/AdministratorAction.java
index 2709ea4..bbdede7 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/AdministratorAction.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/AdministratorAction.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin;
import org.forgerock.i18n.LocalizableMessage;
@@ -86,21 +86,19 @@
*/
SERVER_RESTART("server-restart");
- // The user-friendly name of the type.
+ /** The user-friendly name of the type. */
private final String name;
- // Private constructor.
+ /** Private constructor. */
private Type(String name) {
this.name = name;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
return name;
@@ -108,15 +106,19 @@
}
- // The managed object definition associated with this administrator
- // action.
+ /**
+ * The managed object definition associated with this administrator
+ * action.
+ */
private final AbstractManagedObjectDefinition<?, ?> definition;
- // The name of the property definition associated with this
- // administrator action.
+ /**
+ * The name of the property definition associated with this
+ * administrator action.
+ */
private final String propertyName;
- // The type of administration action.
+ /** The type of administration action. */
private final Type type;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/AggregationPropertyDefinition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/AggregationPropertyDefinition.java
index a6f3551..370a1f7 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/AggregationPropertyDefinition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/AggregationPropertyDefinition.java
@@ -121,25 +121,33 @@
<C extends ConfigurationClient, S extends Configuration>
extends AbstractBuilder<String, AggregationPropertyDefinition<C, S>> {
- // The string representation of the managed object path specifying
- // the parent of the aggregated managed objects.
+ /**
+ * The string representation of the managed object path specifying
+ * the parent of the aggregated managed objects.
+ */
private String parentPathString;
- // The name of a relation in the parent managed object which
- // contains the aggregated managed objects.
+ /**
+ * The name of a relation in the parent managed object which
+ * contains the aggregated managed objects.
+ */
private String rdName;
- // The condition which is used to determine if a referenced
- // managed object is enabled.
+ /**
+ * The condition which is used to determine if a referenced
+ * managed object is enabled.
+ */
private Condition targetIsEnabledCondition = Conditions.TRUE;
- // The condition which is used to determine whether or not
- // referenced managed objects need to be enabled.
+ /**
+ * The condition which is used to determine whether or not
+ * referenced managed objects need to be enabled.
+ */
private Condition targetNeedsEnablingCondition = Conditions.TRUE;
- // Private constructor
+ /** Private constructor. */
private Builder(AbstractManagedObjectDefinition<?, ?> d,
String propertyName) {
super(d, propertyName);
@@ -212,9 +220,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected AggregationPropertyDefinition<C, S> buildInstance(
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
@@ -246,16 +252,18 @@
private class ReferentialIntegrityChangeListener implements
ServerManagedObjectChangeListener<S> {
- // The error message which should be returned if an attempt is
- // made to disable the referenced component.
+ /**
+ * The error message which should be returned if an attempt is
+ * made to disable the referenced component.
+ */
private final LocalizableMessage message;
- // The path of the referenced component.
+ /** The path of the referenced component. */
private final ManagedObjectPath<C, S> path;
- // Creates a new referential integrity delete listener.
+ /** Creates a new referential integrity delete listener. */
private ReferentialIntegrityChangeListener(ManagedObjectPath<C, S> path,
LocalizableMessage message) {
this.path = path;
@@ -264,9 +272,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ConfigChangeResult applyConfigurationChange(
ServerManagedObject<? extends S> mo) {
try {
@@ -286,9 +292,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isConfigurationChangeAcceptable(
ServerManagedObject<? extends S> mo,
List<LocalizableMessage> unacceptableReasons) {
@@ -313,7 +317,7 @@
- // Gets the path associated with this listener.
+ /** Gets the path associated with this listener. */
private ManagedObjectPath<C, S> getManagedObjectPath() {
return path;
}
@@ -329,16 +333,18 @@
private class ReferentialIntegrityDeleteListener implements
ConfigurationDeleteListener<S> {
- // The DN of the referenced configuration entry.
+ /** The DN of the referenced configuration entry. */
private final DN dn;
- // The error message which should be returned if an attempt is
- // made to delete the referenced component.
+ /**
+ * The error message which should be returned if an attempt is
+ * made to delete the referenced component.
+ */
private final LocalizableMessage message;
- // Creates a new referential integrity delete listener.
+ /** Creates a new referential integrity delete listener. */
private ReferentialIntegrityDeleteListener(DN dn, LocalizableMessage message) {
this.dn = dn;
this.message = message;
@@ -346,9 +352,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ConfigChangeResult applyConfigurationDelete(S configuration) {
// This should not happen - the
// isConfigurationDeleteAcceptable() call-back should have
@@ -366,9 +370,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isConfigurationDeleteAcceptable(S configuration,
List<LocalizableMessage> unacceptableReasons) {
if (configuration.dn().equals(dn)) {
@@ -389,9 +391,7 @@
*/
private class ServerHandler extends ServerConstraintHandler {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isUsable(ServerManagedObject<?> managedObject,
Collection<LocalizableMessage> unacceptableReasons) throws ConfigException {
@@ -433,9 +433,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void performPostAdd(ServerManagedObject<?> managedObject)
throws ConfigException {
@@ -502,9 +500,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void performPostDelete(ServerManagedObject<?> managedObject)
throws ConfigException {
@@ -537,9 +533,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void performPostModify(ServerManagedObject<?> managedObject)
throws ConfigException {
@@ -559,9 +553,7 @@
*/
private class SourceClientHandler extends ClientConstraintHandler {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isAddAcceptable(ManagementContext context,
ManagedObject<?> managedObject, Collection<LocalizableMessage> unacceptableReasons)
@@ -615,9 +607,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isModifyAcceptable(ManagementContext context,
ManagedObject<?> managedObject, Collection<LocalizableMessage> unacceptableReasons)
@@ -637,9 +627,7 @@
*/
private class TargetClientHandler extends ClientConstraintHandler {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isDeleteAcceptable(ManagementContext context,
ManagedObjectPath<?, ?> path, Collection<LocalizableMessage> unacceptableReasons)
@@ -668,9 +656,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isModifyAcceptable(ManagementContext context,
ManagedObject<?> managedObject, Collection<LocalizableMessage> unacceptableReasons)
@@ -708,8 +694,10 @@
- // Find all managed objects which reference the named managed
- // object using this property.
+ /**
+ * Find all managed objects which reference the named managed
+ * object using this property.
+ */
private <CC extends ConfigurationClient>
List<ManagedObject<? extends CC>> findReferences(
ManagementContext context, AbstractManagedObjectDefinition<CC, ?> mod,
@@ -739,7 +727,7 @@
- // Find all instances of a specific type of managed object.
+ /** Find all instances of a specific type of managed object. */
@SuppressWarnings("unchecked")
private <CC extends ConfigurationClient>
List<ManagedObject<? extends CC>> findInstances(
@@ -818,48 +806,64 @@
return new Builder<C, S>(d, propertyName);
}
- // The active server-side referential integrity change listeners
- // associated with this property.
+ /**
+ * The active server-side referential integrity change listeners
+ * associated with this property.
+ */
private final Map<DN, List<ReferentialIntegrityChangeListener>>
changeListeners = new HashMap<DN,
List<ReferentialIntegrityChangeListener>>();
- // The active server-side referential integrity delete listeners
- // associated with this property.
+ /**
+ * The active server-side referential integrity delete listeners
+ * associated with this property.
+ */
private final Map<DN, List<ReferentialIntegrityDeleteListener>>
deleteListeners = new HashMap<DN,
List<ReferentialIntegrityDeleteListener>>();
- // The name of the managed object which is the parent of the
- // aggregated managed objects.
+ /**
+ * The name of the managed object which is the parent of the
+ * aggregated managed objects.
+ */
private ManagedObjectPath<?, ?> parentPath;
- // The string representation of the managed object path specifying
- // the parent of the aggregated managed objects.
+ /**
+ * The string representation of the managed object path specifying
+ * the parent of the aggregated managed objects.
+ */
private final String parentPathString;
- // The name of a relation in the parent managed object which
- // contains the aggregated managed objects.
+ /**
+ * The name of a relation in the parent managed object which
+ * contains the aggregated managed objects.
+ */
private final String rdName;
- // The relation in the parent managed object which contains the
- // aggregated managed objects.
+ /**
+ * The relation in the parent managed object which contains the
+ * aggregated managed objects.
+ */
private InstantiableRelationDefinition<C, S> relationDefinition;
- // The source constraint.
+ /** The source constraint. */
private final Constraint sourceConstraint;
- // The condition which is used to determine if a referenced managed
- // object is enabled.
+ /**
+ * The condition which is used to determine if a referenced managed
+ * object is enabled.
+ */
private final Condition targetIsEnabledCondition;
- // The condition which is used to determine whether or not
- // referenced managed objects need to be enabled.
+ /**
+ * The condition which is used to determine whether or not
+ * referenced managed objects need to be enabled.
+ */
private final Condition targetNeedsEnablingCondition;
- // Private constructor.
+ /** Private constructor. */
private AggregationPropertyDefinition(
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options, AdministratorAction adminAction,
@@ -874,9 +878,7 @@
this.targetIsEnabledCondition = targetIsEnabledCondition;
this.sourceConstraint = new Constraint() {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<ClientConstraintHandler> getClientConstraintHandlers() {
ClientConstraintHandler handler = new SourceClientHandler();
return Collections.singleton(handler);
@@ -884,9 +886,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<ServerConstraintHandler> getServerConstraintHandlers() {
ServerConstraintHandler handler = new ServerHandler();
return Collections.singleton(handler);
@@ -896,9 +896,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitAggregation(this, p);
@@ -906,9 +904,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, String value, P p) {
return v.visitAggregation(this, value, p);
@@ -916,9 +912,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String decodeValue(String value)
throws PropertyException {
@@ -1079,9 +1073,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String normalizeValue(String value)
throws PropertyException {
@@ -1096,9 +1088,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void toString(StringBuilder builder) {
super.toString(builder);
@@ -1111,9 +1101,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(String value) throws PropertyException {
try {
@@ -1125,9 +1113,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
@Override
public void initialize() throws Exception {
@@ -1149,9 +1135,7 @@
// for actions performed against referenced managed objects.
Constraint constraint = new Constraint() {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<ClientConstraintHandler> getClientConstraintHandlers() {
ClientConstraintHandler handler = new TargetClientHandler();
return Collections.singleton(handler);
@@ -1159,9 +1143,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<ServerConstraintHandler> getServerConstraintHandlers() {
return Collections.emptyList();
}
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/AliasDefaultBehaviorProvider.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/AliasDefaultBehaviorProvider.java
index 1c3ac32..70b74df 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/AliasDefaultBehaviorProvider.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/AliasDefaultBehaviorProvider.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin;
import org.forgerock.i18n.LocalizableMessage;
@@ -45,12 +45,16 @@
public final class AliasDefaultBehaviorProvider<T> extends
DefaultBehaviorProvider<T> {
- // The managed object definition associated with this default
- // behavior.
+ /**
+ * The managed object definition associated with this default
+ * behavior.
+ */
private final AbstractManagedObjectDefinition<?, ?> definition;
- // The name of the property definition associated with this default
- // behavior.
+ /**
+ * The name of the property definition associated with this default
+ * behavior.
+ */
private final String propertyName;
@@ -73,9 +77,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <R, P> R accept(DefaultBehaviorProviderVisitor<T, R, P> v, P p) {
return v.visitAlias(this, p);
}
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/AttributeTypePropertyDefinition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/AttributeTypePropertyDefinition.java
index 29f367f..f425bc3 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/AttributeTypePropertyDefinition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/AttributeTypePropertyDefinition.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin;
@@ -51,7 +51,7 @@
public static class Builder extends
AbstractBuilder<AttributeType, AttributeTypePropertyDefinition> {
- // Private constructor
+ /** Private constructor. */
private Builder(AbstractManagedObjectDefinition<?, ?> d,
String propertyName) {
super(d, propertyName);
@@ -59,9 +59,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected AttributeTypePropertyDefinition buildInstance(
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
@@ -73,8 +71,10 @@
}
}
- // Flag indicating whether or not attribute type names should be
- // validated against the schema.
+ /**
+ * Flag indicating whether or not attribute type names should be
+ * validated against the schema.
+ */
private static boolean isCheckSchema = true;
@@ -126,7 +126,7 @@
- // Private constructor.
+ /** Private constructor. */
private AttributeTypePropertyDefinition(
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options,
@@ -138,9 +138,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitAttributeType(this, p);
@@ -148,9 +146,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v,
AttributeType value, P p) {
@@ -159,9 +155,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compare(AttributeType o1, AttributeType o2) {
return o1.getNameOrOID().compareToIgnoreCase(o2.getNameOrOID());
@@ -169,9 +163,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public AttributeType decodeValue(String value)
throws PropertyException {
@@ -195,9 +187,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String encodeValue(AttributeType value)
throws PropertyException {
@@ -206,9 +196,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(AttributeType value)
throws PropertyException {
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/BooleanPropertyDefinition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/BooleanPropertyDefinition.java
index cdc97b2..4af41a9 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/BooleanPropertyDefinition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/BooleanPropertyDefinition.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin;
@@ -65,7 +65,7 @@
public static class Builder extends
AbstractBuilder<Boolean, BooleanPropertyDefinition> {
- // Private constructor
+ /** Private constructor. */
private Builder(
AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
super(d, propertyName);
@@ -73,9 +73,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected BooleanPropertyDefinition buildInstance(
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
@@ -107,7 +105,7 @@
- // Private constructor.
+ /** Private constructor. */
private BooleanPropertyDefinition(
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options,
@@ -119,9 +117,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(Boolean value)
throws PropertyException {
@@ -132,9 +128,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Boolean decodeValue(String value)
throws PropertyException {
@@ -152,9 +146,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitBoolean(this, p);
@@ -162,9 +154,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, Boolean value, P p) {
return v.visitBoolean(this, value, p);
@@ -172,9 +162,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compare(Boolean o1, Boolean o2) {
return o1.compareTo(o2);
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/ClassLoaderProvider.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/ClassLoaderProvider.java
index d71150e..f73c9b0 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/ClassLoaderProvider.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/ClassLoaderProvider.java
@@ -129,28 +129,34 @@
}
- // The name of the manifest file listing the core configuration
- // definition classes.
+ /**
+ * The name of the manifest file listing the core configuration
+ * definition classes.
+ */
private static final String CORE_MANIFEST = "core.manifest";
- // The name of the manifest file listing a extension's configuration
- // definition classes.
+ /**
+ * The name of the manifest file listing a extension's configuration
+ * definition classes.
+ */
private static final String EXTENSION_MANIFEST = "extension.manifest";
- // The name of the lib directory.
+ /** The name of the lib directory. */
private static final String LIB_DIR = "lib";
- // The name of the extensions directory.
+ /** The name of the extensions directory. */
private static final String EXTENSIONS_DIR = "extensions";
- // The singleton instance.
+ /** The singleton instance. */
private static final ClassLoaderProvider INSTANCE = new ClassLoaderProvider();
- // Attribute name in jar's MANIFEST corresponding to the revision number.
+ /** Attribute name in jar's MANIFEST corresponding to the revision number. */
private static final String REVISION_NUMBER = "Revision-Number";
- // The attribute names for build information is name, version and revision
- // number
+ /**
+ * The attribute names for build information is name, version and revision
+ * number.
+ */
private static final String[] BUILD_INFORMATION_ATTRIBUTE_NAMES =
new String[]{Attributes.Name.EXTENSION_NAME.toString(),
Attributes.Name.IMPLEMENTATION_VERSION.toString(),
@@ -167,22 +173,22 @@
return INSTANCE;
}
- // Set of registered Jar files.
+ /** Set of registered Jar files. */
private Set<File> jarFiles = new HashSet<File>();
- // Underlying class loader used to load classes and resources (null
- // if disabled).
- //
- // We contain a reference to the URLClassLoader rather than
- // sub-class it so that it is possible to replace the loader at
- // run-time. For example, when removing or replacing extension Jar
- // files (the URLClassLoader only supports adding new
- // URLs, not removal).
+ /**
+ * Underlying class loader used to load classes and resources (null
+ * if disabled).<br>
+ * We contain a reference to the URLClassLoader rather than
+ * sub-class it so that it is possible to replace the loader at run-time.
+ * For example, when removing or replacing extension Jar files
+ * (the URLClassLoader only supports adding new URLs, not removal).
+ */
private MyURLClassLoader loader;
- // Private constructor.
+ /** Private constructor. */
private ClassLoaderProvider() {
// No implementation required.
}
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/ClassPropertyDefinition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/ClassPropertyDefinition.java
index 2324ff3..f09e0a4 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/ClassPropertyDefinition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/ClassPropertyDefinition.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2013-2014 ForgeRock AS.
+ * Portions Copyright 2013-2015 ForgeRock AS.
*/
package org.opends.server.admin;
@@ -62,12 +62,12 @@
public static class Builder extends
AbstractBuilder<String, ClassPropertyDefinition> {
- // List of interfaces which property values must implement.
+ /** List of interfaces which property values must implement. */
private List<String> instanceOfInterfaces;
- // Private constructor
+ /** Private constructor. */
private Builder(
AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
super(d, propertyName);
@@ -118,9 +118,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected ClassPropertyDefinition buildInstance(
AbstractManagedObjectDefinition<?, ?> d,
@@ -133,11 +131,11 @@
}
- // Regular expression for validating class names.
+ /** Regular expression for validating class names. */
private static final String CLASS_RE =
"^([A-Za-z][A-Za-z0-9_]*\\.)*[A-Za-z][A-Za-z0-9_]*(\\$[A-Za-z0-9_]+)*$";
- /*
+ /**
* Flag indicating whether class property values should be validated.
*/
private static boolean allowClassValidation = true;
@@ -193,19 +191,19 @@
- // Load a named class.
+ /** Load a named class. */
private static Class<?> loadClass(String className, boolean initialize)
throws ClassNotFoundException, LinkageError {
return Class.forName(className, initialize, ClassLoaderProvider
.getInstance().getClassLoader());
}
- // List of interfaces which property values must implement.
+ /** List of interfaces which property values must implement. */
private final List<String> instanceOfInterfaces;
- // Private constructor.
+ /** Private constructor. */
private ClassPropertyDefinition(
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options,
@@ -220,9 +218,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitClass(this, p);
@@ -230,9 +226,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, String value, P p) {
return v.visitClass(this, value, p);
@@ -240,9 +234,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String decodeValue(String value)
throws PropertyException {
@@ -306,9 +298,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String normalizeValue(String value)
throws PropertyException {
@@ -319,9 +309,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(String value)
throws PropertyException {
@@ -341,7 +329,7 @@
- /*
+ /**
* Make sure that named class implements the interfaces named by this
* definition.
*/
@@ -376,7 +364,7 @@
- /*
+ /**
* Do some basic checks to make sure the string representation is valid.
*/
private void validateClassName(String className)
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/DNPropertyDefinition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/DNPropertyDefinition.java
index d288775..3303a54 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/DNPropertyDefinition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/DNPropertyDefinition.java
@@ -43,8 +43,10 @@
*/
public final class DNPropertyDefinition extends PropertyDefinition<DN> {
- // Optional base DN which all valid values must be immediately
- // subordinate to.
+ /**
+ * Optional base DN which all valid values must be immediately
+ * subordinate to.
+ */
private final DN baseDN;
@@ -56,13 +58,15 @@
public static class Builder extends
AbstractBuilder<DN, DNPropertyDefinition> {
- // Optional base DN which all valid values must be immediately
- // subordinate to.
+ /**
+ * Optional base DN which all valid values must be immediately
+ * subordinate to.
+ */
private DN baseDN;
- // Private constructor
+ /** Private constructor. */
private Builder(
AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
super(d, propertyName);
@@ -108,9 +112,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected DNPropertyDefinition buildInstance(
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
@@ -141,7 +143,7 @@
- // Private constructor.
+ /** Private constructor. */
private DNPropertyDefinition(
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options,
@@ -166,9 +168,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(DN value)
throws PropertyException {
@@ -189,9 +189,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public DN decodeValue(String value)
throws PropertyException {
@@ -210,9 +208,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitDN(this, p);
@@ -220,9 +216,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, DN value, P p) {
return v.visitDN(this, value, p);
@@ -230,9 +224,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compare(DN o1, DN o2) {
return o1.compareTo(o2);
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/DefaultManagedObject.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/DefaultManagedObject.java
index 09a16eb..de8c6b0 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/DefaultManagedObject.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/DefaultManagedObject.java
@@ -22,6 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
package org.opends.server.admin;
@@ -62,10 +63,10 @@
public static final class Builder
<C extends ConfigurationClient, S extends Configuration> {
- // The default managed object's definition.
+ /** The default managed object's definition. */
private final ManagedObjectDefinition<C, S> definition;
- // The string encoded default managed object's properties.
+ /** The string encoded default managed object's properties. */
private final Map<String, List<String>> propertyStringValues =
new HashMap<String, List<String>>();
@@ -114,15 +115,15 @@
}
}
- // The default managed object's definition.
+ /** The default managed object's definition. */
private final ManagedObjectDefinition<C, S> definition;
- // The string encoded default managed object's properties.
+ /** The string encoded default managed object's properties. */
private final Map<String, List<String>> propertyStringValues;
- // Private constructor.
+ /** Private constructor. */
private DefaultManagedObject(ManagedObjectDefinition<C, S> definition,
Map<String, List<String>> propertyStringValues) {
this.definition = definition;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/DefinedDefaultBehaviorProvider.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/DefinedDefaultBehaviorProvider.java
index f6ece41..f4e37cb 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/DefinedDefaultBehaviorProvider.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/DefinedDefaultBehaviorProvider.java
@@ -22,6 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
package org.opends.server.admin;
@@ -44,7 +45,7 @@
public final class DefinedDefaultBehaviorProvider<T> extends
DefaultBehaviorProvider<T> {
- // The collection of default values.
+ /** The collection of default values. */
private final Collection<String> values;
@@ -70,9 +71,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <R, P> R accept(DefaultBehaviorProviderVisitor<T, R, P> v, P p) {
return v.visitDefined(this, p);
}
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/DefinitionDecodingException.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/DefinitionDecodingException.java
index e0f313f..8c1fdb8 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/DefinitionDecodingException.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/DefinitionDecodingException.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin;
@@ -74,7 +74,7 @@
- // Create the message.
+ /** Create the message. */
private static LocalizableMessage createMessage(AbstractManagedObjectDefinition<?, ?> d,
Reason reason) {
LocalizableMessage ufn = d.getUserFriendlyName();
@@ -88,10 +88,10 @@
}
}
- // The expected type of managed object.
+ /** The expected type of managed object. */
private final AbstractManagedObjectDefinition<?, ?> d;
- // The reason why the definition could not be determined.
+ /** The reason why the definition could not be determined. */
private final Reason reason;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/DurationPropertyDefinition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/DurationPropertyDefinition.java
index ea7f530..517d1be 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/DurationPropertyDefinition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/DurationPropertyDefinition.java
@@ -62,24 +62,26 @@
*/
public final class DurationPropertyDefinition extends PropertyDefinition<Long> {
- // String used to represent unlimited durations.
+ /** String used to represent unlimited durations. */
private static final String UNLIMITED = "unlimited";
- // The base unit for this property definition.
+ /** The base unit for this property definition. */
private final DurationUnit baseUnit;
- // The optional maximum unit for this property definition.
+ /** The optional maximum unit for this property definition. */
private final DurationUnit maximumUnit;
- // The lower limit of the property value in milli-seconds.
+ /** The lower limit of the property value in milli-seconds. */
private final long lowerLimit;
- // The optional upper limit of the property value in milli-seconds.
+ /** The optional upper limit of the property value in milli-seconds. */
private final Long upperLimit;
- // Indicates whether this property allows the use of the "unlimited"
- // duration value (represented using a -1L or the string
- // "unlimited").
+ /**
+ * Indicates whether this property allows the use of the "unlimited"
+ * duration value (represented using a -1L or the string
+ * "unlimited").
+ */
private final boolean allowUnlimited;
@@ -91,27 +93,31 @@
public static class Builder extends
AbstractBuilder<Long, DurationPropertyDefinition> {
- // The base unit for this property definition.
+ /** The base unit for this property definition. */
private DurationUnit baseUnit = DurationUnit.SECONDS;
- // The optional maximum unit for this property definition.
+ /** The optional maximum unit for this property definition. */
private DurationUnit maximumUnit;
- // The lower limit of the property value in milli-seconds.
+ /** The lower limit of the property value in milli-seconds. */
private long lowerLimit;
- // The optional upper limit of the property value in
- // milli-seconds.
+ /**
+ * The optional upper limit of the property value in
+ * milli-seconds.
+ */
private Long upperLimit;
- // Indicates whether this property allows the use of the
- // "unlimited" duration value (represented using a -1L or the
- // string "unlimited").
+ /**
+ * Indicates whether this property allows the use of the
+ * "unlimited" duration value (represented using a -1L or the
+ * string "unlimited").
+ */
private boolean allowUnlimited;
- // Private constructor
+ /** Private constructor. */
private Builder(AbstractManagedObjectDefinition<?, ?> d,
String propertyName) {
super(d, propertyName);
@@ -335,9 +341,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected DurationPropertyDefinition buildInstance(
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
@@ -369,7 +373,7 @@
- // Private constructor.
+ /** Private constructor. */
private DurationPropertyDefinition(AbstractManagedObjectDefinition<?, ?> d,
String propertyName, EnumSet<PropertyOption> options,
AdministratorAction adminAction,
@@ -446,9 +450,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(Long value) throws PropertyException {
ifNull(value);
@@ -469,9 +471,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String encodeValue(Long value) throws PropertyException {
ifNull(value);
@@ -487,9 +487,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Long decodeValue(String value)
throws PropertyException {
@@ -526,9 +524,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitDuration(this, p);
@@ -536,9 +532,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, Long value, P p) {
return v.visitDuration(this, value, p);
@@ -546,9 +540,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void toString(StringBuilder builder) {
super.toString(builder);
@@ -577,9 +569,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compare(Long o1, Long o2) {
return o1.compareTo(o2);
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/EnumPropertyDefinition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/EnumPropertyDefinition.java
index def492e..1eb9dcb 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/EnumPropertyDefinition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/EnumPropertyDefinition.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin;
@@ -61,12 +61,12 @@
public static class Builder<E extends Enum<E>> extends
AbstractBuilder<E, EnumPropertyDefinition<E>> {
- // The enumeration class.
+ /** The enumeration class. */
private Class<E> enumClass;
- // Private constructor
+ /** Private constructor. */
private Builder(
AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
super(d, propertyName);
@@ -89,9 +89,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected EnumPropertyDefinition<E> buildInstance(
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
@@ -128,15 +126,15 @@
return new Builder<E>(d, propertyName);
}
- // The enumeration class.
+ /** The enumeration class. */
private final Class<E> enumClass;
- // Map used for decoding values.
+ /** Map used for decoding values. */
private final Map<String, E> decodeMap;
- // Private constructor.
+ /** Private constructor. */
private EnumPropertyDefinition(AbstractManagedObjectDefinition<?, ?> d,
String propertyName, EnumSet<PropertyOption> options,
AdministratorAction adminAction,
@@ -154,9 +152,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitEnum(this, p);
@@ -164,9 +160,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, E value, P p) {
return v.visitEnum(this, value, p);
@@ -174,9 +168,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public E decodeValue(String value)
throws PropertyException {
@@ -249,9 +241,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String normalizeValue(E value)
throws PropertyException {
@@ -262,9 +252,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(E value)
throws PropertyException {
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/GenericConstraint.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/GenericConstraint.java
index 7c09384..c703ec9 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/GenericConstraint.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/GenericConstraint.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin;
@@ -57,16 +57,14 @@
*/
private class ClientHandler extends ClientConstraintHandler {
- // Private constructor.
+ /** Private constructor. */
private ClientHandler() {
// No implementation required.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isAddAcceptable(ManagementContext context,
ManagedObject<?> managedObject, Collection<LocalizableMessage> unacceptableReasons)
@@ -81,9 +79,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isModifyAcceptable(ManagementContext context,
ManagedObject<?> managedObject, Collection<LocalizableMessage> unacceptableReasons)
@@ -105,16 +101,14 @@
*/
private class ServerHandler extends ServerConstraintHandler {
- // Private constructor.
+ /** Private constructor. */
private ServerHandler() {
// No implementation required.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isUsable(ServerManagedObject<?> managedObject,
Collection<LocalizableMessage> unacceptableReasons) throws ConfigException {
@@ -128,19 +122,19 @@
};
- // The client-side constraint handler.
+ /** The client-side constraint handler. */
private final ClientConstraintHandler clientHandler = new ClientHandler();
- // The condition associated with this constraint.
+ /** The condition associated with this constraint. */
private final Condition condition;
- // The managed object definition associated with this constraint.
+ /** The managed object definition associated with this constraint. */
private final AbstractManagedObjectDefinition<?, ?> definition;
- // The constraint ID.
+ /** The constraint ID. */
private final int id;
- // The server-side constraint handler.
+ /** The server-side constraint handler. */
private final ServerConstraintHandler serverHandler = new ServerHandler();
@@ -165,18 +159,14 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<ClientConstraintHandler> getClientConstraintHandlers() {
return Collections.singleton(clientHandler);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<ServerConstraintHandler> getServerConstraintHandlers() {
return Collections.singleton(serverHandler);
}
@@ -212,9 +202,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected void initialize() throws Exception {
condition.initialize(definition);
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/IPAddressMaskPropertyDefinition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/IPAddressMaskPropertyDefinition.java
index f071d50..412acb7 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/IPAddressMaskPropertyDefinition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/IPAddressMaskPropertyDefinition.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin;
@@ -51,7 +51,7 @@
public static class Builder extends
AbstractBuilder<AddressMask, IPAddressMaskPropertyDefinition> {
- // Private constructor
+ /** Private constructor. */
private Builder(
AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
super(d, propertyName);
@@ -59,9 +59,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected IPAddressMaskPropertyDefinition buildInstance(
AbstractManagedObjectDefinition<?, ?> d,
@@ -93,7 +91,7 @@
- // Private constructor.
+ /** Private constructor. */
private IPAddressMaskPropertyDefinition(
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options,
@@ -105,9 +103,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(AddressMask value)
throws PropertyException {
@@ -118,9 +114,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public AddressMask decodeValue(String value)
throws PropertyException {
@@ -136,9 +130,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitIPAddressMask(this, p);
@@ -146,9 +138,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, AddressMask value, P p) {
return v.visitIPAddressMask(this, value, p);
@@ -156,9 +146,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compare(AddressMask o1, AddressMask o2) {
return o1.toString().compareTo(o2.toString());
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/IPAddressPropertyDefinition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/IPAddressPropertyDefinition.java
index e7d6413..bd79f4b 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/IPAddressPropertyDefinition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/IPAddressPropertyDefinition.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin;
@@ -50,7 +50,7 @@
public static class Builder extends
AbstractBuilder<InetAddress, IPAddressPropertyDefinition> {
- // Private constructor
+ /** Private constructor. */
private Builder(
AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
super(d, propertyName);
@@ -58,9 +58,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected IPAddressPropertyDefinition buildInstance(
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
@@ -92,7 +90,7 @@
- // Private constructor.
+ /** Private constructor. */
private IPAddressPropertyDefinition(
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options,
@@ -104,9 +102,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(InetAddress value)
throws PropertyException {
@@ -117,9 +113,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public InetAddress decodeValue(String value)
throws PropertyException {
@@ -135,9 +129,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String encodeValue(InetAddress value)
throws PropertyException {
@@ -158,9 +150,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitIPAddress(this, p);
@@ -168,9 +158,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, InetAddress value, P p) {
return v.visitIPAddress(this, value, p);
@@ -178,9 +166,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compare(InetAddress o1, InetAddress o2) {
return o1.getHostAddress().compareTo(o2.getHostAddress());
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/InstantiableRelationDefinition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/InstantiableRelationDefinition.java
index 35523c7..dcecd91 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/InstantiableRelationDefinition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/InstantiableRelationDefinition.java
@@ -70,14 +70,16 @@
<C extends ConfigurationClient, S extends Configuration>
extends AbstractBuilder<C, S, InstantiableRelationDefinition<C, S>> {
- // The optional naming property definition.
+ /** The optional naming property definition. */
private PropertyDefinition<?> namingPropertyDefinition;
- // The plural name of the relation.
+ /** The plural name of the relation. */
private final String pluralName;
- // The optional default managed objects associated with this
- // instantiable relation definition.
+ /**
+ * The optional default managed objects associated with this
+ * instantiable relation definition.
+ */
private final Map<String, DefaultManagedObject<? extends C, ? extends S>>
defaultManagedObjects = new HashMap<String,
DefaultManagedObject<? extends C, ? extends S>>();
@@ -137,9 +139,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected InstantiableRelationDefinition<C, S> buildInstance(
Common<C, S> common) {
@@ -149,20 +149,22 @@
}
- // The optional naming property definition.
+ /** The optional naming property definition. */
private final PropertyDefinition<?> namingPropertyDefinition;
- // The plural name of the relation.
+ /** The plural name of the relation. */
private final String pluralName;
- // The optional default managed objects associated with this
- // instantiable relation definition.
+ /**
+ * The optional default managed objects associated with this
+ * instantiable relation definition.
+ */
private final Map<String, DefaultManagedObject<? extends C, ? extends S>>
defaultManagedObjects;
- // Private constructor.
+ /** Private constructor. */
private InstantiableRelationDefinition(Common<C, S> common,
String pluralName,
PropertyDefinition<?> namingPropertyDefinition,
@@ -176,9 +178,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(RelationDefinitionVisitor<R, P> v, P p) {
return v.visitInstantiable(this, p);
@@ -277,9 +277,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void toString(StringBuilder builder) {
builder.append("name=");
@@ -292,9 +290,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected void initialize() throws Exception {
for (DefaultManagedObject<?, ?> dmo : defaultManagedObjects.values()) {
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/IntegerPropertyDefinition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/IntegerPropertyDefinition.java
index aeba6cb..5c00531 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/IntegerPropertyDefinition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/IntegerPropertyDefinition.java
@@ -48,17 +48,19 @@
public final class IntegerPropertyDefinition extends
PropertyDefinition<Integer> {
- // String used to represent unlimited.
+ /** String used to represent unlimited. */
private static final String UNLIMITED = "unlimited";
- // The lower limit of the property value.
+ /** The lower limit of the property value. */
private final int lowerLimit;
- // The optional upper limit of the property value.
+ /** The optional upper limit of the property value. */
private final Integer upperLimit;
- // Indicates whether this property allows the use of the "unlimited" value
- // (represented using a -1 or the string "unlimited").
+ /**
+ * Indicates whether this property allows the use of the "unlimited" value
+ * (represented using a -1 or the string "unlimited").
+ */
private final boolean allowUnlimited;
@@ -69,19 +71,21 @@
public static class Builder extends
AbstractBuilder<Integer, IntegerPropertyDefinition> {
- // The lower limit of the property value.
+ /** The lower limit of the property value. */
private int lowerLimit;
- // The optional upper limit of the property value.
+ /** The optional upper limit of the property value. */
private Integer upperLimit;
- // Indicates whether this property allows the use of the "unlimited" value
- // (represented using a -1 or the string "unlimited").
+ /**
+ * Indicates whether this property allows the use of the "unlimited" value
+ * (represented using a -1 or the string "unlimited").
+ */
private boolean allowUnlimited;
- // Private constructor
+ /** Private constructor. */
private Builder(
AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
super(d, propertyName);
@@ -148,9 +152,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected IntegerPropertyDefinition buildInstance(
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
@@ -182,7 +184,7 @@
- // Private constructor.
+ /** Private constructor. */
private IntegerPropertyDefinition(
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options,
@@ -271,9 +273,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(Integer value)
throws PropertyException {
@@ -292,9 +292,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String encodeValue(Integer value)
throws PropertyException {
@@ -308,9 +306,7 @@
return value.toString();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Integer decodeValue(String value) throws PropertyException {
ifNull(value);
@@ -337,9 +333,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitInteger(this, p);
@@ -347,9 +341,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, Integer value, P p) {
return v.visitInteger(this, value, p);
@@ -357,9 +349,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void toString(StringBuilder builder) {
super.toString(builder);
@@ -378,9 +368,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compare(Integer o1, Integer o2) {
return o1.compareTo(o2);
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/LDAPProfile.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/LDAPProfile.java
index a8726fb..3430fb7 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/LDAPProfile.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/LDAPProfile.java
@@ -22,6 +22,7 @@
*
*
* Copyright 2008-2009 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
package org.opends.server.admin;
@@ -167,7 +168,7 @@
}
}
- // The singleton instance.
+ /** The singleton instance. */
private static final LDAPProfile INSTANCE = new LDAPProfile();
@@ -181,16 +182,16 @@
return INSTANCE;
}
- // The list of profile wrappers.
+ /** The list of profile wrappers. */
private final LinkedList<Wrapper> profiles = new LinkedList<Wrapper>();;
- // The LDAP profile property table.
+ /** The LDAP profile property table. */
private final ManagedObjectDefinitionResource resource =
ManagedObjectDefinitionResource.createForProfile("ldap");
- // Prevent construction.
+ /** Prevent construction. */
private LDAPProfile() {
// No implementation required.
}
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/ManagedObjectDefinitionI18NResource.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/ManagedObjectDefinitionI18NResource.java
index 2d39172..0bd3eaa 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/ManagedObjectDefinitionI18NResource.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/ManagedObjectDefinitionI18NResource.java
@@ -48,7 +48,7 @@
*/
public final class ManagedObjectDefinitionI18NResource {
- // Application-wide set of instances.
+ /** Application-wide set of instances. */
private static final Map<String, ManagedObjectDefinitionI18NResource>
INSTANCES = new HashMap<String, ManagedObjectDefinitionI18NResource>();
@@ -82,7 +82,7 @@
- // Get a resource instance creating it if necessary.
+ /** Get a resource instance creating it if necessary. */
private static synchronized ManagedObjectDefinitionI18NResource getInstance(
String prefix) {
ManagedObjectDefinitionI18NResource instance = INSTANCES.get(prefix);
@@ -97,18 +97,18 @@
- // Mapping from definition to locale-based resource bundle.
+ /** Mapping from definition to locale-based resource bundle. */
private final Map<AbstractManagedObjectDefinition<?, ?>,
Map<Locale, ResourceBundle>> resources;
- // The resource name prefix.
+ /** The resource name prefix. */
private final String prefix;
- // Private constructor.
+ /** Private constructor. */
private ManagedObjectDefinitionI18NResource(String prefix) {
this.resources = new HashMap<AbstractManagedObjectDefinition<?, ?>,
Map<Locale, ResourceBundle>>();
@@ -315,8 +315,10 @@
- // Retrieve the resource bundle associated with a managed object and
- // locale, lazily loading it if necessary.
+ /**
+ * Retrieve the resource bundle associated with a managed object and
+ * locale, lazily loading it if necessary.
+ */
private synchronized ResourceBundle getResourceBundle(
AbstractManagedObjectDefinition<?, ?> d, Locale locale)
throws MissingResourceException, UnsupportedOperationException {
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/ManagedObjectDefinitionResource.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/ManagedObjectDefinitionResource.java
index b38b26d..642782a 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/ManagedObjectDefinitionResource.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/ManagedObjectDefinitionResource.java
@@ -22,6 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
package org.opends.server.admin;
@@ -46,11 +47,11 @@
*/
public final class ManagedObjectDefinitionResource {
- // Mapping from definition to property tables.
+ /** Mapping from definition to property tables. */
private final Map<AbstractManagedObjectDefinition<?, ?>,
Properties> properties;
- // The resource name prefix.
+ /** The resource name prefix. */
private final String prefix;
@@ -70,7 +71,7 @@
- // Private constructor.
+ /** Private constructor. */
private ManagedObjectDefinitionResource(String prefix) {
this.properties =
new HashMap<AbstractManagedObjectDefinition<?, ?>, Properties>();
@@ -118,8 +119,10 @@
- // Retrieve the properties table associated with a managed object,
- // lazily loading it if necessary.
+ /**
+ * Retrieve the properties table associated with a managed object,
+ * lazily loading it if necessary.
+ */
private synchronized Properties getProperties(
AbstractManagedObjectDefinition<?, ?> d)
throws MissingResourceException {
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/ManagedObjectPath.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/ManagedObjectPath.java
index 46ddeb5..4b1dc9b 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/ManagedObjectPath.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/ManagedObjectPath.java
@@ -124,15 +124,15 @@
private static final class DNSerializer implements
ManagedObjectPathSerializer {
- // The current DN.
+ /** The current DN. */
private DN dn;
- // The LDAP profile.
+ /** The LDAP profile. */
private final LDAPProfile profile;
- // Create a new DN builder.
+ /** Create a new DN builder. */
private DNSerializer() {
this.dn = DN.rootDN();
this.profile = LDAPProfile.getInstance();
@@ -140,9 +140,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration>
void appendManagedObjectPathElement(
InstantiableRelationDefinition<? super C, ? super S> r,
@@ -160,9 +158,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration>
void appendManagedObjectPathElement(
SetRelationDefinition<? super C, ? super S> r,
@@ -180,9 +176,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration>
void appendManagedObjectPathElement(
OptionalRelationDefinition<? super C, ? super S> r,
@@ -193,9 +187,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration>
void appendManagedObjectPathElement(
SingletonRelationDefinition<? super C, ? super S> r,
@@ -206,7 +198,7 @@
- // Appends the RDN sequence representing the provided relation.
+ /** Appends the RDN sequence representing the provided relation. */
private void appendManagedObjectPathElement(RelationDefinition<?, ?> r) {
// Add the RDN sequence representing the relation.
try {
@@ -219,7 +211,7 @@
- // Gets the serialized DN value.
+ /** Gets the serialized DN value. */
private DN toDN() {
return dn;
}
@@ -233,7 +225,7 @@
private static abstract class Element<C extends ConfigurationClient,
S extends Configuration> {
- // The type of managed object referenced by this element.
+ /** The type of managed object referenced by this element. */
private final AbstractManagedObjectDefinition<C, S> definition;
@@ -305,7 +297,7 @@
<C extends ConfigurationClient, S extends Configuration>
extends Element<C, S> {
- // Factory method.
+ /** Factory method. */
private static <C extends ConfigurationClient,
S extends Configuration>
InstantiableElement<C, S> create(
@@ -314,15 +306,15 @@
return new InstantiableElement<C, S>(r, d, name);
}
- // The name of the managed object.
+ /** The name of the managed object. */
private final String name;
- // The instantiable relation.
+ /** The instantiable relation. */
private final InstantiableRelationDefinition<? super C, ? super S> r;
- // Private constructor.
+ /** Private constructor. */
private InstantiableElement(
InstantiableRelationDefinition<? super C, ? super S> r,
AbstractManagedObjectDefinition<C, S> d, String name) {
@@ -333,9 +325,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getName() {
return name;
@@ -343,9 +333,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public InstantiableRelationDefinition<? super C, ? super S>
getRelationDefinition() {
@@ -354,9 +342,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void serialize(ManagedObjectPathSerializer serializer) {
serializer.appendManagedObjectPathElement(r,
@@ -373,7 +359,7 @@
<C extends ConfigurationClient, S extends Configuration>
extends Element<C, S> {
- // Factory method.
+ /** Factory method. */
private static <C extends ConfigurationClient,
S extends Configuration> OptionalElement<C, S> create(
OptionalRelationDefinition<? super C, ? super S> r,
@@ -381,12 +367,12 @@
return new OptionalElement<C, S>(r, d);
}
- // The optional relation.
+ /** The optional relation. */
private final OptionalRelationDefinition<? super C, ? super S> r;
- // Private constructor.
+ /** Private constructor. */
private OptionalElement(OptionalRelationDefinition<? super C, ? super S> r,
AbstractManagedObjectDefinition<C, S> d) {
super(d);
@@ -395,9 +381,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public OptionalRelationDefinition<? super C, ? super S>
getRelationDefinition() {
@@ -406,9 +390,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void serialize(ManagedObjectPathSerializer serializer) {
serializer
@@ -425,7 +407,7 @@
<C extends ConfigurationClient, S extends Configuration>
extends Element<C, S> {
- // Factory method.
+ /** Factory method. */
private static <C extends ConfigurationClient,
S extends Configuration>
SetElement<C, S> create(
@@ -434,12 +416,12 @@
return new SetElement<C, S>(r, d);
}
- // The set relation.
+ /** The set relation. */
private final SetRelationDefinition<? super C, ? super S> r;
- // Private constructor.
+ /** Private constructor. */
private SetElement(
SetRelationDefinition<? super C, ? super S> r,
AbstractManagedObjectDefinition<C, S> d) {
@@ -449,9 +431,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public SetRelationDefinition<? super C, ? super S>
getRelationDefinition() {
@@ -460,9 +440,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void serialize(ManagedObjectPathSerializer serializer) {
serializer.appendManagedObjectPathElement(r,
@@ -479,7 +457,7 @@
<C extends ConfigurationClient, S extends Configuration>
extends Element<C, S> {
- // Factory method.
+ /** Factory method. */
private static <C extends ConfigurationClient,
S extends Configuration> SingletonElement<C, S> create(
SingletonRelationDefinition<? super C, ? super S> r,
@@ -487,12 +465,12 @@
return new SingletonElement<C, S>(r, d);
}
- // The singleton relation.
+ /** The singleton relation. */
private final SingletonRelationDefinition<? super C, ? super S> r;
- // Private constructor.
+ /** Private constructor. */
private SingletonElement(
SingletonRelationDefinition<? super C, ? super S> r,
AbstractManagedObjectDefinition<C, S> d) {
@@ -502,9 +480,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public SingletonRelationDefinition<? super C, ? super S>
getRelationDefinition() {
@@ -513,9 +489,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void serialize(ManagedObjectPathSerializer serializer) {
serializer
@@ -532,21 +506,19 @@
private static final class StringSerializer implements
ManagedObjectPathSerializer {
- // Serialize to this string builder.
+ /** Serialize to this string builder. */
private final StringBuilder builder;
- // Private constructor.
+ /** Private constructor. */
private StringSerializer(StringBuilder builder) {
this.builder = builder;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <M extends ConfigurationClient, N extends Configuration>
void appendManagedObjectPathElement(
InstantiableRelationDefinition<? super M, ? super N> r,
@@ -560,9 +532,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <M extends ConfigurationClient, N extends Configuration>
void appendManagedObjectPathElement(
OptionalRelationDefinition<? super M, ? super N> r,
@@ -572,9 +542,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <M extends ConfigurationClient, N extends Configuration>
void appendManagedObjectPathElement(
SingletonRelationDefinition<? super M, ? super N> r,
@@ -584,9 +552,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <M extends ConfigurationClient, N extends Configuration>
void appendManagedObjectPathElement(
SetRelationDefinition<? super M, ? super N> r,
@@ -596,7 +562,7 @@
- // Common element serialization.
+ /** Common element serialization. */
private <M, N> void serializeElement(RelationDefinition<?, ?> r,
AbstractManagedObjectDefinition<?, ?> d) {
// Always specify the relation name.
@@ -612,12 +578,12 @@
}
}
- // Single instance of a root path.
+ /** Single instance of a root path. */
private static final ManagedObjectPath<RootCfgClient, RootCfg> EMPTY_PATH =
new ManagedObjectPath<RootCfgClient, RootCfg>(
new LinkedList<Element<?, ?>>(), null, RootCfgDefn.getInstance());
- // A regular expression used to parse path elements.
+ /** A regular expression used to parse path elements. */
private static final Pattern PE_REGEXP = Pattern
.compile("^\\s*relation=\\s*([^+]+)\\s*"
+ "(\\+\\s*type=\\s*([^+]+)\\s*)?"
@@ -740,8 +706,10 @@
- // Factory method required in order to allow generic wild-card
- // construction of new paths.
+ /**
+ * Factory method required in order to allow generic wild-card
+ * construction of new paths.
+ */
private static <C extends ConfigurationClient, S extends Configuration>
ManagedObjectPath<C, S> create(
LinkedList<Element<?, ?>> elements, Element<C, S> lastElement) {
@@ -751,7 +719,7 @@
- // Decode an element.
+ /** Decode an element. */
private static <C extends ConfigurationClient, S extends Configuration>
Element<? extends C, ? extends S> createElement(
RelationDefinition<C, S> r, String path, String element, String type,
@@ -825,18 +793,18 @@
}
}
- // The managed object definition in this path.
+ /** The managed object definition in this path. */
private final AbstractManagedObjectDefinition<C, S> d;
- // The list of path elements in this path.
+ /** The list of path elements in this path. */
private final List<Element<?, ?>> elements;
- // The last relation definition in this path.
+ /** The last relation definition in this path. */
private final RelationDefinition<? super C, ? super S> r;
- // Private constructor.
+ /** Private constructor. */
private ManagedObjectPath(LinkedList<Element<?, ?>> elements,
RelationDefinition<? super C, ? super S> r,
AbstractManagedObjectDefinition<C, S> d) {
@@ -1158,9 +1126,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean equals(Object obj) {
if (obj == this) {
@@ -1228,9 +1194,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
return toString().hashCode();
@@ -1407,9 +1371,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
StringBuilder builder = new StringBuilder();
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/OptionalRelationDefinition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/OptionalRelationDefinition.java
index ab3a9dd..b198d86 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/OptionalRelationDefinition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/OptionalRelationDefinition.java
@@ -60,8 +60,10 @@
<C extends ConfigurationClient, S extends Configuration>
extends AbstractBuilder<C, S, OptionalRelationDefinition<C, S>> {
- // The optional default managed object associated with this
- // optional relation.
+ /**
+ * The optional default managed object associated with this
+ * optional relation.
+ */
private DefaultManagedObject<? extends C, ? extends S> defaultManagedObject;
@@ -100,9 +102,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected OptionalRelationDefinition<C, S> buildInstance(
Common<C, S> common) {
@@ -113,14 +113,16 @@
- // The optional default managed object associated with this
- // optional relation.
+ /**
+ * The optional default managed object associated with this
+ * optional relation.
+ */
private final DefaultManagedObject<? extends C, ? extends S>
defaultManagedObject;
- // Private constructor.
+ /** Private constructor. */
private OptionalRelationDefinition(Common<C, S> common,
DefaultManagedObject<? extends C, ? extends S> defaultManagedObject) {
super(common);
@@ -129,9 +131,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(RelationDefinitionVisitor<R, P> v, P p) {
return v.visitOptional(this, p);
@@ -154,9 +154,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void toString(StringBuilder builder) {
builder.append("name=");
@@ -169,9 +167,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected void initialize() throws Exception {
if (defaultManagedObject != null) {
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyDefinition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyDefinition.java
index 177d02e..478dc93 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyDefinition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyDefinition.java
@@ -69,19 +69,19 @@
protected static abstract class AbstractBuilder
<T, D extends PropertyDefinition<T>> {
- // The administrator action.
+ /** The administrator action. */
private AdministratorAction adminAction;
- // The default behavior provider.
+ /** The default behavior provider. */
private DefaultBehaviorProvider<T> defaultBehavior;
- // The abstract managed object
+ /** The abstract managed object. */
private final AbstractManagedObjectDefinition<?, ?> definition;
- // The options applicable to this definition.
+ /** The options applicable to this definition. */
private final EnumSet<PropertyOption> options;
- // The name of this property definition.
+ /** The name of this property definition. */
private final String propertyName;
@@ -183,22 +183,22 @@
DefaultBehaviorProvider<T> defaultBehavior);
}
- // The administrator action.
+ /** The administrator action. */
private final AdministratorAction adminAction;
- // The default behavior provider.
+ /** The default behavior provider. */
private final DefaultBehaviorProvider<T> defaultBehavior;
- // The abstract managed object
+ /** The abstract managed object. */
private final AbstractManagedObjectDefinition<?, ?> definition;
- // Options applicable to this definition.
+ /** Options applicable to this definition. */
private final Set<PropertyOption> options;
- // The property name.
+ /** The property name. */
private final String propertyName;
- // The property value class.
+ /** The property value class. */
private final Class<T> theClass;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyDefinitionUsageBuilder.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyDefinitionUsageBuilder.java
index 8c92dbc..d097c14 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyDefinitionUsageBuilder.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyDefinitionUsageBuilder.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008-2009 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin;
@@ -49,16 +49,18 @@
private class MyPropertyDefinitionVisitor extends
PropertyDefinitionVisitor<LocalizableMessage, Void> {
- // Flag indicating whether detailed syntax information will be
- // generated.
+ /**
+ * Flag indicating whether detailed syntax information will be
+ * generated.
+ */
private final boolean isDetailed;
- // The formatter to use for numeric values.
+ /** The formatter to use for numeric values. */
private final NumberFormat numberFormat;
- // Private constructor.
+ /** Private constructor. */
private MyPropertyDefinitionVisitor(boolean isDetailed) {
this.isDetailed = isDetailed;
@@ -69,9 +71,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <C extends ConfigurationClient, S extends Configuration>
LocalizableMessage visitAggregation(AggregationPropertyDefinition<C, S> d, Void p) {
@@ -80,27 +80,20 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage visitAttributeType(AttributeTypePropertyDefinition d,
Void p) {
return LocalizableMessage.raw("OID");
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
- public LocalizableMessage visitACI(ACIPropertyDefinition d,
- Void p) {
+ public LocalizableMessage visitACI(ACIPropertyDefinition d, Void p) {
return LocalizableMessage.raw("ACI");
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage visitBoolean(BooleanPropertyDefinition d, Void p) {
if (isDetailed) {
@@ -112,9 +105,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage visitClass(ClassPropertyDefinition d, Void p) {
if (isDetailed && !d.getInstanceOfInterface().isEmpty()) {
@@ -126,9 +117,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage visitDN(DNPropertyDefinition d, Void p) {
if (isDetailed && d.getBaseDN() != null) {
@@ -140,9 +129,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage visitDuration(DurationPropertyDefinition d, Void p) {
LocalizableMessageBuilder builder = new LocalizableMessageBuilder();
@@ -173,9 +160,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <E extends Enum<E>> LocalizableMessage visitEnum(EnumPropertyDefinition<E> d,
Void p) {
@@ -199,9 +184,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage visitInteger(IntegerPropertyDefinition d, Void p) {
LocalizableMessageBuilder builder = new LocalizableMessageBuilder();
@@ -227,9 +210,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage visitIPAddress(IPAddressPropertyDefinition d, Void p) {
return LocalizableMessage.raw("HOST_NAME");
@@ -237,9 +218,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage visitIPAddressMask(IPAddressMaskPropertyDefinition d,
Void p) {
@@ -248,9 +227,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage visitSize(SizePropertyDefinition d, Void p) {
LocalizableMessageBuilder builder = new LocalizableMessageBuilder();
@@ -301,9 +278,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage visitString(StringPropertyDefinition d, Void p) {
if (d.getPattern() != null) {
@@ -327,9 +302,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <T> LocalizableMessage visitUnknown(PropertyDefinition<T> d, Void p)
throws PropertyException {
@@ -337,7 +310,7 @@
}
}
- // Underlying implementation.
+ /** Underlying implementation. */
private final MyPropertyDefinitionVisitor pimpl;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyException.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyException.java
index 4cfd1f7..5ed84c8 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyException.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyException.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions copyright 2014 ForgeRock AS.
+ * Portions copyright 2014-2015 ForgeRock AS.
*/
package org.opends.server.admin;
@@ -172,7 +172,7 @@
- // Create the message.
+ /** Create the message. */
private static LocalizableMessage createMessage(PropertyDefinition<?> pd, Object value)
{
PropertyDefinitionUsageBuilder builder = new PropertyDefinitionUsageBuilder(true);
@@ -181,10 +181,10 @@
- // LocalizableMessage that explains the problem.
+ /** LocalizableMessage that explains the problem. */
private final LocalizableMessage message;
- /*
+ /**
* The property definition associated with the property that caused the
* exception.
*/
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyNotFoundException.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyNotFoundException.java
index 2022ddb..23d5c99 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyNotFoundException.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyNotFoundException.java
@@ -22,6 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
package org.opends.server.admin;
@@ -43,7 +44,7 @@
*/
private static final long serialVersionUID = -895548482881819610L;
- // The name of the property that could not be found.
+ /** The name of the property that could not be found. */
private final String propertyName;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyProvider.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyProvider.java
index db65b7b..1ef4971 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyProvider.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/PropertyProvider.java
@@ -47,9 +47,7 @@
PropertyProvider DEFAULT_PROVIDER =
new PropertyProvider() {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <T> Collection<T> getPropertyValues(PropertyDefinition<T> d)
throws IllegalArgumentException {
return Collections.<T> emptySet();
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/Reference.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/Reference.java
index 17fd198..312c472 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/Reference.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/Reference.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin;
@@ -159,19 +159,21 @@
return new Reference<C, S>(p, rd, s);
}
- // The name of the referenced managed object.
+ /** The name of the referenced managed object. */
private final String name;
- // The path of the referenced managed object.
+ /** The path of the referenced managed object. */
private final ManagedObjectPath<C, S> path;
- // The instantiable relation in the parent which contains the
- // referenced managed object.
+ /**
+ * The instantiable relation in the parent which contains the
+ * referenced managed object.
+ */
private final InstantiableRelationDefinition<C, S> relation;
- // Private constructor.
+ /** Private constructor. */
private Reference(ManagedObjectPath<?, ?> parent,
InstantiableRelationDefinition<C, S> relation, String name)
throws IllegalArgumentException {
@@ -217,17 +219,17 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String toString() {
return name;
}
- // Normalize a value using the specified naming property definition
- // if defined.
+ /**
+ * Normalize a value using the specified naming property definition
+ * if defined.
+ */
private <T> String normalizeName(PropertyDefinition<T> pd) {
if (pd != null) {
try {
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/RelationDefinition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/RelationDefinition.java
index a4343a6..555ce85 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/RelationDefinition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/RelationDefinition.java
@@ -105,7 +105,7 @@
<C extends ConfigurationClient, S extends Configuration,
D extends RelationDefinition<C, S>> {
- // Common fields.
+ /** Common fields. */
private final Common<C, S> common;
@@ -179,21 +179,21 @@
protected static final class Common
<C extends ConfigurationClient, S extends Configuration> {
- // The definition of the child managed object.
+ /** The definition of the child managed object. */
private final AbstractManagedObjectDefinition<C, S> cd;
- // The name of the relation.
+ /** The name of the relation. */
private final String name;
- // Options applicable to this definition.
+ /** Options applicable to this definition. */
private final Set<RelationOption> options;
- // The definition of the parent managed object.
+ /** The definition of the parent managed object. */
private final AbstractManagedObjectDefinition<?, ?> pd;
- // Private constructor.
+ /** Private constructor. */
private Common(AbstractManagedObjectDefinition<?, ?> pd, String name,
AbstractManagedObjectDefinition<C, S> cd) {
this.name = name;
@@ -203,7 +203,7 @@
}
}
- // Common fields.
+ /** Common fields. */
private final Common<C, S> common;
@@ -383,9 +383,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final String toString() {
StringBuilder builder = new StringBuilder();
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/RelativeInheritedDefaultBehaviorProvider.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/RelativeInheritedDefaultBehaviorProvider.java
index 2107fc6..9b47215 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/RelativeInheritedDefaultBehaviorProvider.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/RelativeInheritedDefaultBehaviorProvider.java
@@ -22,6 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
package org.opends.server.admin;
@@ -39,14 +40,16 @@
public final class RelativeInheritedDefaultBehaviorProvider<T> extends
DefaultBehaviorProvider<T> {
- // The type of managed object expected at the relative offset.
+ /** The type of managed object expected at the relative offset. */
private final AbstractManagedObjectDefinition<?, ?> d;
- // The relative offset (where 1 = parent, 2 = grandparent) of the
- // managed object containing the property.
+ /**
+ * The relative offset (where 1 = parent, 2 = grandparent) of the
+ * managed object containing the property.
+ */
private final int offset;
- // The name of the property containing the inherited default values.
+ /** The name of the property containing the inherited default values. */
private final String propertyName;
@@ -84,9 +87,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <R, P> R accept(DefaultBehaviorProviderVisitor<T, R, P> v, P p) {
return v.visitRelativeInherited(this, p);
}
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/SetRelationDefinition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/SetRelationDefinition.java
index a0e7944..4c1bfe0 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/SetRelationDefinition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/SetRelationDefinition.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2009 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin;
@@ -72,11 +72,13 @@
extends AbstractBuilder<C, S, SetRelationDefinition<C, S>>
{
- // The plural name of the relation.
+ /** The plural name of the relation. */
private final String pluralName;
- // The optional default managed objects associated with this
- // set relation definition.
+ /**
+ * The optional default managed objects associated with this
+ * set relation definition.
+ */
private final Map<String,
DefaultManagedObject<? extends C, ? extends S>>
defaultManagedObjects =
@@ -123,9 +125,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected SetRelationDefinition<C, S> buildInstance(
Common<C, S> common)
@@ -138,18 +138,20 @@
- // The plural name of the relation.
+ /** The plural name of the relation. */
private final String pluralName;
- // The optional default managed objects associated with this
- // set relation definition.
+ /**
+ * The optional default managed objects associated with this
+ * set relation definition.
+ */
private final Map<String,
DefaultManagedObject<? extends C, ? extends S>>
defaultManagedObjects;
- // Private constructor.
+ /** Private constructor. */
private SetRelationDefinition(
Common<C, S> common,
String pluralName,
@@ -163,9 +165,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(RelationDefinitionVisitor<R, P> v, P p)
{
@@ -258,9 +258,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void toString(StringBuilder builder)
{
@@ -274,9 +272,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected void initialize() throws Exception
{
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/SingletonRelationDefinition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/SingletonRelationDefinition.java
index c7004c5..19cf54c 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/SingletonRelationDefinition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/SingletonRelationDefinition.java
@@ -60,8 +60,10 @@
<C extends ConfigurationClient, S extends Configuration>
extends AbstractBuilder<C, S, SingletonRelationDefinition<C, S>> {
- // The optional default managed object associated with this
- // singleton relation.
+ /**
+ * The optional default managed object associated with this
+ * singleton relation.
+ */
private DefaultManagedObject<? extends C, ? extends S> defaultManagedObject;
@@ -100,9 +102,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected SingletonRelationDefinition<C, S> buildInstance(
Common<C, S> common) {
@@ -114,14 +114,16 @@
- // The optional default managed object associated with this
- // singleton relation.
+ /**
+ * The optional default managed object associated with this
+ * singleton relation.
+ */
private final DefaultManagedObject<? extends C, ? extends S>
defaultManagedObject;
- // Private constructor.
+ /** Private constructor. */
private SingletonRelationDefinition(Common<C, S> common,
DefaultManagedObject<? extends C, ? extends S> defaultManagedObject) {
super(common);
@@ -130,9 +132,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(RelationDefinitionVisitor<R, P> v, P p) {
return v.visitSingleton(this, p);
@@ -155,9 +155,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void toString(StringBuilder builder) {
builder.append("name=");
@@ -170,9 +168,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected void initialize() throws Exception {
if (defaultManagedObject != null) {
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/SizePropertyDefinition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/SizePropertyDefinition.java
index c956e4b..85d4068 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/SizePropertyDefinition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/SizePropertyDefinition.java
@@ -44,17 +44,19 @@
*/
public final class SizePropertyDefinition extends PropertyDefinition<Long> {
- // String used to represent unlimited memory sizes.
+ /** String used to represent unlimited memory sizes. */
private static final String UNLIMITED = "unlimited";
- // The lower limit of the property value in bytes.
+ /** The lower limit of the property value in bytes. */
private final long lowerLimit;
- // The optional upper limit of the property value in bytes.
+ /** The optional upper limit of the property value in bytes. */
private final Long upperLimit;
- // Indicates whether this property allows the use of the "unlimited" memory
- // size value (represented using a -1L or the string "unlimited").
+ /**
+ * Indicates whether this property allows the use of the "unlimited" memory
+ * size value (represented using a -1L or the string "unlimited").
+ */
private final boolean allowUnlimited;
@@ -66,19 +68,21 @@
public static class Builder extends
AbstractBuilder<Long, SizePropertyDefinition> {
- // The lower limit of the property value in bytes.
+ /** The lower limit of the property value in bytes. */
private long lowerLimit;
- // The optional upper limit of the property value in bytes.
+ /** The optional upper limit of the property value in bytes. */
private Long upperLimit;
- // Indicates whether this property allows the use of the "unlimited" memory
- // size value (represented using a -1L or the string "unlimited").
+ /**
+ * Indicates whether this property allows the use of the "unlimited" memory
+ * size value (represented using a -1L or the string "unlimited").
+ */
private boolean allowUnlimited;
- // Private constructor
+ /** Private constructor. */
private Builder(
AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
super(d, propertyName);
@@ -186,9 +190,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected SizePropertyDefinition buildInstance(
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
@@ -220,7 +222,7 @@
- // Private constructor.
+ /** Private constructor. */
private SizePropertyDefinition(
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options,
@@ -271,9 +273,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(Long value) throws PropertyException {
ifNull(value);
@@ -293,9 +293,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String encodeValue(Long value) throws PropertyException {
ifNull(value);
@@ -316,9 +314,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Long decodeValue(String value) throws PropertyException {
ifNull(value);
@@ -346,9 +342,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitSize(this, p);
@@ -356,9 +350,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, Long value, P p) {
return v.visitSize(this, value, p);
@@ -366,9 +358,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void toString(StringBuilder builder) {
super.toString(builder);
@@ -388,9 +378,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compare(Long o1, Long o2) {
return o1.compareTo(o2);
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/StringPropertyDefinition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/StringPropertyDefinition.java
index d29bf53..eaafbae 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/StringPropertyDefinition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/StringPropertyDefinition.java
@@ -53,20 +53,24 @@
public static class Builder extends
AbstractBuilder<String, StringPropertyDefinition> {
- // Flag indicating whether values of this property are
- // case-insensitive.
+ /**
+ * Flag indicating whether values of this property are
+ * case-insensitive.
+ */
private boolean isCaseInsensitive = true;
- // Optional pattern which values of this property must match.
+ /** Optional pattern which values of this property must match. */
private Pattern pattern;
- // Pattern usage which provides a user-friendly summary of the
- // pattern if present.
+ /**
+ * Pattern usage which provides a user-friendly summary of the
+ * pattern if present.
+ */
private String patternUsage;
- // Private constructor
+ /** Private constructor. */
private Builder(AbstractManagedObjectDefinition<?, ?> d,
String propertyName) {
super(d, propertyName);
@@ -117,9 +121,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected StringPropertyDefinition buildInstance(
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
@@ -150,20 +152,24 @@
return new Builder(d, propertyName);
}
- // Flag indicating whether values of this property are
- // case-insensitive.
+ /**
+ * Flag indicating whether values of this property are
+ * case-insensitive.
+ */
private final boolean isCaseInsensitive;
- // Optional pattern which values of this property must match.
+ /** Optional pattern which values of this property must match. */
private final Pattern pattern;
- // Pattern usage which provides a user-friendly summary of the
- // pattern if present.
+ /**
+ * Pattern usage which provides a user-friendly summary of the
+ * pattern if present.
+ */
private final String patternUsage;
- // Private constructor.
+ /** Private constructor. */
private StringPropertyDefinition(AbstractManagedObjectDefinition<?, ?> d,
String propertyName, EnumSet<PropertyOption> options,
AdministratorAction adminAction,
@@ -178,9 +184,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitString(this, p);
@@ -188,9 +192,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, String value, P p) {
return v.visitString(this, value, p);
@@ -198,9 +200,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String decodeValue(String value)
throws PropertyException {
@@ -301,9 +301,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String normalizeValue(String value)
throws PropertyException {
@@ -318,9 +316,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(String value) throws PropertyException {
ifNull(value);
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/Tag.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/Tag.java
index 3081d5e..6573f00 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/Tag.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/Tag.java
@@ -22,13 +22,12 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin;
+
import org.forgerock.i18n.LocalizableMessage;
-
-
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
@@ -49,7 +48,7 @@
*/
public final class Tag implements Comparable<Tag> {
- // All the tags.
+ /** All the tags. */
private static final Map<String, Tag> tags = new HashMap<String, Tag>();
@@ -109,30 +108,26 @@
return Collections.unmodifiableCollection(tags.values());
}
- // The name of the tag.
+ /** The name of the tag. */
private final String name;
- // Private constructor.
+ /** Private constructor. */
private Tag(String name) {
this.name = name;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final int compareTo(Tag o) {
return name.compareTo(o.name);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final boolean equals(Object obj) {
if (this == obj) {
@@ -191,9 +186,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final int hashCode() {
return name.hashCode();
@@ -201,9 +194,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final String toString() {
return name;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/TopCfgDefn.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/TopCfgDefn.java
index 8f3bb57..906a75d 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/TopCfgDefn.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/TopCfgDefn.java
@@ -22,6 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
package org.opends.server.admin;
@@ -47,7 +48,7 @@
public final class TopCfgDefn extends
AbstractManagedObjectDefinition<ConfigurationClient, Configuration> {
- // The singleton configuration definition instance.
+ /** The singleton configuration definition instance. */
private static final TopCfgDefn INSTANCE = new TopCfgDefn();
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/UndefinedDefaultBehaviorProvider.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/UndefinedDefaultBehaviorProvider.java
index 64589ff..29eeb83 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/UndefinedDefaultBehaviorProvider.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/UndefinedDefaultBehaviorProvider.java
@@ -22,6 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
package org.opends.server.admin;
@@ -48,9 +49,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <R, P> R accept(DefaultBehaviorProviderVisitor<T, R, P> v, P p) {
return v.visitUndefined(this, p);
}
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/IllegalManagedObjectNameException.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/IllegalManagedObjectNameException.java
index 9ef6104..6333ea9 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/IllegalManagedObjectNameException.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/IllegalManagedObjectNameException.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin.client;
@@ -57,7 +57,7 @@
- // Create the message
+ /** Create the message. */
private static LocalizableMessage createMessage(String illegalName,
PropertyDefinition<?> namingPropertyDefinition) {
if (illegalName.length() == 0) {
@@ -79,10 +79,10 @@
return ERR_ILLEGAL_MANAGED_OBJECT_NAME_EXCEPTION_OTHER.get(illegalName);
}
- // The illegal name.
+ /** The illegal name. */
private final String illegalName;
- // The naming property definition if applicable.
+ /** The naming property definition if applicable. */
private final PropertyDefinition<?> namingPropertyDefinition;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/ManagedObjectDecodingException.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/ManagedObjectDecodingException.java
index 572786d..f395295 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/ManagedObjectDecodingException.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/ManagedObjectDecodingException.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin.client;
@@ -58,7 +58,7 @@
- // Create the message.
+ /** Create the message. */
private static LocalizableMessage createMessage(ManagedObject<?> partialManagedObject,
Collection<PropertyException> causes) {
Reject.ifNull(causes);
@@ -86,10 +86,10 @@
}
}
- // The exception(s) that caused this decoding exception.
+ /** The exception(s) that caused this decoding exception. */
private final Collection<PropertyException> causes;
- // The partially created managed object.
+ /** The partially created managed object. */
private final ManagedObject<?> partialManagedObject;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/MissingMandatoryPropertiesException.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/MissingMandatoryPropertiesException.java
index 6d0eb71..c4564e4 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/MissingMandatoryPropertiesException.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/MissingMandatoryPropertiesException.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin.client;
@@ -57,7 +57,7 @@
- // Create the message.
+ /** Create the message. */
private static LocalizableMessage createMessage(Collection<PropertyException> causes)
{
Reject.ifNull(causes);
@@ -83,15 +83,13 @@
}
}
- // The causes of this exception.
+ /** The causes of this exception. */
private final Collection<PropertyException> causes;
- // Indicates whether the exception occurred during managed object
- // creation.
+ /** Indicates whether the exception occurred during managed object creation. */
private final boolean isCreate;
- // The user friendly name of the component that caused this
- // exception.
+ /** The user friendly name of the component that caused this exception. */
private final LocalizableMessage ufn;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/OperationRejectedException.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/OperationRejectedException.java
index 75ecb2d..b1de19e 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/OperationRejectedException.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/OperationRejectedException.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin.client;
@@ -83,7 +83,7 @@
- // Gets the default message.
+ /** Gets the default message. */
private static LocalizableMessage getDefaultMessage(Collection<LocalizableMessage> messages) {
Reject.ifNull(messages);
Reject.ifFalse(!messages.isEmpty());
@@ -99,7 +99,7 @@
- // Merge the messages into a single message.
+ /** Merge the messages into a single message. */
private static LocalizableMessage getSingleMessage(Collection<LocalizableMessage> messages) {
if (messages.size() == 1) {
return messages.iterator().next();
@@ -119,14 +119,13 @@
}
}
- // The messages describing the constraint violations that occurred.
+ /** The messages describing the constraint violations that occurred. */
private final Collection<LocalizableMessage> messages;
- // The type of operation that caused this exception.
+ /** The type of operation that caused this exception. */
private final OperationType type;
- // The user friendly name of the component that caused this
- // exception.
+ /** The user friendly name of the component that caused this exception. */
private final LocalizableMessage ufn;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/ldap/LDAPDriver.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/ldap/LDAPDriver.java
index 663e6e3..0551544 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/ldap/LDAPDriver.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/ldap/LDAPDriver.java
@@ -113,16 +113,14 @@
- // Prevent instantiation.
+ /** Prevent instantiation. */
private ValueDecoder() {
// No implementation required.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <C extends ConfigurationClient, S extends Configuration>
Object visitAggregation(AggregationPropertyDefinition<C, S> d, String p) {
@@ -139,9 +137,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <T> Object visitUnknown(PropertyDefinition<T> d, String p)
throws PropertyException {
@@ -152,14 +148,16 @@
- // The LDAP connection.
+ /** The LDAP connection. */
private final LDAPConnection connection;
- // The LDAP management context.
+ /** The LDAP management context. */
private final LDAPManagementContext context;
- // The LDAP profile which should be used to construct LDAP
- // requests and decode LDAP responses.
+ /**
+ * The LDAP profile which should be used to construct LDAP
+ * requests and decode LDAP responses.
+ */
private final LDAPProfile profile;
@@ -184,9 +182,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void close() {
connection.unbind();
@@ -194,9 +190,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <C extends ConfigurationClient, S extends Configuration>
ManagedObject<? extends C> getManagedObject(
@@ -256,9 +250,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
@Override
public <C extends ConfigurationClient, S extends Configuration, PD>
@@ -335,9 +327,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ManagedObject<RootCfgClient> getRootConfigurationManagedObject() {
return new LDAPManagedObject<RootCfgClient>(this,
@@ -347,9 +337,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <C extends ConfigurationClient, S extends Configuration>
String[] listManagedObjects(
@@ -392,9 +380,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <C extends ConfigurationClient, S extends Configuration>
String[] listManagedObjects(
@@ -437,9 +423,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean managedObjectExists(ManagedObjectPath<?, ?> path)
throws ManagedObjectNotFoundException, AuthorizationException,
@@ -460,9 +444,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected <C extends ConfigurationClient, S extends Configuration>
void deleteManagedObject(
@@ -491,9 +473,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected LDAPManagementContext getManagementContext() {
return context;
@@ -583,7 +563,7 @@
- // Create a managed object which already exists on the server.
+ /** Create a managed object which already exists on the server. */
private <M extends ConfigurationClient, N extends Configuration>
ManagedObject<M> createExistingManagedObject(
ManagedObjectDefinition<M, N> d,
@@ -595,13 +575,12 @@
(InstantiableRelationDefinition<?, ?>) rd;
pd = ird.getNamingPropertyDefinition();
}
- return new LDAPManagedObject<M>(this, d, p.asSubType(d), properties, true,
- pd);
+ return new LDAPManagedObject<M>(this, d, p.asSubType(d), properties, true, pd);
}
- // Create a property using the provided string values.
+ /** Create a property using the provided string values. */
private <PD> void decodeProperty(PropertySet newProperties,
ManagedObjectPath<?, ?> p, PropertyDefinition<PD> pd,
Attribute attribute) throws PropertyException,
@@ -655,8 +634,7 @@
- // Determine the type of managed object associated with the named
- // entry.
+ /** Determine the type of managed object associated with the named entry. */
private <C extends ConfigurationClient, S extends Configuration>
ManagedObjectDefinition<? extends C, ? extends S> getEntryDefinition(
AbstractManagedObjectDefinition<C, S> d, LdapName dn)
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/ldap/LDAPManagedObject.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/ldap/LDAPManagedObject.java
index 31e5f4e..b207a23 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/ldap/LDAPManagedObject.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/ldap/LDAPManagedObject.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2007-2009 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin.client.ldap;
@@ -85,16 +85,14 @@
private static final class ValueEncoder extends
PropertyValueVisitor<Object, Void> {
- // Prevent instantiation.
+ /** Prevent instantiation. */
private ValueEncoder() {
// No implementation required.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <C extends ConfigurationClient, S extends Configuration>
Object visitAggregation(
@@ -108,9 +106,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <PD> Object visitUnknown(PropertyDefinition<PD> pd, PD v, Void p)
throws PropertyException {
@@ -120,7 +116,7 @@
- // The LDAP management driver associated with this managed object.
+ /** The LDAP management driver associated with this managed object. */
private final LDAPDriver driver;
@@ -154,9 +150,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected void addNewManagedObject() throws AuthorizationException,
CommunicationException, OperationRejectedException,
@@ -279,9 +273,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected Driver getDriver() {
return driver;
@@ -289,9 +281,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected void modifyExistingManagedObject()
throws ConcurrentModificationException, OperationRejectedException,
@@ -336,9 +326,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected <M extends ConfigurationClient> ManagedObject<M> newInstance(
ManagedObjectDefinition<M, ?> d, ManagedObjectPath<M, ?> path,
@@ -350,7 +338,7 @@
- // Encode a property into LDAP string values.
+ /** Encode a property into LDAP string values. */
private <PD> void encodeProperty(Attribute attribute,
PropertyDefinition<PD> pd) {
PropertyValueVisitor<Object, Void> visitor = new ValueEncoder();
@@ -369,9 +357,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isModified() {
ManagedObjectDefinition<?, ?> d = getManagedObjectDefinition();
for (PropertyDefinition<?> pd : d.getAllPropertyDefinitions()) {
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/ldap/LDAPManagementContext.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/ldap/LDAPManagementContext.java
index 20d4fbb..4d3a47c 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/ldap/LDAPManagementContext.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/ldap/LDAPManagementContext.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin.client.ldap;
@@ -54,12 +54,12 @@
return new LDAPManagementContext(connection, LDAPProfile.getInstance());
}
- // The LDAP management context driver.
+ /** The LDAP management context driver. */
private final LDAPDriver driver;
- // Private constructor.
+ /** Private constructor. */
private LDAPManagementContext(LDAPConnection connection,
LDAPProfile profile) {
this.driver = new LDAPDriver(this, connection, profile);
@@ -67,9 +67,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected Driver getDriver() {
return driver;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/ldap/LDAPNameBuilder.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/ldap/LDAPNameBuilder.java
index f36f6d0..c75d4d9 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/ldap/LDAPNameBuilder.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/ldap/LDAPNameBuilder.java
@@ -22,6 +22,7 @@
*
*
* Copyright 2008-2009 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
package org.opends.server.admin.client.ldap;
@@ -120,10 +121,10 @@
return builder.getInstance();
}
- // The list of RDNs in big-endian order.
+ /** The list of RDNs in big-endian order. */
private final LinkedList<Rdn> rdns;
- // The LDAP profile.
+ /** The LDAP profile. */
private final LDAPProfile profile;
@@ -142,9 +143,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration>
void appendManagedObjectPathElement(
InstantiableRelationDefinition<? super C, ? super S> r,
@@ -184,9 +183,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration>
void appendManagedObjectPathElement(
OptionalRelationDefinition<? super C, ? super S> r,
@@ -197,9 +194,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration>
void appendManagedObjectPathElement(
SingletonRelationDefinition<? super C, ? super S> r,
@@ -210,9 +205,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration>
void appendManagedObjectPathElement(
SetRelationDefinition<? super C, ? super S> r,
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/spi/AbstractManagedObject.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/spi/AbstractManagedObject.java
index 64068f9..e3463ad 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/spi/AbstractManagedObject.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/spi/AbstractManagedObject.java
@@ -88,7 +88,7 @@
private final class DefaultManagedObjectFactory implements
RelationDefinitionVisitor<Void, Void> {
- // Possible exceptions.
+ /** Possible exceptions. */
private AuthorizationException ae;
private ManagedObjectAlreadyExistsException moaee;
private MissingMandatoryPropertiesException mmpe;
@@ -96,9 +96,7 @@
private OperationRejectedException ore;
private CommunicationException ce;
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration>
Void visitInstantiable(
InstantiableRelationDefinition<C, S> rd, Void p) {
@@ -121,9 +119,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration>
Void visitOptional(
OptionalRelationDefinition<C, S> rd, Void p) {
@@ -140,9 +136,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration>
Void visitSingleton(
SingletonRelationDefinition<C, S> rd, Void p) {
@@ -153,9 +147,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration>
Void visitSet(
SetRelationDefinition<C, S> rd, Void p) {
@@ -172,7 +164,7 @@
- // Create the child managed object.
+ /** Create the child managed object. */
private void createDefaultManagedObject(ManagedObjectDefinition<?, ?> d,
ManagedObject<?> child, DefaultManagedObject<?, ?> dmo) {
for (PropertyDefinition<?> pd : d.getAllPropertyDefinitions()) {
@@ -228,7 +220,7 @@
- // Set property values.
+ /** Set property values. */
private <PD> void setPropertyValues(ManagedObject<?> mo,
PropertyDefinition<PD> pd, DefaultManagedObject<?, ?> dmo) {
mo.setPropertyValues(pd, dmo.getPropertyValues(pd));
@@ -237,22 +229,22 @@
- // The managed object definition associated with this managed
- // object.
+ /** The managed object definition associated with this managed object. */
private final ManagedObjectDefinition<T, ? extends Configuration> definition;
- // Indicates whether or not this managed object exists on the server
- // (false means the managed object is new and has not been
- // committed).
+ /**
+ * Indicates whether or not this managed object exists on the server
+ * (false means the managed object is new and has not been committed).
+ */
private boolean existsOnServer;
- // Optional naming property definition.
+ /** Optional naming property definition. */
private final PropertyDefinition<?> namingPropertyDefinition;
- // The path associated with this managed object.
+ /** The path associated with this managed object. */
private ManagedObjectPath<T, ? extends Configuration> path;
- // The managed object's properties.
+ /** The managed object's properties. */
private final PropertySet properties;
@@ -287,9 +279,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final void commit() throws ManagedObjectAlreadyExistsException,
MissingMandatoryPropertiesException, ConcurrentModificationException,
OperationRejectedException, AuthorizationException,
@@ -368,9 +358,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final <C extends ConfigurationClient, S extends Configuration,
CC extends C>
ManagedObject<CC> createChild(
@@ -402,9 +390,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final <C extends ConfigurationClient,
S extends Configuration, CC extends C>
ManagedObject<CC> createChild(
@@ -419,9 +405,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final <C extends ConfigurationClient, S extends Configuration,
CC extends C>
ManagedObject<CC> createChild(
@@ -437,9 +421,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final <C extends ConfigurationClient, S extends Configuration>
ManagedObject<? extends C> getChild(
InstantiableRelationDefinition<C, S> r, String name)
@@ -455,9 +437,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final <C extends ConfigurationClient, S extends Configuration>
ManagedObject<? extends C> getChild(
OptionalRelationDefinition<C, S> r) throws IllegalArgumentException,
@@ -472,9 +452,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final <C extends ConfigurationClient, S extends Configuration>
ManagedObject<? extends C> getChild(
SingletonRelationDefinition<C, S> r) throws IllegalArgumentException,
@@ -489,9 +467,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final <C extends ConfigurationClient, S extends Configuration>
ManagedObject<? extends C> getChild(
SetRelationDefinition<C, S> r, String name)
@@ -523,18 +499,14 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final T getConfiguration() {
return definition.createClientConfiguration(this);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final ManagedObjectDefinition<T, ? extends Configuration>
getManagedObjectDefinition() {
return definition;
@@ -542,9 +514,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final ManagedObjectPath<T, ? extends Configuration>
getManagedObjectPath() {
return path;
@@ -552,9 +522,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final <PD> SortedSet<PD> getPropertyDefaultValues(
PropertyDefinition<PD> pd) throws IllegalArgumentException {
return new TreeSet<PD>(getProperty(pd).getDefaultValues());
@@ -562,9 +530,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final <PD> PD getPropertyValue(PropertyDefinition<PD> pd)
throws IllegalArgumentException {
Set<PD> values = getProperty(pd).getEffectiveValues();
@@ -577,9 +543,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final <PD> SortedSet<PD> getPropertyValues(PropertyDefinition<PD> pd)
throws IllegalArgumentException {
return new TreeSet<PD>(getProperty(pd).getEffectiveValues());
@@ -587,9 +551,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final <C extends ConfigurationClient, S extends Configuration>
boolean hasChild(
OptionalRelationDefinition<C, S> r) throws IllegalArgumentException,
@@ -606,9 +568,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final boolean isPropertyPresent(PropertyDefinition<?> pd)
throws IllegalArgumentException {
return !getProperty(pd).isEmpty();
@@ -616,9 +576,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final <C extends ConfigurationClient, S extends Configuration>
String[] listChildren(
InstantiableRelationDefinition<C, S> r) throws IllegalArgumentException,
@@ -629,9 +587,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final <C extends ConfigurationClient, S extends Configuration>
String[] listChildren(
InstantiableRelationDefinition<C, S> r,
@@ -649,9 +605,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final <C extends ConfigurationClient, S extends Configuration>
String[] listChildren(
SetRelationDefinition<C, S> r) throws IllegalArgumentException,
@@ -662,9 +616,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final <C extends ConfigurationClient, S extends Configuration>
String[] listChildren(
SetRelationDefinition<C, S> r,
@@ -682,9 +634,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final <C extends ConfigurationClient, S extends Configuration>
void removeChild(
InstantiableRelationDefinition<C, S> r, String name)
@@ -708,9 +658,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final <C extends ConfigurationClient, S extends Configuration>
void removeChild(
OptionalRelationDefinition<C, S> r) throws IllegalArgumentException,
@@ -734,9 +682,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final <C extends ConfigurationClient, S extends Configuration>
void removeChild(
SetRelationDefinition<C, S> r, String name)
@@ -760,9 +706,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final <PD> void setPropertyValue(PropertyDefinition<PD> pd, PD value)
throws PropertyException, PropertyException,
PropertyException, IllegalArgumentException {
@@ -775,9 +719,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final <PD> void setPropertyValues(PropertyDefinition<PD> pd,
Collection<PD> values) throws PropertyException,
PropertyException, PropertyException,
@@ -802,9 +744,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
StringBuilder builder = new StringBuilder();
@@ -952,8 +892,10 @@
- // Creates a new managed object with no active values, just default
- // values.
+ /**
+ * Creates a new managed object with no active values, just default
+ * values.
+ */
private <M extends ConfigurationClient, PD> ManagedObject<M>
createNewManagedObject(
ManagedObjectDefinition<M, ?> d, ManagedObjectPath<M, ?> p,
@@ -983,7 +925,7 @@
- // Create an empty property.
+ /** Create an empty property. */
private <PD> void createProperty(PropertySet properties,
ManagedObjectPath<?, ?> p, PropertyDefinition<PD> pd)
throws PropertyException {
@@ -1001,7 +943,7 @@
- // Makes sure that this managed object exists.
+ /** Makes sure that this managed object exists. */
private void ensureThisManagedObjectExists()
throws ConcurrentModificationException, CommunicationException,
AuthorizationException {
@@ -1020,8 +962,7 @@
- // Validate that a relation definition belongs to this managed
- // object.
+ /** Validate that a relation definition belongs to this managed object. */
private void validateRelationDefinition(RelationDefinition<?, ?> rd)
throws IllegalArgumentException {
ManagedObjectDefinition<T, ?> d = getManagedObjectDefinition();
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/spi/Driver.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/spi/Driver.java
index c5b76a7..3d044b3 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/spi/Driver.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/spi/Driver.java
@@ -89,25 +89,24 @@
private class DefaultValueFinder<T> implements
DefaultBehaviorProviderVisitor<T, Collection<T>, Void> {
- // Any exception that occurred whilst retrieving inherited default
- // values.
+ /** Any exception that occurred whilst retrieving inherited default values. */
private PropertyException exception;
- // The path of the managed object containing the first property.
+ /** The path of the managed object containing the first property. */
private final ManagedObjectPath<?, ?> firstPath;
- // Indicates whether the managed object has been created yet.
+ /** Indicates whether the managed object has been created yet. */
private final boolean isCreate;
- // The path of the managed object containing the next property.
+ /** The path of the managed object containing the next property. */
private ManagedObjectPath<?, ?> nextPath;
- // The next property whose default values were required.
+ /** The next property whose default values were required. */
private PropertyDefinition<T> nextProperty;
- // Private constructor.
+ /** Private constructor. */
private DefaultValueFinder(ManagedObjectPath<?, ?> p, boolean isCreate) {
this.firstPath = p;
this.isCreate = isCreate;
@@ -115,9 +114,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<T> visitAbsoluteInherited(
AbsoluteInheritedDefaultBehaviorProvider<T> d, Void p) {
try {
@@ -131,18 +128,14 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<T> visitAlias(AliasDefaultBehaviorProvider<T> d, Void p) {
return Collections.emptySet();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<T> visitDefined(DefinedDefaultBehaviorProvider<T> d,
Void p) {
Collection<String> stringValues = d.getDefaultValues();
@@ -162,9 +155,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<T> visitRelativeInherited(
RelativeInheritedDefaultBehaviorProvider<T> d, Void p) {
try {
@@ -178,9 +169,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<T> visitUndefined(UndefinedDefaultBehaviorProvider<T> d,
Void p) {
return Collections.emptySet();
@@ -188,7 +177,7 @@
- // Find the default values for the next path/property.
+ /** Find the default values for the next path/property. */
private Collection<T> find(ManagedObjectPath<?, ?> p,
PropertyDefinition<T> pd) throws PropertyException {
this.nextPath = p;
@@ -211,7 +200,7 @@
- // Get an inherited property value.
+ /** Get an inherited property value. */
@SuppressWarnings("unchecked")
private Collection<T> getInheritedProperty(ManagedObjectPath target,
AbstractManagedObjectDefinition<?, ?> d, String propertyName)
@@ -757,9 +746,11 @@
- // Remove a managed object, first ensuring that the parent exists,
- // then ensuring that the child exists, before ensuring that any
- // constraints are satisfied.
+ /**
+ * Remove a managed object, first ensuring that the parent exists,
+ * then ensuring that the child exists, before ensuring that any
+ * constraints are satisfied.
+ */
private <C extends ConfigurationClient, S extends Configuration>
boolean doDeleteManagedObject(
ManagedObjectPath<C, S> path) throws ManagedObjectNotFoundException,
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/spi/PropertySet.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/spi/PropertySet.java
index a470db0..dce5e1f 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/client/spi/PropertySet.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/client/spi/PropertySet.java
@@ -51,16 +51,16 @@
*/
private static final class MyProperty<T> implements Property<T> {
- // The active set of values.
+ /** The active set of values. */
private final SortedSet<T> activeValues;
- // The definition associated with this property.
+ /** The definition associated with this property. */
private final PropertyDefinition<T> d;
- // The default set of values (read-only).
+ /** The default set of values (read-only). */
private final SortedSet<T> defaultValues;
- // The pending set of values.
+ /** The pending set of values. */
private final SortedSet<T> pendingValues;
@@ -105,27 +105,21 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public SortedSet<T> getActiveValues() {
return Collections.unmodifiableSortedSet(activeValues);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public SortedSet<T> getDefaultValues() {
return defaultValues;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public SortedSet<T> getEffectiveValues() {
SortedSet<T> values = getPendingValues();
@@ -138,36 +132,28 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public SortedSet<T> getPendingValues() {
return Collections.unmodifiableSortedSet(pendingValues);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public PropertyDefinition<T> getPropertyDefinition() {
return d;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isEmpty() {
return pendingValues.isEmpty();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isModified() {
return activeValues.size() != pendingValues.size()
|| !activeValues.containsAll(pendingValues);
@@ -189,9 +175,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
return getEffectiveValues().toString();
@@ -199,15 +183,13 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean wasEmpty() {
return activeValues.isEmpty();
}
}
- // The properties.
+ /** The properties. */
private final Map<PropertyDefinition<?>, MyProperty<?>> properties;
@@ -268,9 +250,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
StringBuilder builder = new StringBuilder();
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/ANDCondition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/ANDCondition.java
index e741f2b..5baed05 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/ANDCondition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/ANDCondition.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin.condition;
@@ -48,7 +48,7 @@
*/
public final class ANDCondition implements Condition {
- // The list of sub-conditions.
+ /** The list of sub-conditions. */
private final List<Condition> conditions;
@@ -68,9 +68,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ManagementContext context,
ManagedObject<?> managedObject) throws AuthorizationException,
CommunicationException {
@@ -84,9 +82,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ServerManagedObject<?> managedObject)
throws ConfigException {
for (Condition condition : conditions) {
@@ -99,9 +95,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void initialize(AbstractManagedObjectDefinition<?, ?> d)
throws Exception {
for (Condition condition : conditions) {
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/Conditions.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/Conditions.java
index 411ff22..204bf4f 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/Conditions.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/Conditions.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin.condition;
@@ -49,9 +49,7 @@
*/
public static final Condition FALSE = new Condition() {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ManagementContext context,
ManagedObject<?> managedObject) throws AuthorizationException,
CommunicationException {
@@ -60,9 +58,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ServerManagedObject<?> managedObject)
throws ConfigException {
return false;
@@ -70,9 +66,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void initialize(AbstractManagedObjectDefinition<?, ?> d)
throws Exception {
// No implementation required.
@@ -85,9 +79,7 @@
*/
public static final Condition TRUE = new Condition() {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ManagementContext context,
ManagedObject<?> managedObject) throws AuthorizationException,
CommunicationException {
@@ -96,9 +88,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ServerManagedObject<?> managedObject)
throws ConfigException {
return true;
@@ -106,9 +96,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void initialize(AbstractManagedObjectDefinition<?, ?> d)
throws Exception {
// No implementation required.
@@ -229,7 +217,7 @@
- // Prevent instantiation.
+ /** Prevent instantiation. */
private Conditions() {
// No implementation required.
}
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/ContainsCondition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/ContainsCondition.java
index 00bc377..160cdbc 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/ContainsCondition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/ContainsCondition.java
@@ -57,15 +57,15 @@
*/
private static final class Impl<T> implements Condition {
- // The property.
+ /** The property. */
final PropertyDefinition<T> pd;
- // The required property value.
+ /** The required property value. */
final T value;
- // Private constructor.
+ /** Private constructor. */
private Impl(PropertyDefinition<T> pd, T value)
throws PropertyException {
this.pd = pd;
@@ -74,9 +74,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ManagementContext context,
ManagedObject<?> managedObject) throws AuthorizationException,
CommunicationException {
@@ -86,9 +84,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ServerManagedObject<?> managedObject)
throws ConfigException {
SortedSet<T> values = managedObject.getPropertyValues(pd);
@@ -97,9 +93,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void initialize(AbstractManagedObjectDefinition<?, ?> d)
throws Exception {
// Not used.
@@ -107,20 +101,20 @@
- // Private implementation of fix() method.
+ /** Private implementation of fix() method. */
private void setPropertyValue(ManagedObject<?> managedObject) {
managedObject.setPropertyValue(pd, value);
}
}
- // The strongly typed private implementation.
+ /** The strongly typed private implementation. */
private Impl<?> impl;
- // The property name.
+ /** The property name. */
private final String propertyName;
- // The string representation of the required property value.
+ /** The string representation of the required property value. */
private final String propertyStringValue;
@@ -142,9 +136,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ManagementContext context,
ManagedObject<?> managedObject) throws AuthorizationException,
CommunicationException {
@@ -153,9 +145,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ServerManagedObject<?> managedObject)
throws ConfigException {
return impl.evaluate(managedObject);
@@ -176,9 +166,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void initialize(AbstractManagedObjectDefinition<?, ?> d)
throws Exception {
// Decode the property.
@@ -187,7 +175,7 @@
- // Creates the new private implementation.
+ /** Creates the new private implementation. */
private <T> void buildImpl(PropertyDefinition<T> pd)
throws PropertyException {
T value = pd.decodeValue(propertyStringValue);
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/IsPresentCondition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/IsPresentCondition.java
index 3e261d2..167f925 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/IsPresentCondition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/IsPresentCondition.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin.condition;
@@ -48,10 +48,10 @@
*/
public final class IsPresentCondition implements Condition {
- // The property name.
+ /** The property name. */
private final String propertyName;
- // The property definition.
+ /** The property definition. */
private PropertyDefinition<?> pd;
@@ -69,9 +69,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ManagementContext context,
ManagedObject<?> managedObject) throws AuthorizationException,
CommunicationException {
@@ -81,9 +79,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ServerManagedObject<?> managedObject)
throws ConfigException {
SortedSet<?> values = managedObject.getPropertyValues(pd);
@@ -92,9 +88,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void initialize(AbstractManagedObjectDefinition<?, ?> d)
throws Exception {
// Decode the property.
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/NOTCondition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/NOTCondition.java
index 0a8b8d9..450e6cf 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/NOTCondition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/NOTCondition.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin.condition;
@@ -46,7 +46,7 @@
*/
public final class NOTCondition implements Condition {
- // The single sub-condition.
+ /** The single sub-condition. */
private final Condition condition;
@@ -65,9 +65,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ManagementContext context,
ManagedObject<?> managedObject) throws AuthorizationException,
CommunicationException {
@@ -76,9 +74,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ServerManagedObject<?> managedObject)
throws ConfigException {
return !condition.evaluate(managedObject);
@@ -86,9 +82,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void initialize(AbstractManagedObjectDefinition<?, ?> d)
throws Exception {
condition.initialize(d);
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/ORCondition.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/ORCondition.java
index 26026f5..c606a87 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/ORCondition.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/condition/ORCondition.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin.condition;
@@ -48,7 +48,7 @@
*/
public final class ORCondition implements Condition {
- // The list of sub-conditions.
+ /** The list of sub-conditions. */
private final List<Condition> conditions;
@@ -68,9 +68,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ManagementContext context,
ManagedObject<?> managedObject) throws AuthorizationException,
CommunicationException {
@@ -84,9 +82,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ServerManagedObject<?> managedObject)
throws ConfigException {
for (Condition condition : conditions) {
@@ -99,9 +95,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void initialize(AbstractManagedObjectDefinition<?, ?> d)
throws Exception {
for (Condition condition : conditions) {
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/doc/ConfigGuideGeneration.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/doc/ConfigGuideGeneration.java
index 08e7456..a322e51 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/doc/ConfigGuideGeneration.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/doc/ConfigGuideGeneration.java
@@ -1367,7 +1367,7 @@
"</head>\n");
}
- // Add a Tab Menu, the active tab is the one given as parameter
+ /** Add a Tab Menu, the active tab is the one given as parameter. */
private void tabMenu(String activeTab) {
htmlBuff.append(
"<div class=\"tabmenu\"> " +
@@ -1506,7 +1506,7 @@
htmlBuff.append("<tbody>\n");
}
- /*
+ /**
* Generate a "friendly" name from a string :
* '-' and '_' replaced by space
* first letter of a word in uppercase
@@ -1596,14 +1596,14 @@
htmlBuff = new StringBuffer();
}
- // Relation List from RootConfiguration
+ /** Relation List from RootConfiguration. */
private final TreeMap<String, RelationDefinition> topRelList =
new TreeMap<String, RelationDefinition>();
private final TreeMap<String, RelationDefinition> relList =
new TreeMap<String, RelationDefinition>();
private final TreeMap<String, TreeMap<String, RelationDefinition>>
catTopRelList = new TreeMap<String, TreeMap<String, RelationDefinition>>();
- // managed object list
+ /** Managed object list. */
private final TreeMap<String, AbstractManagedObjectDefinition> moList =
new TreeMap<String, AbstractManagedObjectDefinition>();
private final TreeMap<String, AbstractManagedObjectDefinition> topMoList =
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConfigAddListenerAdaptor.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConfigAddListenerAdaptor.java
index b54c5c4..cb62ef5 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConfigAddListenerAdaptor.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConfigAddListenerAdaptor.java
@@ -62,22 +62,22 @@
AbstractConfigListenerAdaptor implements ConfigAddListener {
private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
- // Cached managed object between accept/apply callbacks.
+ /** Cached managed object between accept/apply callbacks. */
private ServerManagedObject<? extends S> cachedManagedObject;
- // The instantiable relation.
+ /** The instantiable relation. */
private final InstantiableRelationDefinition<?, S> instantiableRelation;
- // The set relation.
+ /** The set relation. */
private final SetRelationDefinition<?, S> setRelation;
- // The underlying add listener.
+ /** The underlying add listener. */
private final ServerManagedObjectAddListener<S> listener;
- // The optional relation.
+ /** The optional relation. */
private final OptionalRelationDefinition<?, S> optionalRelation;
- // The managed object path of the parent.
+ /** The managed object path of the parent. */
private final ManagedObjectPath<?, ?> path;
@@ -154,9 +154,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ConfigChangeResult applyConfigurationAdd(ConfigEntry configEntry) {
if (optionalRelation != null) {
@@ -196,9 +194,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean configAddIsAcceptable(ConfigEntry configEntry,
LocalizableMessageBuilder unacceptableReason) {
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConfigChangeListenerAdaptor.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConfigChangeListenerAdaptor.java
index 93b32bf..93926a8 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConfigChangeListenerAdaptor.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConfigChangeListenerAdaptor.java
@@ -106,21 +106,19 @@
db.accept(v, path);
}
- // The names of entries that this change listener depends on.
+ /** The names of entries that this change listener depends on. */
private final Collection<DN> dependencies;
- // Prevent instantiation.
+ /** Prevent instantiation. */
private Visitor(Collection<DN> dependencies) {
this.dependencies = dependencies;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Void visitAbsoluteInherited(
AbsoluteInheritedDefaultBehaviorProvider<T> d,
ManagedObjectPath<?, ?> p) {
@@ -140,9 +138,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Void visitAlias(AliasDefaultBehaviorProvider<T> d,
ManagedObjectPath<?, ?> p) {
return null;
@@ -150,9 +146,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Void visitDefined(DefinedDefaultBehaviorProvider<T> d,
ManagedObjectPath<?, ?> p) {
return null;
@@ -160,9 +154,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Void visitRelativeInherited(
RelativeInheritedDefaultBehaviorProvider<T> d,
ManagedObjectPath<?, ?> p) {
@@ -182,9 +174,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Void visitUndefined(UndefinedDefaultBehaviorProvider<T> d,
ManagedObjectPath<?, ?> p) {
return null;
@@ -192,27 +182,31 @@
}
private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
- // Cached managed object between accept/apply call-backs.
+ /** Cached managed object between accept/apply call-backs. */
private ServerManagedObject<? extends S> cachedManagedObject;
- // The delete listener which is used to remove this listener and any
- // dependencies.
+ /**
+ * The delete listener which is used to remove this listener and any
+ * dependencies.
+ */
private final ConfigDeleteListener cleanerListener;
- // The names of entries that this change listener depends on.
+ /** The names of entries that this change listener depends on. */
private final Set<DN> dependencies;
- // The listener used to notify this listener when dependency entries
- // are modified.
+ /**
+ * The listener used to notify this listener when dependency entries
+ * are modified.
+ */
private final ConfigChangeListener dependencyListener;
- // The DN associated with this listener.
+ /** The DN associated with this listener. */
private final DN dn;
- // The underlying change listener.
+ /** The underlying change listener. */
private final ServerManagedObjectChangeListener<? super S> listener;
- // The managed object path.
+ /** The managed object path. */
private final ManagedObjectPath<?, S> path;
@@ -320,9 +314,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ConfigChangeResult applyConfigurationChange(ConfigEntry configEntry) {
// Looking at the ConfigFileHandler implementation reveals
// that this ConfigEntry will actually be a different object to
@@ -355,9 +347,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean configChangeIsAcceptable(ConfigEntry configEntry,
LocalizableMessageBuilder unacceptableReason) {
return configChangeIsAcceptable(configEntry, unacceptableReason,
@@ -453,8 +443,9 @@
- // Returns the named configuration entry or null if it could not be
- // retrieved.
+ /**
+ * Returns the named configuration entry or null if it could not be retrieved.
+ */
private ConfigEntry getConfigEntry(DN dn) {
try {
ConfigEntry configEntry = DirectoryServer.getConfigEntry(dn);
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConfigDeleteListenerAdaptor.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConfigDeleteListenerAdaptor.java
index 61926f6..d77d703 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConfigDeleteListenerAdaptor.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConfigDeleteListenerAdaptor.java
@@ -67,22 +67,22 @@
AbstractConfigListenerAdaptor implements ConfigDeleteListener {
private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
- // Cached managed object between accept/apply callbacks.
+ /** Cached managed object between accept/apply callbacks. */
private ServerManagedObject<? extends S> cachedManagedObject;
- // The instantiable relation.
+ /** The instantiable relation. */
private final InstantiableRelationDefinition<?, S> instantiableRelation;
- // The set relation.
+ /** The set relation. */
private final SetRelationDefinition<?, S> setRelation;
- // The underlying delete listener.
+ /** The underlying delete listener. */
private final ServerManagedObjectDeleteListener<S> listener;
- // The optional relation.
+ /** The optional relation. */
private final OptionalRelationDefinition<?, S> optionalRelation;
- // The managed object path of the parent.
+ /** The managed object path of the parent. */
private final ManagedObjectPath<?, ?> path;
@@ -159,9 +159,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ConfigChangeResult applyConfigurationDelete(ConfigEntry configEntry) {
if (optionalRelation != null) {
// Optional managed objects are located directly beneath the
@@ -201,9 +199,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean configDeleteIsAcceptable(ConfigEntry configEntry,
LocalizableMessageBuilder unacceptableReason) {
DN dn = configEntry.getDN();
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConfigExceptionFactory.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConfigExceptionFactory.java
index 9efa370..8a1f432 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConfigExceptionFactory.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConfigExceptionFactory.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin.server;
@@ -38,13 +38,13 @@
*/
final class ConfigExceptionFactory {
- // The singleton instance.
+ /** The singleton instance. */
private static final ConfigExceptionFactory INSTANCE =
new ConfigExceptionFactory();
- // Prevent instantiation.
+ /** Prevent instantiation. */
private ConfigExceptionFactory() {
// Do nothing.
}
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConstraintViolationException.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConstraintViolationException.java
index 26cb265..273549a 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConstraintViolationException.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ConstraintViolationException.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin.server;
@@ -54,12 +54,12 @@
*/
private static final long serialVersionUID = -4902443848460011875L;
- // The server managed object.
+ /** The server managed object. */
private final ServerManagedObject<?> managedObject;
- // Gets the default message.
+ /** Gets the default message. */
private static LocalizableMessage getDefaultMessage(Collection<LocalizableMessage> messages) {
Reject.ifNull(messages);
Reject.ifFalse(!messages.isEmpty());
@@ -75,7 +75,7 @@
- // Merge the messages into a single message.
+ /** Merge the messages into a single message. */
private static LocalizableMessage getSingleMessage(Collection<LocalizableMessage> messages) {
if (messages.size() == 1) {
return messages.iterator().next();
@@ -95,7 +95,7 @@
}
}
- // The messages describing the constraint violations that occurred.
+ /** The messages describing the constraint violations that occurred. */
private final Collection<LocalizableMessage> messages;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/DNBuilder.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/DNBuilder.java
index 6eb97eb..009e5dd 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/DNBuilder.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/DNBuilder.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin.server;
@@ -83,7 +83,7 @@
- // Prevent instantiation.
+ /** Prevent instantiation. */
private DNBuilder() {
// No implementation required.
}
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/DelayedConfigAddListener.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/DelayedConfigAddListener.java
index ed79493..b6f1dfa 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/DelayedConfigAddListener.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/DelayedConfigAddListener.java
@@ -46,20 +46,25 @@
final class DelayedConfigAddListener implements ConfigAddListener {
private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
- // The name of the parent entry.
+ /** The name of the parent entry. */
private final DN parent;
- // The name of the subordinate entry which should have an add or
- // delete listener registered with it when it is created.
+ /**
+ * The name of the subordinate entry which should have an add or
+ * delete listener registered with it when it is created.
+ */
private final DN child;
- // The add listener to be registered with the subordinate entry when
- // it is added (or null if a delete listener should be registered).
+ /**
+ * The add listener to be registered with the subordinate entry when
+ * it is added (or null if a delete listener should be registered).
+ */
private final ConfigAddListener delayedAddListener;
- // The delete listener to be registered with the subordinate entry
- // when it is added (or null if an add listener should be
- // registered).
+ /**
+ * The delete listener to be registered with the subordinate entry
+ * when it is added (or null if an add listener should be registered).
+ */
private final ConfigDeleteListener delayedDeleteListener;
@@ -105,9 +110,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ConfigChangeResult applyConfigurationAdd(ConfigEntry configEntry) {
if (configEntry.getDN().equals(child)) {
// The subordinate entry matched our criteria so register the
@@ -139,9 +142,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean configAddIsAcceptable(ConfigEntry configEntry,
LocalizableMessageBuilder unacceptableReason) {
// Always acceptable.
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObject.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObject.java
index 3721606..e41c068 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObject.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObject.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2006-2009 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin.server;
@@ -73,22 +73,23 @@
PropertyProvider {
private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
- // The configuration entry associated with this server managed
- // object (null if root).
+ /**
+ * The configuration entry associated with this server managed
+ * object (null if root).
+ */
private ConfigEntry configEntry;
- // The management context.
+ /** The management context. */
private final ServerManagementContext context = ServerManagementContext
.getInstance();
- // The managed object's definition.
+ /** The managed object's definition. */
private final ManagedObjectDefinition<?, S> definition;
- // The managed object path identifying this managed object's
- // location.
+ /** The managed object path identifying this managed object's location. */
private final ManagedObjectPath<?, S> path;
- // The managed object's properties.
+ /** The managed object's properties. */
private final Map<PropertyDefinition<?>, SortedSet<?>> properties;
@@ -1129,9 +1130,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
StringBuilder builder = new StringBuilder();
@@ -1205,7 +1204,7 @@
- // Deregister an add listener.
+ /** Deregister an add listener. */
private <M extends Configuration> void deregisterAddListener(DN baseDN,
ConfigurationAddListener<M> listener) {
try {
@@ -1241,7 +1240,7 @@
- // Deregister an add listener.
+ /** Deregister an add listener. */
private <M extends Configuration> void deregisterAddListener(DN baseDN,
ServerManagedObjectAddListener<M> listener) {
try {
@@ -1271,7 +1270,7 @@
- // Deregister a delete listener.
+ /** Deregister a delete listener. */
private <M extends Configuration> void deregisterDeleteListener(DN baseDN,
ConfigurationDeleteListener<M> listener) {
try {
@@ -1307,7 +1306,7 @@
- // Deregister a delete listener.
+ /** Deregister a delete listener. */
private <M extends Configuration> void deregisterDeleteListener(DN baseDN,
ServerManagedObjectDeleteListener<M> listener) {
try {
@@ -1337,8 +1336,10 @@
- // Gets a config entry required for a listener and throws a config
- // exception on failure or returns null if the entry does not exist.
+ /**
+ * Gets a config entry required for a listener and throws a config
+ * exception on failure or returns null if the entry does not exist.
+ */
private ConfigEntry getListenerConfigEntry(DN dn) throws ConfigException {
// Attempt to retrieve the listener base entry.
ConfigEntry configEntry;
@@ -1357,7 +1358,7 @@
- // Register an instantiable or optional relation add listener.
+ /** Register an instantiable or optional relation add listener. */
private void registerAddListener(DN baseDN, ConfigAddListener adaptor)
throws IllegalArgumentException, ConfigException {
ConfigEntry relationEntry = getListenerConfigEntry(baseDN);
@@ -1375,8 +1376,10 @@
- // Register a delayed listener with the nearest existing parent
- // entry to the provided base DN.
+ /**
+ * Register a delayed listener with the nearest existing parent
+ * entry to the provided base DN.
+ */
private void registerDelayedListener(DN baseDN,
ConfigAddListener delayedListener) throws ConfigException {
DN parentDN = baseDN.parent();
@@ -1397,8 +1400,10 @@
throw new ConfigException(message);
}
- // Deregister a delayed listener with the nearest existing parent
- // entry to the provided base DN.
+ /**
+ * Deregister a delayed listener with the nearest existing parent
+ * entry to the provided base DN.
+ */
private <M extends Configuration> void deregisterDelayedAddListener(DN baseDN,
ConfigurationAddListener<M> listener) throws ConfigException {
DN parentDN = baseDN.parent();
@@ -1463,8 +1468,10 @@
}
- // Deregister a delayed listener with the nearest existing parent
- // entry to the provided base DN.
+ /**
+ * Deregister a delayed listener with the nearest existing parent
+ * entry to the provided base DN.
+ */
private <M extends Configuration> void deregisterDelayedDeleteListener(
DN baseDN, ConfigurationDeleteListener<M> listener)
throws ConfigException {
@@ -1529,8 +1536,10 @@
}
}
- // Deregister a delayed listener with the nearest existing parent
- // entry to the provided base DN.
+ /**
+ * Deregister a delayed listener with the nearest existing parent
+ * entry to the provided base DN.
+ */
private <M extends Configuration> void deregisterDelayedAddListener(DN baseDN,
ServerManagedObjectAddListener<M> listener) throws ConfigException {
DN parentDN = baseDN.parent();
@@ -1589,8 +1598,10 @@
}
- // Deregister a delayed listener with the nearest existing parent
- // entry to the provided base DN.
+ /**
+ * Deregister a delayed listener with the nearest existing parent
+ * entry to the provided base DN.
+ */
private <M extends Configuration> void deregisterDelayedDeleteListener(
DN baseDN, ServerManagedObjectDeleteListener<M> listener)
throws ConfigException {
@@ -1650,7 +1661,7 @@
}
- // Register an instantiable or optional relation delete listener.
+ /** Register an instantiable or optional relation delete listener. */
private void registerDeleteListener(DN baseDN, ConfigDeleteListener adaptor)
throws ConfigException {
ConfigEntry relationEntry = getListenerConfigEntry(baseDN);
@@ -1668,8 +1679,7 @@
- // Validate that a relation definition belongs to this managed
- // object.
+ /** Validate that a relation definition belongs to this managed object. */
private void validateRelationDefinition(RelationDefinition<?, ?> rd)
throws IllegalArgumentException {
RelationDefinition<?, ?> tmp = definition.getRelationDefinition(rd
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObjectAddListenerAdaptor.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObjectAddListenerAdaptor.java
index 7bd1677..67acbd1 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObjectAddListenerAdaptor.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObjectAddListenerAdaptor.java
@@ -44,7 +44,7 @@
final class ServerManagedObjectAddListenerAdaptor<T extends Configuration>
implements ServerManagedObjectAddListener<T> {
- // The underlying add listener.
+ /** The underlying add listener. */
private final ConfigurationAddListener<T> listener;
@@ -62,9 +62,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ConfigChangeResult applyConfigurationAdd(
ServerManagedObject<? extends T> mo) {
@@ -85,9 +83,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isConfigurationAddAcceptable(
ServerManagedObject<? extends T> mo, List<LocalizableMessage> unacceptableReasons) {
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObjectChangeListenerAdaptor.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObjectChangeListenerAdaptor.java
index 15edf4c..9002be1 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObjectChangeListenerAdaptor.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObjectChangeListenerAdaptor.java
@@ -44,7 +44,7 @@
final class ServerManagedObjectChangeListenerAdaptor<T extends Configuration>
implements ServerManagedObjectChangeListener<T> {
- // The underlying change listener.
+ /** The underlying change listener. */
private final ConfigurationChangeListener<? super T> listener;
@@ -80,9 +80,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isConfigurationChangeAcceptable(
ServerManagedObject<? extends T> mo, List<LocalizableMessage> unacceptableReasons) {
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObjectDecodingException.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObjectDecodingException.java
index 07b2e94..80184d0 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObjectDecodingException.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObjectDecodingException.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.admin.server;
@@ -57,7 +57,7 @@
- // Create the message.
+ /** Create the message. */
private static LocalizableMessage createMessage(
ServerManagedObject<?> partialManagedObject,
Collection<PropertyException> causes) {
@@ -86,10 +86,10 @@
}
}
- // The exception(s) that caused this decoding exception.
+ /** The exception(s) that caused this decoding exception. */
private final Collection<PropertyException> causes;
- // The partially created server managed object.
+ /** The partially created server managed object. */
private final ServerManagedObject<?> partialManagedObject;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObjectDeleteListenerAdaptor.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObjectDeleteListenerAdaptor.java
index 10cd6c9..e1dd0ab 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObjectDeleteListenerAdaptor.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagedObjectDeleteListenerAdaptor.java
@@ -44,7 +44,7 @@
final class ServerManagedObjectDeleteListenerAdaptor<T extends Configuration>
implements ServerManagedObjectDeleteListener<T> {
- // The underlying delete listener.
+ /** The underlying delete listener. */
private final ConfigurationDeleteListener<T> listener;
@@ -62,9 +62,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ConfigChangeResult applyConfigurationDelete(
ServerManagedObject<? extends T> mo) {
@@ -86,9 +84,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isConfigurationDeleteAcceptable(
ServerManagedObject<? extends T> mo, List<LocalizableMessage> unacceptableReasons) {
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagementContext.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagementContext.java
index 3f201e9..2a57377 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagementContext.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/server/ServerManagementContext.java
@@ -93,32 +93,33 @@
private class DefaultValueFinder<T> implements
DefaultBehaviorProviderVisitor<T, Collection<T>, Void> {
- // Any exception that occurred whilst retrieving inherited default
- // values.
+ /**
+ * Any exception that occurred whilst retrieving inherited default values.
+ */
private PropertyException exception;
- // Optional new configuration entry which does not yet exist in
- // the configuration back-end.
+ /**
+ * Optional new configuration entry which does not yet exist in
+ * the configuration back-end.
+ */
private final ConfigEntry newConfigEntry;
- // The path of the managed object containing the next property.
+ /** The path of the managed object containing the next property. */
private ManagedObjectPath<?, ?> nextPath;
- // The next property whose default values were required.
+ /** The next property whose default values were required. */
private PropertyDefinition<T> nextProperty;
- // Private constructor.
+ /** Private constructor. */
private DefaultValueFinder(ConfigEntry newConfigEntry) {
this.newConfigEntry = newConfigEntry;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Collection<T> visitAbsoluteInherited(
AbsoluteInheritedDefaultBehaviorProvider<T> d, Void p) {
@@ -133,9 +134,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Collection<T> visitAlias(AliasDefaultBehaviorProvider<T> d, Void p) {
return Collections.emptySet();
@@ -143,9 +142,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Collection<T> visitDefined(DefinedDefaultBehaviorProvider<T> d,
Void p) {
@@ -166,9 +163,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Collection<T> visitRelativeInherited(
RelativeInheritedDefaultBehaviorProvider<T> d, Void p) {
@@ -183,9 +178,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Collection<T> visitUndefined(UndefinedDefaultBehaviorProvider<T> d,
Void p) {
@@ -194,7 +187,7 @@
- // Find the default values for the next path/property.
+ /** Find the default values for the next path/property. */
private Collection<T> find(ManagedObjectPath<?, ?> p,
PropertyDefinition<T> pd) throws PropertyException {
nextPath = p;
@@ -217,7 +210,7 @@
- // Get an inherited property value.
+ /** Get an inherited property value. */
@SuppressWarnings("unchecked")
private Collection<T> getInheritedProperty(ManagedObjectPath target,
AbstractManagedObjectDefinition<?, ?> d, String propertyName)
@@ -297,21 +290,19 @@
*/
private class MyDefinitionResolver implements DefinitionResolver {
- // The config entry.
+ /** The config entry. */
private final ConfigEntry entry;
- // Private constructor.
+ /** Private constructor. */
private MyDefinitionResolver(ConfigEntry entry) {
this.entry = entry;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean matches(AbstractManagedObjectDefinition<?, ?> d) {
String oc = LDAPProfile.getInstance().getObjectClass(d);
@@ -348,16 +339,14 @@
- // Prevent instantiation.
+ /** Prevent instantiation. */
private ValueDecoder() {
// No implementation required.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <C extends ConfigurationClient, S extends Configuration>
Object visitAggregation(AggregationPropertyDefinition<C, S> d, String p) {
@@ -374,9 +363,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <T> Object visitUnknown(PropertyDefinition<T> d, String p)
throws PropertyException {
@@ -387,7 +374,7 @@
- // Singleton instance.
+ /** Singleton instance. */
private static final ServerManagementContext INSTANCE =
new ServerManagementContext();
@@ -413,7 +400,7 @@
- // Private constructor.
+ /** Private constructor. */
private ServerManagementContext() {
// No implementation required.
}
@@ -828,7 +815,7 @@
- // Decode helper method required to avoid generics warning.
+ /** Decode helper method required to avoid generics warning. */
private <C extends ConfigurationClient, S extends Configuration>
ServerManagedObject<S> decodeAux(
ManagedObjectPath<? super C, ? super S> path,
@@ -841,7 +828,7 @@
- // Create a property using the provided string values.
+ /** Create a property using the provided string values. */
private <T> SortedSet<T> decodeProperty(ManagedObjectPath<?, ?> path,
PropertyDefinition<T> pd, List<ByteString> values,
ConfigEntry newConfigEntry) throws PropertyException {
@@ -889,7 +876,7 @@
- // Gets the attribute associated with a property from a ConfigEntry.
+ /** Gets the attribute associated with a property from a ConfigEntry. */
private List<ByteString> getAttribute(ManagedObjectDefinition<?, ?> d,
PropertyDefinition<?> pd, ConfigEntry configEntry) {
// TODO: we create a default attribute type if it is
@@ -915,7 +902,7 @@
- // Get the default values for the specified property.
+ /** Get the default values for the specified property. */
private <T> Collection<T> getDefaultValues(ManagedObjectPath<?, ?> p,
PropertyDefinition<T> pd, ConfigEntry newConfigEntry)
throws PropertyException {
@@ -925,8 +912,10 @@
- // Gets a config entry required for a managed object and throws a
- // config exception on failure.
+ /**
+ * Gets a config entry required for a managed object and throws a
+ * config exception on failure.
+ */
private ConfigEntry getManagedObjectConfigEntry(
DN dn) throws ConfigException {
ConfigEntry configEntry;
@@ -952,7 +941,7 @@
- // Validate that a relation definition belongs to the path.
+ /** Validate that a relation definition belongs to the path. */
private void validateRelationDefinition(ManagedObjectPath<?, ?> path,
RelationDefinition<?, ?> rd) throws IllegalArgumentException {
AbstractManagedObjectDefinition<?, ?> d = path.getManagedObjectDefinition();
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/api/CompressedSchema.java b/opendj-server-legacy/src/main/java/org/opends/server/api/CompressedSchema.java
index 2866e88..9b986aa 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/api/CompressedSchema.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/api/CompressedSchema.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2009 Sun Microsystems, Inc.
- * Portions Copyright 2013-2014 ForgeRock AS.
+ * Portions Copyright 2013-2015 ForgeRock AS.
*/
package org.opends.server.api;
@@ -65,16 +65,16 @@
mayInvoke = false)
public class CompressedSchema
{
- // Maps attribute description to ID.
+ /** Maps attribute description to ID. */
private final List<Entry<AttributeType, Set<String>>> adDecodeMap;
- // Maps ID to attribute description.
+ /** Maps ID to attribute description. */
private final Map<Entry<AttributeType, Set<String>>, Integer> adEncodeMap;
- // The map between encoded representations and object class sets.
+ /** The map between encoded representations and object class sets. */
private final List<Map<ObjectClass, String>> ocDecodeMap;
- // The map between object class sets and encoded representations.
+ /** The map between object class sets and encoded representations. */
private final Map<Map<ObjectClass, String>, Integer> ocEncodeMap;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/api/DirectoryThread.java b/opendj-server-legacy/src/main/java/org/opends/server/api/DirectoryThread.java
index 48d2b38..bc3f66a 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/api/DirectoryThread.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/api/DirectoryThread.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2006-2010 Sun Microsystems, Inc.
- * Portions Copyright 2013-2014 ForgeRock AS
+ * Portions Copyright 2013-2015 ForgeRock AS
*/
package org.opends.server.api;
@@ -146,9 +146,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Thread newThread(Runnable r)
{
@@ -199,25 +197,19 @@
ALERT_DESCRIPTION_UNCAUGHT_EXCEPTION);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public DN getComponentEntryDN() {
return DN.NULL_DN;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getClassName() {
return DirectoryThread.class.getName();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Map<String, String> getAlerts() {
return alerts;
@@ -282,7 +274,7 @@
/**
- * private method used to factorize constructor initialization.
+ * Private method used to factorize constructor initialization.
*/
private void init()
{
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/api/EntryCache.java b/opendj-server-legacy/src/main/java/org/opends/server/api/EntryCache.java
index 9ba43e4..65d926b 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/api/EntryCache.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/api/EntryCache.java
@@ -79,13 +79,17 @@
{
private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
- // The set of filters that define the entries that should be
- // excluded from the cache.
+ /**
+ * The set of filters that define the entries that should be
+ * excluded from the cache.
+ */
private Set<SearchFilter> excludeFilters =
new HashSet<SearchFilter>(0);
- // The set of filters that define the entries that should be
- // included in the cache.
+ /**
+ * The set of filters that define the entries that should be
+ * included in the cache.
+ */
private Set<SearchFilter> includeFilters =
new HashSet<SearchFilter>(0);
@@ -99,7 +103,7 @@
*/
protected AtomicLong cacheMisses = new AtomicLong(0);
- // The monitor associated with this entry cache.
+ /** The monitor associated with this entry cache. */
private EntryCacheMonitorProvider entryCacheMonitor;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/api/MonitorProvider.java b/opendj-server-legacy/src/main/java/org/opends/server/api/MonitorProvider.java
index a1ce5e7..a048f83 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/api/MonitorProvider.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/api/MonitorProvider.java
@@ -22,18 +22,17 @@
*
*
* Copyright 2006-2010 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.api;
-import org.forgerock.i18n.LocalizableMessage;
-
import java.util.List;
import java.util.concurrent.*;
-import org.opends.server.admin.std.server.MonitorProviderCfg;
+import org.forgerock.i18n.LocalizableMessage;
import org.forgerock.opendj.config.server.ConfigException;
+import org.opends.server.admin.std.server.MonitorProviderCfg;
import org.opends.server.types.Attribute;
import org.opends.server.types.DirectoryConfig;
import org.opends.server.types.InitializationException;
@@ -41,8 +40,6 @@
import static org.opends.server.util.ServerConstants.*;
-
-
/**
* This class defines the set of methods and structures that must be
* implemented by a Directory Server module that can provide usage,
@@ -59,7 +56,7 @@
mayInvoke=false)
public abstract class MonitorProvider<T extends MonitorProviderCfg>
{
- // The scheduler.
+ /** The scheduler. */
private static final ScheduledExecutorService SCHEDULER =
Executors.newSingleThreadScheduledExecutor(
new MonitorThreadFactory());
@@ -71,9 +68,7 @@
ThreadFactory
{
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Thread newThread(Runnable r)
{
Thread t =
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/api/plugin/DirectoryServerPlugin.java b/opendj-server-legacy/src/main/java/org/opends/server/api/plugin/DirectoryServerPlugin.java
index 9167177..500f474 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/api/plugin/DirectoryServerPlugin.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/api/plugin/DirectoryServerPlugin.java
@@ -22,13 +22,12 @@
*
*
* Copyright 2006-2010 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.api.plugin;
+
import org.forgerock.i18n.LocalizableMessage;
-
-
import java.util.List;
import java.util.Set;
@@ -59,14 +58,13 @@
public abstract class DirectoryServerPlugin
<T extends PluginCfg>
{
- // Indicates whether this plugin should be invoked for internal
- // operations.
+ /** Indicates whether this plugin should be invoked for internal operations. */
private boolean invokeForInternalOps;
- // The DN of the configuration entry for this plugin.
+ /** The DN of the configuration entry for this plugin. */
private DN pluginDN;
- // The plugin types for which this plugin is registered.
+ /** The plugin types for which this plugin is registered. */
private Set<PluginType> pluginTypes;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/api/plugin/InternalDirectoryServerPlugin.java b/opendj-server-legacy/src/main/java/org/opends/server/api/plugin/InternalDirectoryServerPlugin.java
index be4144c..7bd10c8 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/api/plugin/InternalDirectoryServerPlugin.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/api/plugin/InternalDirectoryServerPlugin.java
@@ -22,13 +22,10 @@
*
*
* Copyright 2009 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
-
package org.opends.server.api.plugin;
-
-
import java.util.List;
import java.util.Set;
@@ -38,8 +35,6 @@
import org.opends.server.types.DN;
import org.opends.server.types.InitializationException;
-
-
/**
* An internal directory server plugin which can be registered with
* the server without requiring any associated configuration.
@@ -71,9 +66,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final void initializePlugin(Set<PluginType> pluginTypes,
PluginCfg configuration) throws ConfigException,
InitializationException
@@ -83,9 +76,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public final boolean isConfigurationAcceptable(
PluginCfg configuration, List<LocalizableMessage> unacceptableReasons)
{
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/api/plugin/PluginResult.java b/opendj-server-legacy/src/main/java/org/opends/server/api/plugin/PluginResult.java
index 710d3c7..585dec3 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/api/plugin/PluginResult.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/api/plugin/PluginResult.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2006-2010 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.api.plugin;
@@ -50,13 +50,13 @@
*/
public static final class Startup
{
- // Whether to continue startup.
+ /** Whether to continue startup. */
private final boolean continueProcessing;
- // Whether to invoke the rest of the plugins.
+ /** Whether to invoke the rest of the plugins. */
private final boolean continuePluginProcessing;
- // An message explaining why startup should stop.
+ /** An message explaining why startup should stop. */
private final LocalizableMessage errorMessage;
private static Startup DEFAULT_RESULT =
@@ -158,22 +158,22 @@
*/
public static final class PreParse
{
- // Whether to continue operation processing.
+ /** Whether to continue operation processing. */
private final boolean continueProcessing;
- // Whether to invoke the rest of the plugins.
+ /** Whether to invoke the rest of the plugins. */
private final boolean continuePluginProcessing;
- // An message explaining why processing should stop.
+ /** An message explaining why processing should stop. */
private final LocalizableMessage errorMessage;
- // The matched DN for this result.
+ /** The matched DN for this result. */
private final DN matchedDN;
- // The set of referral URLs for this result.
+ /** The set of referral URLs for this result. */
private final List<String> referralURLs;
- // The result code for this result.
+ /** The result code for this result. */
private final ResultCode resultCode;
private static PreParse DEFAULT_RESULT =
@@ -344,22 +344,22 @@
*/
public static final class PreOperation
{
- // Whether to continue operation processing.
+ /** Whether to continue operation processing. */
private final boolean continueProcessing;
- // Whether to invoke the rest of the plugins.
+ /** Whether to invoke the rest of the plugins. */
private final boolean continuePluginProcessing;
- // An message explaining why processing should stop.
+ /** An message explaining why processing should stop. */
private final LocalizableMessage errorMessage;
- // The matched DN for this result.
+ /** The matched DN for this result. */
private final DN matchedDN;
- // The set of referral URLs for this result.
+ /** The set of referral URLs for this result. */
private final List<String> referralURLs;
- // The result code for this result.
+ /** The result code for this result. */
private final ResultCode resultCode;
private static PreOperation DEFAULT_RESULT =
@@ -529,19 +529,19 @@
*/
public static final class PostOperation
{
- // Whether to continue operation processing.
+ /** Whether to continue operation processing. */
private final boolean continueProcessing;
- // An message explaining why processing should stop.
+ /** An message explaining why processing should stop. */
private final LocalizableMessage errorMessage;
- // The matched DN for this result.
+ /** The matched DN for this result. */
private final DN matchedDN;
- // The set of referral URLs for this result.
+ /** The set of referral URLs for this result. */
private final List<String> referralURLs;
- // The result code for this result.
+ /** The result code for this result. */
private final ResultCode resultCode;
private static PostOperation DEFAULT_RESULT =
@@ -682,7 +682,7 @@
*/
public static final class PostResponse
{
- // Whether to invoke the rest of the plugins.
+ /** Whether to invoke the rest of the plugins. */
private final boolean continuePluginProcessing;
private static PostResponse DEFAULT_RESULT =
@@ -741,13 +741,13 @@
*/
public static final class ImportLDIF
{
- // Whether to continue operation processing.
+ /** Whether to continue operation processing. */
private final boolean continueProcessing;
- // Whether to invoke the rest of the plugins.
+ /** Whether to invoke the rest of the plugins. */
private final boolean continuePluginProcessing;
- // An message explaining why processing should stop.
+ /** An message explaining why processing should stop. */
private final LocalizableMessage errorMessage;
private static ImportLDIF DEFAULT_RESULT =
@@ -850,22 +850,22 @@
*/
public static final class SubordinateModifyDN
{
- // Whether to continue operation processing.
+ /** Whether to continue operation processing. */
private final boolean continueProcessing;
- // Whether to invoke the rest of the plugins.
+ /** Whether to invoke the rest of the plugins. */
private final boolean continuePluginProcessing;
- // An message explaining why processing should stop.
+ /** An message explaining why processing should stop. */
private final LocalizableMessage errorMessage;
- // The matched DN for this result.
+ /** The matched DN for this result. */
private final DN matchedDN;
- // The set of referral URLs for this result.
+ /** The set of referral URLs for this result. */
private final List<String> referralURLs;
- // The result code for this result.
+ /** The result code for this result. */
private final ResultCode resultCode;
private static SubordinateModifyDN DEFAULT_RESULT =
@@ -1042,22 +1042,22 @@
*/
public static final class SubordinateDelete
{
- // Whether to continue operation processing.
+ /** Whether to continue operation processing. */
private final boolean continueProcessing;
- // Whether to invoke the rest of the plugins.
+ /** Whether to invoke the rest of the plugins. */
private final boolean continuePluginProcessing;
- // An message explaining why processing should stop.
+ /** An message explaining why processing should stop. */
private final LocalizableMessage errorMessage;
- // The matched DN for this result.
+ /** The matched DN for this result. */
private final DN matchedDN;
- // The set of referral URLs for this result.
+ /** The set of referral URLs for this result. */
private final List<String> referralURLs;
- // The result code for this result.
+ /** The result code for this result. */
private final ResultCode resultCode;
private static SubordinateDelete DEFAULT_RESULT =
@@ -1234,25 +1234,25 @@
*/
public static final class IntermediateResponse
{
- // Whether to continue operation processing.
+ /** Whether to continue operation processing. */
private final boolean continueProcessing;
- // Whether to invoke the rest of the plugins.
+ /** Whether to invoke the rest of the plugins. */
private final boolean continuePluginProcessing;
- // Whether to send the intermediate response to the client.
+ /** Whether to send the intermediate response to the client. */
private final boolean sendResponse;
- // An message explaining why processing should stop.
+ /** An message explaining why processing should stop. */
private final LocalizableMessage errorMessage;
- // The matched DN for this result.
+ /** The matched DN for this result. */
private final DN matchedDN;
- // The set of referral URLs for this result.
+ /** The set of referral URLs for this result. */
private final List<String> referralURLs;
- // The result code for this result.
+ /** The result code for this result. */
private final ResultCode resultCode;
private static IntermediateResponse DEFAULT_RESULT =
@@ -1464,20 +1464,19 @@
*/
public static final class PostConnect
{
- // Whether to continue connection processing.
+ /** Whether to continue connection processing. */
private final boolean continueProcessing;
- // Whether to invoke the rest of the plugins.
+ /** Whether to invoke the rest of the plugins. */
private final boolean continuePluginProcessing;
- // An message explaining why processing should stop.
+ /** An message explaining why processing should stop. */
private final LocalizableMessage errorMessage;
- // The disconnect reason that provides the generic cause for the
- // disconnect.
+ /** The disconnect reason that provides the generic cause for the disconnect. */
private final DisconnectReason disconnectReason;
- // Whether to send a disconnect notification to the client.
+ /** Whether to send a disconnect notification to the client. */
private final boolean sendDisconnectNotification;
private static PostConnect DEFAULT_RESULT =
@@ -1615,7 +1614,7 @@
*/
public static final class PostDisconnect
{
- // Whether to invoke the rest of the plugins.
+ /** Whether to invoke the rest of the plugins. */
private final boolean continuePluginProcessing;
private static PostDisconnect DEFAULT_RESULT =
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/api/plugin/PluginType.java b/opendj-server-legacy/src/main/java/org/opends/server/api/plugin/PluginType.java
index 3a16080..d07ac45 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/api/plugin/PluginType.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/api/plugin/PluginType.java
@@ -22,17 +22,14 @@
*
*
* Copyright 2006-2010 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
package org.opends.server.api.plugin;
-
-
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
-
-
/**
* This class defines an enumeration containing the types of plugins
* that are supported for use in the Directory Server.
@@ -473,8 +470,10 @@
- // A hash map that relates the plugin type names to the
- // corresponding plugin type.
+ /**
+ * A hash map that relates the plugin type names to the
+ * corresponding plugin type.
+ */
private static final Map<String, PluginType> PLUGIN_TYPE_MAP;
static
{
@@ -488,7 +487,7 @@
- // The name for this plugin type.
+ /** The name for this plugin type. */
private String name;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/AciContainer.java b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/AciContainer.java
index b9f2180..47c8145 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/AciContainer.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/AciContainer.java
@@ -336,17 +336,13 @@
this.seenEntry=val;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isProxiedAuthorization() {
return this.proxiedAuthorization;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isGetEffectiveRightsEval() {
return this.isGetEffectiveRightsEval;
@@ -392,25 +388,19 @@
return this.specificAttrs;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void addTargAttrFiltersMatchAci(Aci aci) {
this.targAttrFilterAcis.put(aci, aci);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean hasTargAttrFiltersMatchAci(Aci aci) {
return this.targAttrFilterAcis.containsKey(aci);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isTargAttrFilterMatchAciEmpty() {
return this.targAttrFilterAcis.isEmpty();
@@ -431,41 +421,31 @@
this.targAttrMatch=0;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void setTargAttrFiltersAciName(String name) {
this.targAttrFiltersAciName=name;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getTargAttrFiltersAciName() {
return this.targAttrFiltersAciName;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void setTargAttrFiltersMatchOp(int flag) {
this.targAttrMatch |= flag;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean hasTargAttrFiltersMatchOp(int flag) {
return (this.targAttrMatch & flag) != 0;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getDecidingAciName() {
if(this.decidingAci != null)
@@ -481,26 +461,20 @@
this.decidingAci = decidingAci;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public EnumEvalReason getEvalReason() {
return this.evalReason;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void setEvalSummary(String summary) {
this.summaryString=summary;
}
- /**
- * {@inheritDoc}
- */
- @Override
+ /** {@inheritDoc} */
+ @Override
public String getEvalSummary() {
return this.summaryString;
}
@@ -530,138 +504,104 @@
authorizationEntry=saveAuthorizationEntry;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void setDenyList(List<Aci> denys) {
denyList=denys;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void setAllowList(List<Aci> allows) {
allowList=allows;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public AttributeType getCurrentAttributeType() {
return attributeType;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ByteString getCurrentAttributeValue() {
return attributeValue;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void setCurrentAttributeType(AttributeType type) {
attributeType=type;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void setCurrentAttributeValue(ByteString value) {
attributeValue=value;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isFirstAttribute() {
return isFirst;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void setIsFirstAttribute(boolean val) {
isFirst=val;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean hasEntryTestRule() {
return isEntryTestRule;
}
- /**
- * {@inheritDoc}
- */
- @Override
- public void setEntryTestRule(boolean val) {
+ /** {@inheritDoc} */
+ @Override
+ public void setEntryTestRule(boolean val) {
isEntryTestRule=val;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Entry getResourceEntry() {
return resourceEntry;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Entry getClientEntry() {
return this.authorizationEntry;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public List<Aci> getDenyList() {
return denyList;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public List<Aci> getAllowList() {
return allowList;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isDenyEval() {
return EnumEvalReason.NO_ALLOW_ACIS.equals(evalReason)
|| EnumEvalReason.EVALUATED_DENY_ACI.equals(evalReason);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isAnonymousUser() {
return !authInfo.isAuthenticated();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public DN getClientDN() {
if(this.useAuthzid)
@@ -671,9 +611,7 @@
return DN.rootDN();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public DN getResourceDN() {
return resourceEntry.getName();
@@ -691,73 +629,55 @@
return (this.rightsMask & rights) != 0;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int getRights() {
return this.rightsMask;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void setRights(int rights) {
this.rightsMask=rights;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getHostName() {
return clientConnection.getRemoteAddress().getCanonicalHostName();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public InetAddress getRemoteAddress() {
return clientConnection.getRemoteAddress();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isAddOperation() {
return operation instanceof AddOperation;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void setTargAttrFiltersMatch(boolean v) {
this.targAttrFiltersMatch=v;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean getTargAttrFiltersMatch() {
return targAttrFiltersMatch;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getControlOID() {
return controlOID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getExtOpOID() {
return extOpOID;
@@ -782,24 +702,20 @@
this.extOpOID=oid;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public EnumEvalResult hasAuthenticationMethod(EnumAuthMethod authMethod,
String saslMech) {
EnumEvalResult matched=EnumEvalResult.FALSE;
if(authMethod==EnumAuthMethod.AUTHMETHOD_NONE) {
- /**
+ /*
* None actually means any, in that we don't care what method was used.
* This doesn't seem very intuitive or useful, but that's the way it is.
*/
matched = EnumEvalResult.TRUE;
} else {
- /*
- * Some kind of authentication is required.
- */
+ // Some kind of authentication is required.
if(authInfo.isAuthenticated()) {
if(authMethod==EnumAuthMethod.AUTHMETHOD_SIMPLE) {
if(authInfo.hasAuthenticationType(AuthenticationType.SIMPLE)) {
@@ -835,9 +751,7 @@
return matched;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isMemberOf(Group<?> group) {
try {
@@ -887,9 +801,7 @@
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void setEvalUserAttributes(int v) {
if(operation instanceof SearchOperation && (rightsMask == ACI_READ)) {
@@ -901,9 +813,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void setEvalOpAttributes(int v) {
if(operation instanceof SearchOperation && (rightsMask == ACI_READ)) {
@@ -915,17 +825,13 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean hasEvalUserAttributes() {
return hasAttribute(ACI_FOUND_USER_ATTR_RULE);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean hasEvalOpAttributes() {
return hasAttribute(ACI_FOUND_OP_ATTR_RULE);
@@ -956,9 +862,7 @@
return (evalAllAttributes & aciAttribute) == aciAttribute;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void clearEvalAttributes(int v) {
if(v == 0)
@@ -967,9 +871,7 @@
evalAllAttributes &= ~v;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int getCurrentSSF() {
return clientConnection.getSSF();
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/AciListenerManager.java b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/AciListenerManager.java
index 54df734..f50e4a9 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/AciListenerManager.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/AciListenerManager.java
@@ -93,9 +93,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void doPostSynchronization(
PostSynchronizationAddOperation addOperation)
@@ -109,9 +107,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void doPostSynchronization(
PostSynchronizationDeleteOperation deleteOperation)
@@ -125,9 +121,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void doPostSynchronization(
PostSynchronizationModifyDNOperation modifyDNOperation)
@@ -141,9 +135,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void doPostSynchronization(
PostSynchronizationModifyOperation modifyOperation)
@@ -158,9 +150,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public PostOperation doPostOperation(
PostOperationAddOperation addOperation)
@@ -178,9 +168,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public PostOperation doPostOperation(
PostOperationDeleteOperation deleteOperation)
@@ -198,9 +186,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public PostOperation doPostOperation(
PostOperationModifyDNOperation modifyDNOperation)
@@ -219,9 +205,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public PostOperation doPostOperation(
PostOperationModifyOperation modifyOperation)
@@ -314,33 +298,25 @@
- /*
- * The configuration DN.
- */
+ /** The configuration DN. */
private DN configurationDN;
- /*
- * True if the server is in lockdown mode.
- */
+ /** True if the server is in lockdown mode. */
private boolean inLockDownMode;
- /*
- * The AciList caches the ACIs.
- */
+ /** The AciList caches the ACIs. */
private AciList aciList;
- /*
- * Search filter used in context search for "aci" attribute types.
- */
+ /** Search filter used in context search for "aci" attribute types. */
private static SearchFilter aciFilter;
- /*
+ /**
* Internal plugin used for updating the cache before a response is
* sent to the client.
*/
private final AciChangeListenerPlugin plugin;
- /*
+ /**
* The aci attribute type is operational so we need to specify it to
* be returned.
*/
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/AciTargets.java b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/AciTargets.java
index f20f855..001e366 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/AciTargets.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/AciTargets.java
@@ -592,7 +592,7 @@
return false;
break;
case SINGLE_LEVEL:
- /**
+ /*
* We use the standard definition of single level to mean the
* immediate children only -- not the target entry itself.
* Sun CR 6535035 has been raised on DSEE:
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumAccessType.java b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumAccessType.java
index 8abab28..1949056 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumAccessType.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumAccessType.java
@@ -22,28 +22,21 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
-
package org.opends.server.authorization.dseecompat;
/**
- * This class provides an enumeration of the two access
- * types (allow, deny).
+ * This class provides an enumeration of the two access types (allow, deny).
*/
public enum EnumAccessType {
- /**
- * Allow access type.
- */
+ /** Allow access type. */
ALLOW ("allow"),
- /**
- * Deny access type.
- */
+ /** Deny access type. */
DENY ("deny");
- /*
- * The access type string.
- */
+ /** The access type string. */
private final String accessType;
/**
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumAuthMethod.java b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumAuthMethod.java
index ef612e1..768e221 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumAuthMethod.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumAuthMethod.java
@@ -22,8 +22,8 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
-
package org.opends.server.authorization.dseecompat;
/**
@@ -55,17 +55,11 @@
*/
AUTHMETHOD_SASL ("sasl");
- /*
- * The name of the authmethod.
- */
- private String authmethod = null;
-
/**
* Creates a new enumeration type for this authmethod.
* @param authmethod The authemethod name.
*/
EnumAuthMethod (String authmethod){
- this.authmethod = authmethod;
}
}
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumBindRuleKeyword.java b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumBindRuleKeyword.java
index b488aa1..406c31d 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumBindRuleKeyword.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumBindRuleKeyword.java
@@ -22,6 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
package org.opends.server.authorization.dseecompat;
@@ -77,15 +78,10 @@
* authmethod.
*/
AUTHMETHOD ("authmethod"),
- /**
- * The enumeration type when the bind rule has specified keyword of
- * ssf.
- */
+ /** The enumeration type when the bind rule has specified keyword of ssf. */
SSF("ssf");
- /*
- * The keyword name.
- */
+ /** The keyword name. */
private final String keyword;
/**
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumBooleanTypes.java b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumBooleanTypes.java
index f3d6e13..96155f3 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumBooleanTypes.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumBooleanTypes.java
@@ -22,12 +22,12 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
-
package org.opends.server.authorization.dseecompat;
/**
- * This class provides an enumeration of the allowed bind rule booelan types.
+ * This class provides an enumeration of the allowed bind rule boolean types.
*/
public enum EnumBooleanTypes {
@@ -47,9 +47,7 @@
*/
NOT_BOOLEAN_TYPE ("not");
- /*
- * The bind rule boolean type name.
- */
+ /** The bind rule boolean type name. */
private final String booleanType;
/**
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumDayOfWeek.java b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumDayOfWeek.java
index 3036ba8..42e228d 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumDayOfWeek.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumDayOfWeek.java
@@ -22,8 +22,8 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
-
package org.opends.server.authorization.dseecompat;
import java.util.Calendar;
@@ -69,9 +69,7 @@
*/
DAY_SUNDAY ("sun");
- /*
- * The bind rule dayofweek type name.
- */
+ /** The bind rule dayofweek type name. */
private String day = null;
/**
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumTargetKeyword.java b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumTargetKeyword.java
index c018c53..045f056 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumTargetKeyword.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumTargetKeyword.java
@@ -22,6 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
package org.opends.server.authorization.dseecompat;
@@ -67,9 +68,7 @@
*/
KEYWORD_EXTOP ("extop");
- /*
- * The target keyword name.
- */
+ /** The target keyword name. */
private final String keyword;
/**
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumTargetOperator.java b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumTargetOperator.java
index 9eeec66..167c4c6 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumTargetOperator.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/EnumTargetOperator.java
@@ -22,6 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
package org.opends.server.authorization.dseecompat;
@@ -40,9 +41,7 @@
*/
NOT_EQUALITY ("!=");
- /*
- * The target operator name.
- */
+ /** The target operator name. */
private final String operator;
/**
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/ParentInheritance.java b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/ParentInheritance.java
index d66f863..47ea1c8 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/ParentInheritance.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/ParentInheritance.java
@@ -47,34 +47,28 @@
*/
public class ParentInheritance {
- /*
- * The maximum number of parent inheritance levels supported.
- */
+ /** The maximum number of parent inheritance levels supported. */
private static final int MAX_LEVELS=10;
- /*
- * Pattern to match for parent inheritance.
- */
+ /** Pattern to match for parent inheritance. */
private final String parentPat="parent[";
- /*
+ /**
* Array used to hold the level information. Each slot corresponds to a
* level parsed from the rule.
*/
private final int[] levels=new int[MAX_LEVELS];
- /*
- * The number of levels parsed.
- */
+ /** The number of levels parsed. */
private int numLevels;
- /*
+ /**
* The attribute type string parsed from the rule. Only used in
* inheritance search.
*/
private String attrTypeStr;
- /*
+ /**
* The base DN of a URL parsed from the rule. Used to make sure groupdn
* are under this suffix. Originally a way to search all nested groups
* under this suffix, so the behavior is slightly different.
@@ -126,14 +120,12 @@
*/
private void parse (String pattern) throws AciException {
pattern=pattern.trim();
- /**
- * Check if we have a "parent[" string.
- */
+ // Check if we have a "parent[" string.
if(pattern.startsWith(parentPat)) {
numLevels=0;
levels[0]=0;
String p=pattern.substring(parentPat.length());
- /**
+ /*
* Format needs to be parent[XX].attribute -- everything after the
* '.' is the attribute type.
*/
@@ -156,7 +148,7 @@
StringTokenizer tok=new StringTokenizer(toks[0],"],",false);
while(tok.hasMoreTokens()) {
String v=tok.nextToken();
- /**
+ /*
* Everything between the brackets must be an integer or it's
* an error.
*/
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/PatternIP.java b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/PatternIP.java
index 37420a4..492c28c 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/PatternIP.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/PatternIP.java
@@ -51,24 +51,18 @@
IPv4, IPv6
}
- /*
- The IP address type (v6 or v4).
- */
+ /** The IP address type (v6 or v4). */
private IPType ipType;
- /*
- IPv4 sizes of addresses and prefixes.
- */
+ /** IPv4 sizes of addresses and prefixes. */
private static int IN4ADDRSZ = 4;
private static int IPV4MAXPREFIX = 32;
- /*
- IPv6 sizes of addresses and prefixes.
- */
+ /** IPv6 sizes of addresses and prefixes. */
private static int IN6ADDRSZ = 16;
private static int IPV6MAXPREFIX = 128;
- /*
+ /**
Byte arrays used to match the remote IP address. The ruleAddrByte array
contains the bytes of the address from the ACI IP bind rule. The
rulePrefixBytes array contains the bytes of the cidr prefix or netmask
@@ -76,20 +70,18 @@
*/
private byte[] ruleAddrBytes, rulePrefixBytes;
- /*
+ /**
Bit set that holds the wild-card information of processed IPv4 addresses.
*/
private BitSet wildCardBitSet;
- /*
+ /**
Hash map of valid netmask strings. Used in parsing netmask values.
*/
private static HashMap<String,String> validNetMasks =
new HashMap<String, String>();
- /*
- Initialize valid netmask hash map.
- */
+ /** Initialize valid netmask hash map. */
static {
initNetMask(
"255.255.255.255",
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/TargAttrFilters.java b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/TargAttrFilters.java
index ab5070e..f2ac22a 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/TargAttrFilters.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/TargAttrFilters.java
@@ -165,7 +165,7 @@
firstOp + ZERO_OR_MORE_WHITESPACE + EQUAL_SIGN +
ZERO_OR_MORE_WHITESPACE;
String[] temp=subExpression.split(opPattern);
- /**
+ /*
* Check that the initial list operation is not equal to the second.
* For example: Matcher find
*
@@ -178,7 +178,7 @@
get(expression);
throw new AciException(message);
}
- /**
+ /*
* Check that there are not too many filter lists. There can only
* be either one or two.
*/
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/TargetFilter.java b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/TargetFilter.java
index 3fed4f5..ccdcaca 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/TargetFilter.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/TargetFilter.java
@@ -22,9 +22,8 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
-
package org.opends.server.authorization.dseecompat;
import org.forgerock.i18n.LocalizableMessage;
@@ -35,21 +34,16 @@
/**
* This class represents a targetfilter keyword of an aci.
- *
*/
public class TargetFilter {
- /*
- * Enumeration representing the targetfilter operation.
- */
+ /** Enumeration representing the targetfilter operation. */
private EnumTargetOperator op = EnumTargetOperator.EQUALITY;
- /*
- * Filter parsed from the ACI used to match the resource entry.
- */
+ /** Filter parsed from the ACI used to match the resource entry. */
private SearchFilter filter;
- /*
+ /**
* Class representing a targetfilter keyword.
* @param op The operation of the targetfilter expression (=, !=)
* @param filter The filter itself.
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/UserDNTypeURL.java b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/UserDNTypeURL.java
index d556441..96bd256 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/UserDNTypeURL.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/UserDNTypeURL.java
@@ -22,6 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
+ * Portions Copyright 2015 ForgeRock AS.
*/
package org.opends.server.authorization.dseecompat;
@@ -33,14 +34,10 @@
*/
public class UserDNTypeURL {
- /*
- * The DN type of the URL.
- */
+ /** The DN type of the URL. */
private EnumUserDNType dnType;
- /*
- * The URL value. Maybe a dummy value for types such as ANYONE or SELF.
- */
+ /** The URL value. Maybe a dummy value for types such as ANYONE or SELF. */
private LDAPURL url;
/**
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/backends/BackupBackend.java b/opendj-server-legacy/src/main/java/org/opends/server/backends/BackupBackend.java
index 0b07629..2316ed3 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/backends/BackupBackend.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/backends/BackupBackend.java
@@ -100,7 +100,7 @@
/** The 'backup.info' file. */
private final File backupInfo;
- /** The last modify time of the backupInfo file */
+ /** The last modify time of the backupInfo file. */
private long lastModified;
/** The BackupDirectory parsed at lastModified time. */
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/backends/SchemaBackend.java b/opendj-server-legacy/src/main/java/org/opends/server/backends/SchemaBackend.java
index b485b10..328c522 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/backends/SchemaBackend.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/backends/SchemaBackend.java
@@ -2942,7 +2942,7 @@
// Start with an empty schema entry.
Entry schemaEntry = createEmptySchemaEntry();
- /**
+ /*
* Add all of the ldap syntax descriptions to the schema entry. We do
* this only for the real part of the ldapsyntaxes attribute. The real part
* is read and write to/from the schema files.
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/AttributeIndex.java b/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/AttributeIndex.java
index 99fa469..cc8cf62 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/AttributeIndex.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/AttributeIndex.java
@@ -1035,7 +1035,7 @@
{
//Get the Matching Rule OID of the filter.
String matchRuleOID = filter.getMatchingRuleID();
- /**
+ /*
* Use the default equality index in two conditions:
* 1. There is no matching rule provided
* 2. The matching rule specified is actually the default equality.
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/BackendImpl.java b/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/BackendImpl.java
index 7ad5d1c..78807f6 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/BackendImpl.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/BackendImpl.java
@@ -1019,9 +1019,6 @@
return ccr;
}
- /**
- * @param newCfg
- */
private void updateDiskMonitor(DiskSpaceMonitor dm, LocalDBBackendCfg newCfg)
{
dm.setFullThreshold(newCfg.getDiskFullThreshold());
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/ConfigurableEnvironment.java b/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/ConfigurableEnvironment.java
index 73e7f55..8d8e32e 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/ConfigurableEnvironment.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/ConfigurableEnvironment.java
@@ -226,7 +226,7 @@
new HashMap<String, PropertyDefinition>();
- // Pulled from resource/admin/ABBREVIATIONS.xsl. db is mose common.
+ /** Pulled from resource/admin/ABBREVIATIONS.xsl. db is mose common. */
private static final List<String> ABBREVIATIONS = Arrays.asList(new String[]
{"aci", "ip", "ssl", "dn", "rdn", "jmx", "smtp", "http",
"https", "ldap", "ldaps", "ldif", "jdbc", "tcp", "tls",
@@ -234,9 +234,7 @@
"vlv", "uuid", "md5", "sha1", "sha256", "sha384", "sha512",
"tls", "db"});
- /*
- * e.g. db-cache-percent -> DBCachePercent
- */
+ /** E.g. db-cache-percent -> DBCachePercent */
private static String propNametoCamlCase(String hyphenated)
{
String[] components = hyphenated.split("\\-");
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/EntryCachePreloader.java b/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/EntryCachePreloader.java
index aad0676..50d6d4b 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/EntryCachePreloader.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/EntryCachePreloader.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.backends.jeb;
@@ -173,7 +173,7 @@
// Progress report timer task.
Timer timer = new Timer();
TimerTask progressTask = new TimerTask() {
- // Persistent state restore progress report.
+ /** Persistent state restore progress report. */
@Override
public void run() {
if (processedEntries.get() > 0) {
@@ -360,10 +360,10 @@
*/
private class PreloadEntry {
- // Encoded Entry.
+ /** Encoded Entry. */
public byte[] entryBytes;
- // Encoded EntryID.
+ /** Encoded EntryID. */
public byte[] entryIDBytes;
/**
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/EntryContainer.java b/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/EntryContainer.java
index c9dd8f0..f2e4406 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/EntryContainer.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/EntryContainer.java
@@ -744,7 +744,7 @@
if(sortRequest != null && !sortRequest.containsSortKeys()
&& sortRequest.isCritical())
{
- /**
+ /*
If the control's criticality field is true then the server SHOULD do
the following: return unavailableCriticalExtension as a return code
in the searchResultDone message; include the sortKeyResponseControl in
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/Importer.java b/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/Importer.java
index 2edf7b2..1053bed 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/Importer.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/Importer.java
@@ -1355,7 +1355,7 @@
// in the import so we don't want to copy the branch to the
// new entry container.
- /**
+ /*
* Advance the cursor to next entry at the same level in the DIT
* skipping all the entries in this branch. Set the next
* starting value to a value of equal length but slightly
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/IndexInputBuffer.java b/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/IndexInputBuffer.java
index 64f2867..1466cef 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/IndexInputBuffer.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/backends/jeb/IndexInputBuffer.java
@@ -61,7 +61,7 @@
private long offset;
private final ByteBuffer cache;
- // Next fields are the fetched record data
+ /** Next fields are the fetched record data. */
private Integer indexID;
private ByteBuffer keyBuf = ByteBuffer.allocate(128);
private RecordState recordState = RecordState.START;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/backends/persistit/PersistItStorage.java b/opendj-server-legacy/src/main/java/org/opends/server/backends/persistit/PersistItStorage.java
index d736649..3fd98b0 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/backends/persistit/PersistItStorage.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/backends/persistit/PersistItStorage.java
@@ -883,7 +883,7 @@
}
/**
- * Sets files permissions on the backend directory
+ * Sets files permissions on the backend directory.
*
* @param backendDir the directory to setup
* @param curCfg a backend configuration
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/AttributeIndex.java b/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/AttributeIndex.java
index f74cdb3..f1d5eca 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/AttributeIndex.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/AttributeIndex.java
@@ -1033,7 +1033,7 @@
{
//Get the Matching Rule OID of the filter.
String matchRuleOID = filter.getMatchingRuleID();
- /**
+ /*
* Use the default equality index in two conditions:
* 1. There is no matching rule provided
* 2. The matching rule specified is actually the default equality.
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryCachePreloader.java b/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryCachePreloader.java
index a5f286e..f8c426e 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryCachePreloader.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryCachePreloader.java
@@ -128,7 +128,7 @@
// Progress report timer task.
Timer timer = new Timer();
TimerTask progressTask = new TimerTask() {
- // Persistent state restore progress report.
+ /** Persistent state restore progress report. */
@Override
public void run() {
if (processedEntries.get() > 0) {
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryContainer.java b/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryContainer.java
index f9d20a8..9d222e1 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryContainer.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryContainer.java
@@ -3240,7 +3240,7 @@
return sortByGreaterThanOrEqualAssertion(searchOperation, vlvRequest, sortMap);
}
- // FIXME: Might be moved into a util.Longs class
+ /** FIXME: Might be moved into a util.Longs class */
private static final long[] toArray(Collection<? extends Number> collection)
{
checkNotNull(collection, "collection must not be null");
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryIDSet.java b/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryIDSet.java
index c247557..bcd968d 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryIDSet.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryIDSet.java
@@ -52,9 +52,7 @@
private static final long[] EMPTY_LONG_ARRAY = new long[0];
private static final long[] NO_ENTRY_IDS_RANGE = new long[] { 0, 0 };
- /**
- * Interface for EntryIDSet concrete implementations
- */
+ /** Interface for EntryIDSet concrete implementations. */
private interface EntryIDSetImplementor extends Iterable<EntryID>
{
long size();
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/Importer.java b/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/Importer.java
index 2a4d630..804c395 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/Importer.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/Importer.java
@@ -1373,7 +1373,7 @@
// in the import so we don't want to copy the branch to the
// new entry container.
- /**
+ /*
* Advance the cursor to next entry at the same level in the DIT
* skipping all the entries in this branch. Set the next
* starting value to a value of equal length but slightly
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/IndexInputBuffer.java b/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/IndexInputBuffer.java
index 8bcce88..e5ff5be 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/IndexInputBuffer.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/IndexInputBuffer.java
@@ -61,7 +61,7 @@
private long offset;
private final ByteBuffer cache;
- // Next fields are the fetched record data
+ /** Next fields are the fetched record data. */
private Integer indexID;
private final ByteStringBuilder keyBuffer = new ByteStringBuilder(128);
private RecordState recordState = RecordState.START;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/VLVIndex.java b/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/VLVIndex.java
index 1b2b257..3b70711 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/VLVIndex.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/VLVIndex.java
@@ -245,7 +245,7 @@
}
}
- // Matches encoding from SortValuesSet.
+ /** Matches encoding from SortValuesSet. */
private int getEncodedSize(ByteString bytes)
{
return bytes.toInt();
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/backends/task/Task.java b/opendj-server-legacy/src/main/java/org/opends/server/backends/task/Task.java
index c8b6174..ae70be2 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/backends/task/Task.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/backends/task/Task.java
@@ -67,66 +67,74 @@
- // The DN for the task entry.
+ /** The DN for the task entry. */
private DN taskEntryDN;
- // The entry that actually defines this task.
+ /** The entry that actually defines this task. */
private Entry taskEntry;
- // The action to take if one of the dependencies for this task does not
- // complete successfully.
+ /**
+ * The action to take if one of the dependencies for this task does not
+ * complete successfully.
+ */
private FailedDependencyAction failedDependencyAction;
- // The counter used for log messages associated with this task.
+ /** The counter used for log messages associated with this task. */
private int logMessageCounter;
- // The task IDs of other tasks on which this task is dependent.
+ /** The task IDs of other tasks on which this task is dependent. */
private LinkedList<String> dependencyIDs;
- // A set of log messages generated by this task.
- // TODO: convert from String to LocalizableMessage objects.
- // Since these are stored in an entry we would need
- // to adopt some way for writing message to string in such
- // a way that the information could be reparsed from its
- // string value.
+ /**
+ * A set of log messages generated by this task.
+ * TODO: convert from String to LocalizableMessage objects.
+ * Since these are stored in an entry we would need
+ * to adopt some way for writing message to string in such
+ * a way that the information could be reparsed from its
+ * string value.
+ */
private LinkedList<String> logMessages;
- // The set of e-mail addresses of the users to notify when the task is done
- // running, regardless of whether it completes successfully.
+ /**
+ * The set of e-mail addresses of the users to notify when the task is done
+ * running, regardless of whether it completes successfully.
+ */
private LinkedList<String> notifyOnCompletion;
- // The set of e-mail addresses of the users to notify if the task does not
- // complete successfully for some reason.
+ /**
+ * The set of e-mail addresses of the users to notify if the task does not
+ * complete successfully for some reason.
+ */
private LinkedList<String> notifyOnError;
- // The time that processing actually started for this task.
+ /** The time that processing actually started for this task. */
private long actualStartTime;
- // The time that actual processing ended for this task.
+ /** The time that actual processing ended for this task. */
private long completionTime;
- // The time that this task was scheduled to start processing.
+ /** The time that this task was scheduled to start processing. */
private long scheduledStartTime;
- // The operation used to create this task in the server.
+ /** The operation used to create this task in the server. */
private Operation operation;
- // The ID of the recurring task with which this task is associated.
+ /** The ID of the recurring task with which this task is associated. */
private String recurringTaskID;
- // The unique ID assigned to this task.
+ /** The unique ID assigned to this task. */
private String taskID;
- // The task backend with which this task is associated.
+ /** The task backend with which this task is associated. */
private TaskBackend taskBackend;
- // The current state of this task.
+ /** The current state of this task. */
private TaskState taskState;
- // The task state that may be set when the task is interrupted.
+ /** The task state that may be set when the task is interrupted. */
private TaskState taskInterruptState;
- // The scheduler with which this task is associated.
+ /** The scheduler with which this task is associated. */
private TaskScheduler taskScheduler;
/**
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/backends/task/TaskScheduler.java b/opendj-server-legacy/src/main/java/org/opends/server/backends/task/TaskScheduler.java
index a0dd01d..ce3d125 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/backends/task/TaskScheduler.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/backends/task/TaskScheduler.java
@@ -79,52 +79,52 @@
- // Indicates whether the scheduler is currently running.
+ /** Indicates whether the scheduler is currently running. */
private boolean isRunning;
- // Indicates whether a request has been received to stop the scheduler.
+ /** Indicates whether a request has been received to stop the scheduler. */
private boolean stopRequested;
- // The entry that serves as the immediate parent for recurring tasks.
+ /** The entry that serves as the immediate parent for recurring tasks. */
private Entry recurringTaskParentEntry;
- // The entry that serves as the immediate parent for scheduled tasks.
+ /** The entry that serves as the immediate parent for scheduled tasks. */
private Entry scheduledTaskParentEntry;
- // The top-level entry at the root of the task tree.
+ /** The top-level entry at the root of the task tree. */
private Entry taskRootEntry;
- // The set of recurring tasks defined in the server.
+ /** The set of recurring tasks defined in the server. */
private HashMap<String,RecurringTask> recurringTasks;
- // The set of tasks associated with this scheduler.
+ /** The set of tasks associated with this scheduler. */
private HashMap<String,Task> tasks;
- // The set of worker threads that are actively busy processing tasks.
+ /** The set of worker threads that are actively busy processing tasks. */
private HashMap<String,TaskThread> activeThreads;
- // The thread ID for the next task thread to be created;
+ /** The thread ID for the next task thread to be created;. */
private int nextThreadID;
- // The set of worker threads that may be used to process tasks.
+ /** The set of worker threads that may be used to process tasks. */
private LinkedList<TaskThread> idleThreads;
- // The lock used to provide threadsafe access to the scheduler.
+ /** The lock used to provide threadsafe access to the scheduler. */
private final ReentrantLock schedulerLock;
- // The task backend with which this scheduler is associated.
+ /** The task backend with which this scheduler is associated. */
private TaskBackend taskBackend;
- // The thread being used to actually run the scheduler.
+ /** The thread being used to actually run the scheduler. */
private Thread schedulerThread;
- // The set of recently-completed tasks that need to be retained.
+ /** The set of recently-completed tasks that need to be retained. */
private TreeSet<Task> completedTasks;
- // The set of tasks that have been scheduled but not yet arrived.
+ /** The set of tasks that have been scheduled but not yet arrived. */
private TreeSet<Task> pendingTasks;
- // The set of tasks that are currently running.
+ /** The set of tasks that are currently running. */
private TreeSet<Task> runningTasks;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/config/BooleanConfigAttribute.java b/opendj-server-legacy/src/main/java/org/opends/server/config/BooleanConfigAttribute.java
index 67ac6da..ce5a19c 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/config/BooleanConfigAttribute.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/config/BooleanConfigAttribute.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.config;
@@ -60,10 +60,10 @@
public final class BooleanConfigAttribute
extends ConfigAttribute
{
- // The active value for this attribute.
+ /** The active value for this attribute. */
private boolean activeValue;
- // The pending value for this attribute.
+ /** The pending value for this attribute. */
private boolean pendingValue;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/config/ConfigAttribute.java b/opendj-server-legacy/src/main/java/org/opends/server/config/ConfigAttribute.java
index 46d1344..faaf8e2 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/config/ConfigAttribute.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/config/ConfigAttribute.java
@@ -53,32 +53,40 @@
mayInvoke=true)
public abstract class ConfigAttribute
{
- // Indicates whether this configuration attribute has pending changes that
- // will be applied after appropriate administrative action has been performed.
+ /**
+ * Indicates whether this configuration attribute has pending changes that
+ * will be applied after appropriate administrative action has been performed.
+ */
private boolean hasPendingValues;
- // Indicates whether this configuration attribute may have multiple values.
+ /** Indicates whether this configuration attribute may have multiple values. */
private boolean isMultiValued;
- // Indicates whether this configuration attribute is required to have a value.
+ /** Indicates whether this configuration attribute is required to have a value. */
private boolean isRequired;
- // Indicates whether changes to this attribute require administrative action
- // before they will take effect.
+ /**
+ * Indicates whether changes to this attribute require administrative action
+ * before they will take effect.
+ */
private boolean requiresAdminAction;
- // The value or set of values that are currently in effect for this
- // configuration attribute.
+ /**
+ * The value or set of values that are currently in effect for this
+ * configuration attribute.
+ */
private LinkedHashSet<ByteString> activeValues;
- // The value or set of values that will be in effect once the appropriate
- // administrative action has been taken.
+ /**
+ * The value or set of values that will be in effect once the appropriate
+ * administrative action has been taken.
+ */
private LinkedHashSet<ByteString> pendingValues;
- // The description for this configuration attribute.
+ /** The description for this configuration attribute. */
private LocalizableMessage description;
- // The name for this configuration attribute.
+ /** The name for this configuration attribute. */
private String name;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/config/DNConfigAttribute.java b/opendj-server-legacy/src/main/java/org/opends/server/config/DNConfigAttribute.java
index f1bca10..8c90629 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/config/DNConfigAttribute.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/config/DNConfigAttribute.java
@@ -59,10 +59,10 @@
{
private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
- // The set of active values for this attribute.
+ /** The set of active values for this attribute. */
private List<DN> activeValues;
- // The set of pending values for this attribute.
+ /** The set of pending values for this attribute. */
private List<DN> pendingValues;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/config/IntegerConfigAttribute.java b/opendj-server-legacy/src/main/java/org/opends/server/config/IntegerConfigAttribute.java
index d454b17..c3c8de5 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/config/IntegerConfigAttribute.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/config/IntegerConfigAttribute.java
@@ -61,22 +61,22 @@
{
private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
- // The set of active values for this attribute.
+ /** The set of active values for this attribute. */
private List<Long> activeValues;
- // The set of pending values for this attribute.
+ /** The set of pending values for this attribute. */
private List<Long> pendingValues;
- // Indicates whether this attribute will impose a lower bound for its values.
+ /** Indicates whether this attribute will impose a lower bound for its values. */
private boolean hasLowerBound;
- // Indicates whether this attribute will impose an upper bound for its values.
+ /** Indicates whether this attribute will impose an upper bound for its values. */
private boolean hasUpperBound;
- // The lower bound for values of this attribute.
+ /** The lower bound for values of this attribute. */
private long lowerBound;
- // The upper bound for values of this attribute.
+ /** The upper bound for values of this attribute. */
private long upperBound;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/config/IntegerWithUnitConfigAttribute.java b/opendj-server-legacy/src/main/java/org/opends/server/config/IntegerWithUnitConfigAttribute.java
index ea77f46..894be75 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/config/IntegerWithUnitConfigAttribute.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/config/IntegerWithUnitConfigAttribute.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.config;
import org.forgerock.i18n.LocalizableMessage;
@@ -72,39 +72,43 @@
- // Indicates whether this configuration attribute should impose a lower bound
- // for the calculated value.
+ /**
+ * Indicates whether this configuration attribute should impose a lower bound
+ * for the calculated value.
+ */
private boolean hasLowerBound;
- // Indicates whether this configuration attribute should impose an upper bound
- // for the calculated value.
+ /**
+ * Indicates whether this configuration attribute should impose an upper bound
+ * for the calculated value.
+ */
private boolean hasUpperBound;
- // The set of unit names and associated multipliers.
+ /** The set of unit names and associated multipliers. */
private HashMap<String,Double> units;
- // The active calculated value for this attribute.
+ /** The active calculated value for this attribute. */
private long activeCalculatedValue;
- // The active value for this attribute.
+ /** The active value for this attribute. */
private long activeIntValue;
- // The lower bound for the calculated value.
+ /** The lower bound for the calculated value. */
private long lowerBound;
- // The pending calculated value for this attribute.
+ /** The pending calculated value for this attribute. */
private long pendingCalculatedValue;
- // The the pending value for this attribute.
+ /** The the pending value for this attribute. */
private long pendingIntValue;
- // The upper bound for the calculated value.
+ /** The upper bound for the calculated value. */
private long upperBound;
- // The active unit for this attribute.
+ /** The active unit for this attribute. */
private String activeUnit;
- // The pending unit for this attribute.
+ /** The pending unit for this attribute. */
private String pendingUnit;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/config/JMXMBean.java b/opendj-server-legacy/src/main/java/org/opends/server/config/JMXMBean.java
index ac4ac3a..71b8a4f 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/config/JMXMBean.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/config/JMXMBean.java
@@ -463,7 +463,6 @@
public Attribute getAttribute(String attributeName)
throws AttributeNotFoundException
{
- //
// Get the jmx Client connection
ClientConnection clientConnection = getClientConnection();
if (clientConnection == null)
@@ -471,12 +470,10 @@
return null;
}
- //
// prepare the ldap search
try
{
- //
// Perform the Ldap operation for
// - ACI Check
// - Loggin purpose
@@ -543,7 +540,6 @@
@Override
public AttributeList getAttributes(String[] attributes)
{
- //
// Get the jmx Client connection
ClientConnection clientConnection = getClientConnection();
if (clientConnection == null)
@@ -551,7 +547,6 @@
return null;
}
- //
// Perform the Ldap operation for
// - ACI Check
// - Loggin purpose
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/config/MultiChoiceConfigAttribute.java b/opendj-server-legacy/src/main/java/org/opends/server/config/MultiChoiceConfigAttribute.java
index fdb91f6..3471af1 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/config/MultiChoiceConfigAttribute.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/config/MultiChoiceConfigAttribute.java
@@ -60,13 +60,13 @@
{
private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
- // The set of active values for this attribute.
+ /** The set of active values for this attribute. */
private List<String> activeValues;
- // The set of pending values for this attribute.
+ /** The set of pending values for this attribute. */
private List<String> pendingValues;
- // The set of allowed values for this attribute.
+ /** The set of allowed values for this attribute. */
private Set<String> allowedValues;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/config/ReadOnlyConfigAttribute.java b/opendj-server-legacy/src/main/java/org/opends/server/config/ReadOnlyConfigAttribute.java
index e363ed4..1cb23f6 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/config/ReadOnlyConfigAttribute.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/config/ReadOnlyConfigAttribute.java
@@ -22,7 +22,7 @@
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
- * Portions Copyright 2014 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.config;
@@ -54,7 +54,7 @@
public final class ReadOnlyConfigAttribute
extends ConfigAttribute
{
- // The set of values for this attribute.
+ /** The set of values for this attribute. */
private List<String> values;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/config/StringConfigAttribute.java b/opendj-server-legacy/src/main/java/org/opends/server/config/StringConfigAttribute.java
index 9637c27..62f5a55 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/config/StringConfigAttribute.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/config/StringConfigAttribute.java
@@ -59,10 +59,10 @@
{
private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
- // The set of active values for this attribute.
+ /** The set of active values for this attribute. */
private List<String> activeValues;
- // The set of pending values for this attribute.
+ /** The set of pending values for this attribute. */
private List<String> pendingValues;
--
Gitblit v1.10.0