From 661593f15f14aaf55d73c7979dab1e900ebae2af Mon Sep 17 00:00:00 2001
From: Jean-Noel Rouvignac <jean-noel.rouvignac@forgerock.com>
Date: Wed, 15 Oct 2014 15:17:11 +0000
Subject: [PATCH] AutoRefactored comments/javadocs on OpenDJ SDK
---
opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/setup/model/ReplicationConfiguration.java | 4
opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/AggregationServerTest.java | 4
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/UndefinedDefaultBehaviorProvider.java | 4
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/WhoAmIExtendedRequestImpl.java | 4
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/SubtreeDeleteRequestControl.java | 20
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/EntryGeneratorTestCase.java | 8
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/EnumSyntaxImpl.java | 2
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaConstants.java | 2
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DurationPropertyDefinition.java | 71
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/ModificationType.java | 10
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/AuthorizationIdentityResponseControl.java | 24
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordExpiredResponseControl.java | 20
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ServerSideSortResponseControl.java | 20
opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/setup/cli/SetupCli.java | 8
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/UTCTimeSyntaxTest.java | 4
opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/CommonArguments.java | 2
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationGreaterThanMatchingRuleTest.java | 12
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/GetEffectiveRightsRequestControl.java | 25
opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/DurationPropertyDefinitionTest.java | 10
opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/MenuBuilder.java | 76
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/PasswordModifyExtendedResultImpl.java | 2
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/SubentriesRequestControl.java | 20
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/DNBuilder.java | 2
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/SimplePagedResultsControl.java | 20
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DistinguishedNameEqualityMatchingRuleImpl.java | 4
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/TemplateTag.java | 3
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/PropertyValueEditor.java | 4
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/AbstractResponseImpl.java | 2
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/RegexSyntaxTestCase.java | 8
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/Reference.java | 22
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AbsoluteInheritedDefaultBehaviorProvider.java | 18
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/SizeUnit.java | 10
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationLessThanMatchingRuleTest.java | 12
opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/ClassPropertyDefinitionTest.java | 2
opendj-sdk/opendj-server2x-adapter/src/main/java/org/forgerock/opendj/adapter/server2x/Converters.java | 2
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Filter.java | 8
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/EnumSyntaxTestCase.java | 8
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/IPAddressPropertyDefinition.java | 32
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordPolicyWarningType.java | 4
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ManagedObjectDefinitionI18NResource.java | 16
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Attributes.java | 4
opendj-sdk/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/ObjectAttributeMapper.java | 2
opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/core/DataProviderID.java | 28
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyDefinitionUsageBuilder.java | 68
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ProxiedAuthV1RequestControl.java | 20
opendj-sdk/opendj-rest2ldap-servlet/src/main/java/org/forgerock/opendj/rest2ldap/servlet/Rest2LDAPContextFactory.java | 2
opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/Utils.java | 2
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/SingletonRelationDefinition.java | 30
opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/FileBasedArgument.java | 6
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AliasDefaultBehaviorProvider.java | 16
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DurationUnit.java | 10
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractAsynchronousConnection.java | 2
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Functions.java | 2
opendj-sdk/opendj-ldap-sdk-examples/src/main/java/org/forgerock/opendj/examples/GetInfo.java | 4
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DITContentRule.java | 21
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/BooleanPropertyDefinition.java | 28
opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/PasswordPolicyStateOperationType.java | 12
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/DistinguishedNameEqualityMatchingRuleTest.java | 4
opendj-sdk/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/AuthenticatedConnectionContext.java | 4
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/RoundRobinLoadBalancingAlgorithm.java | 8
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/RegexSyntaxImpl.java | 2
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaException.java | 6
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/CertificateExactAssertionSyntaxImpl.java | 16
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ManagedObjectDefinitionResource.java | 12
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/OtherMailboxSyntaxTest.java | 8
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/LDAP.java | 2
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/MockConnectionEventListener.java | 12
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationEqualityMatchingRuleTest.java | 12
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationLessThanOrEqualMatchingRuleTest.java | 12
opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/StaticUtils.java | 2
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordPolicyResponseControl.java | 20
opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/PasswordPolicyStateExtendedRequest.java | 46
opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/MockConstraint.java | 32
opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/MockLDAPProfile.java | 19
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AttributeFilter.java | 3
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/LDAPServer.java | 22
opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/ReferenceCountedObject.java | 2
opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/SubCommand.java | 50
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/CertificateSyntaxImpl.java | 24
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractAttribute.java | 88
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DITStructureRule.java | 14
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/spi/PropertySet.java | 50
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/ChangeRecordVisitorWriter.java | 2
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/LDAPReaderWriterTestCase.java | 4
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/requests/RequestsTestCase.java | 2
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractLoadBalancingAlgorithm.java | 2
opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/GrizzlyUtils.java | 2
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaValidationPolicy.java | 4
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/BitStringEqualityMatchingRuleTest.java | 12
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/StringPropertyDefinition.java | 56
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/TopCfgDefn.java | 2
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/UUIDSyntaxTest.java | 8
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/ContainsCondition.java | 40
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/WhoAmIExtendedResultImpl.java | 4
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/MatchingRuleUse.java | 16
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/MissingMandatoryPropertiesException.java | 16
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/ASN1ByteSequenceReaderTestCase.java | 2
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIFChangeRecordReader.java | 6
opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/controls/RealAttributesOnlyRequestControl.java | 20
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AVA.java | 20
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/LDAPWriter.java | 2
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AbstractManagedObjectDefinition.java | 87
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/AbstractLDIFWriter.java | 4
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AttributeDescription.java | 18
opendj-sdk/opendj-rest2ldap-servlet/src/main/java/org/forgerock/opendj/rest2ldap/servlet/Rest2LDAPConnectionFactoryProvider.java | 2
opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/controls/AccountUsabilityRequestControl.java | 22
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PreReadRequestControl.java | 22
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/NameForm.java | 12
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/GuideSyntaxTest.java | 8
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIF.java | 2
opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/CliConstants.java | 2
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/AbstractLDIFReader.java | 4
opendj-sdk/opendj-ldap-toolkit/src/test/java/com/forgerock/opendj/ldap/tools/MakeLDIFTestCase.java | 2
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/ldap/LDAPManagedObject.java | 34
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/BooleanEqualityMatchingRuleTest.java | 12
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/ConnectionEntryReader.java | 4
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseExactEqualityMatchingRuleTest.java | 12
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/TemplateTagTestcase.java | 8
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/IntegerPropertyDefinition.java | 59
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/AbstractResultImpl.java | 2
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/GeneralizedTime.java | 20
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CoreSchemaTest.java | 2
opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/GetSymmetricKeyExtendedRequest.java | 24
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PersistentSearchChangeType.java | 4
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/AttributeDescriptionTestCase.java | 2
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DefinedDefaultBehaviorProvider.java | 6
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyException.java | 14
opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/SubstringReader.java | 8
opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/MultiChoiceArgument.java | 8
opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/TestParentCfgDefn.java | 206 -
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AttributeTypePropertyDefinition.java | 32
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/SubCommandHandler.java | 40
opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/GetConnectionIDExtendedRequest.java | 30
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseIgnoreIA5EqualityMatchingRuleTest.java | 12
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigAddListenerAdaptor.java | 20
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/AbstractRequestImpl.java | 2
opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/SizeLimitInputStream.java | 32
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/LDIFEntryReaderTestCase.java | 11
opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/Argument.java | 48
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyProvider.java | 4
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObjectDeleteListenerAdaptor.java | 10
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigExceptionFactory.java | 4
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/EqualLengthApproximateMatchingRuleImpl.java | 4
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/ByteSequenceReaderTest.java | 4
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/ASN1InputStreamReader.java | 68
opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/AdminTestCase.java | 4
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIFEntryReader.java | 6
opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/ASN1BufferWriter.java | 48
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Connections.java | 2
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Modification.java | 4
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/SSLContextBuilder.java | 2
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/GetPropSubCommandHandler.java | 18
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/BitStringSyntaxTest.java | 8
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/ArgumentExceptionFactory.java | 2
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ServerSideSortRequestControl.java | 20
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/AttributeParserTestCase.java | 6
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AddressMask.java | 16
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/NameFormTestCase.java | 2
opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/client/ldap/AggregationClientTest.java | 6
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/ManagedObjectDecodingException.java | 6
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/MockScheduler.java | 2
opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/Iterables.java | 12
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/GenericConstraint.java | 38
opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/client/ldap/MockConstraint.java | 26
opendj-sdk/opendj-rest2ldap-servlet/src/main/java/org/forgerock/opendj/rest2ldap/servlet/Rest2LDAPAuthnFilter.java | 2
opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/PasswordPolicyStateExtendedResult.java | 32
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/SetRelationDefinition.java | 34
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/CommonLDAPOptions.java | 2
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationSubstringMatchingRuleTest.java | 16
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/ldap/LDAPDriver.java | 58
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/CachedConnectionPool.java | 4
opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/TableBuilder.java | 20
opendj-sdk/opendj-ldap-toolkit/src/test/java/com/forgerock/opendj/ldap/tools/LDAPSearchITCase.java | 2
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/IsPresentCondition.java | 16
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/AddressMaskTestCase.java | 6
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/AbstractASN1Reader.java | 44
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LDAPOptions.java | 2
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/ORCondition.java | 14
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/MatchingRuleUseSyntaxTest.java | 8
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/RelativeInheritedDefaultBehaviorProvider.java | 14
opendj-sdk/opendj-server/src/test/java/org/forgerock/opendj/server/setup/cli/SetupCliTestCase.java | 4
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/TrustManagers.java | 58
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ProxiedAuthV2RequestControl.java | 22
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaUtils.java | 2
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DITContentRuleSyntaxImpl.java | 4
opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/ValidateConfigDefinitionsTest.java | 12
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ManageDsaITRequestControl.java | 20
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/ObjectClassType.java | 2
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/IPAddressMaskPropertyDefinition.java | 28
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/ASN1OutputStreamWriter.java | 56
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigDeleteListenerAdaptor.java | 20
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PostReadRequestControl.java | 22
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ClassPropertyDefinition.java | 40
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LDAPListener.java | 8
opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/TestChildCfgDefn.java | 151
opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/ConstraintTest.java | 9
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PreReadResponseControl.java | 24
opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/setup/model/RuntimeOptions.java | 12
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/ASN1ByteSequenceReader.java | 68
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/AbstractASN1Writer.java | 48
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/Responses.java | 2
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigChangeResult.java | 18
opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/GetConnectionIDExtendedResult.java | 16
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/ASN1OutputStreamWriterTestCase.java | 2
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/AssertionRequestControl.java | 24
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/ObjectClass.java | 18
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Entries.java | 66
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/RDNTestCase.java | 8
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/FailoverLoadBalancingAlgorithm.java | 8
opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/AttributeTypePropertyDefinitionTest.java | 2
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseExactOrderingMatchingRuleTest.java | 12
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/EnumPropertyDefinition.java | 34
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LinkedAttribute.java | 42
opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/core/AbstractDataProvider.java | 10
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/ResultCode.java | 10
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/LDAPProfile.java | 8
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/Conditions.java | 26
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/CollationMatchingRulesImpl.java | 4
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/GeneralizedTimeSyntaxTest.java | 4
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagementContext.java | 72
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordPolicyRequestControl.java | 20
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/LDAPSyntaxTest.java | 8
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/RelationDefinition.java | 18
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/SubstitutionSyntaxTestCase.java | 8
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DefaultManagedObject.java | 10
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyNotFoundException.java | 2
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/IA5StringSyntaxTest.java | 8
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/StartTLSExtendedRequestImpl.java | 12
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseIgnoreEqualityMatchingRuleTest.java | 12
opendj-sdk/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/Utils.java | 5
opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/EnumPropertyDefinitionTest.java | 20
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/DecodeOptions.java | 4
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/SearchScope.java | 10
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/VirtualListViewRequestControl.java | 20
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DoubleMetaphoneApproximateMatchingRuleImpl.java | 4
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseExactIA5EqualityMatchingRuleTest.java | 12
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/RDN.java | 26
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaElement.java | 12
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/ASN1WriterTestCase.java | 6
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractEntry.java | 2
opendj-sdk/opendj-grizzly/src/test/java/org/forgerock/opendj/grizzly/GrizzlyLDAPConnectionFactoryTestCase.java | 4
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ADNotificationRequestControl.java | 20
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/PasswordModifyExtendedRequestImpl.java | 2
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/ASN1.java | 2
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AdministratorAction.java | 22
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseIgnoreOrderingMatchingRuleTest.java | 12
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordExpiringResponseControl.java | 22
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/ASN1InputStreamReaderTestCase.java | 2
opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/LDAPServerFilter.java | 32
opendj-sdk/opendj-ldap-toolkit/src/test/java/com/forgerock/opendj/ldap/tools/ConnectionFactoryProviderTest.java | 2
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigChangeListenerAdaptor.java | 38
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIFEntryWriter.java | 16
opendj-sdk/opendj-cli/src/test/java/com/forgerock/opendj/cli/TestSubCommandArgumentParserTestCase.java | 4
opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/OperatingSystem.java | 2
opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/TextTablePrinter.java | 46
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DefinitionDecodingException.java | 6
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/LDIFChangeRecordReaderTestCase.java | 25
opendj-sdk/opendj-server/src/test/java/org/forgerock/opendj/server/core/ProductInformationTest.java | 10
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/ldap/DNBuilder.java | 16
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/DelayedConfigAddListener.java | 29
opendj-sdk/opendj-server-example-plugin/src/main/java/com/example/opendj/ExamplePlugin.java | 8
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/RequestHandlerFactoryAdapter.java | 102
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractMapEntry.java | 32
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PersistentSearchRequestControl.java | 34
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObjectDecodingException.java | 6
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordPolicyErrorType.java | 4
opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentConstants.java | 2
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/MatchedValuesRequestControl.java | 20
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DNPropertyDefinition.java | 40
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConstraintViolationException.java | 8
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/spi/Driver.java | 48
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/ByteString.java | 68
opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/LDAPClientFilter.java | 2
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/OperationRejectedException.java | 14
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/AttributeTypeSyntaxTest.java | 8
opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/ListenerTest.java | 4
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/CancelExtendedRequestImpl.java | 4
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/DNTestCase.java | 4
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ManagedObjectPath.java | 142
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyDefinition.java | 22
opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/IntegerArgument.java | 12
opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/LDAPProfileTest.java | 2
opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/TestCfg.java | 6
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/CertificateExactMatchingRuleImpl.java | 4
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIFChangeRecordWriter.java | 35
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LDAPConnectionFactory.java | 4
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/VirtualListViewResponseControl.java | 20
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/ANDCondition.java | 14
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/NOTCondition.java | 14
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/InstantiableRelationDefinition.java | 38
opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/controls/AccountUsabilityResponseControl.java | 50
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PostReadResponseControl.java | 24
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/ChangeRecord.java | 12
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CountryStringSyntaxTest.java | 4
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/ConnectionChangeRecordWriterTestCase.java | 4
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/TelexSyntaxTest.java | 8
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ACIPropertyDefinition.java | 28
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/OptionalRelationDefinition.java | 30
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LDAPUrl.java | 12
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/DITContentRuleSyntaxTest.java | 4
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/EntryChangeNotificationResponseControl.java | 26
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/DN.java | 36
opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/core/DataProviderEvent.java | 4
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PermissiveModifyRequestControl.java | 20
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/KeyManagers.java | 34
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/MatchingRuleSyntaxTest.java | 8
opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentException.java | 2
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/AttributesTestCase.java | 6
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/GenericControl.java | 22
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/GSSAPISASLBindRequestImpl.java | 12
opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentGroup.java | 6
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/DecodeException.java | 2
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/SizePropertyDefinition.java | 59
opendj-sdk/opendj-grizzly/src/test/java/org/forgerock/opendj/grizzly/GrizzlyLDAPListenerTestCase.java | 60
opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/AdminTestCaseUtils.java | 10
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationGreaterThanOrEqualMatchingRuleTest.java | 12
opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/ASN1BufferReader.java | 56
opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/DefaultBehaviorTest.java | 9
opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/ASCIICharProp.java | 16
opendj-sdk/opendj-ldap-toolkit/src/test/java/com/forgerock/opendj/ldap/tools/ToolsITCase.java | 11
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/DigestMD5SASLBindRequestImpl.java | 4
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/TemplateFile.java | 2
opendj-sdk/opendj-rest2ldap/src/test/java/org/forgerock/opendj/rest2ldap/BasicRequestsTest.java | 2
opendj-sdk/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/Context.java | 14
opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/MenuResult.java | 6
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/spi/AbstractManagedObject.java | 162
opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/StringPropertyDefinitionTest.java | 2
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObjectAddListenerAdaptor.java | 10
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/DereferenceAliasesPolicy.java | 10
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/ConditionResult.java | 12
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/InternalConnection.java | 60
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/AttributeUsage.java | 8
opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/MatchingRuleTestCase.java | 2
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ConfigurationFramework.java | 36
opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/client/ldap/LDAPClientTest.java | 10
opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/controls/VirtualAttributesOnlyRequestControl.java | 20
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/AuthorizationIdentityRequestControl.java | 22
opendj-sdk/opendj-core/src/test/java/com/forgerock/opendj/util/StringPrepProfileTestCase.java | 4
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AggregationPropertyDefinition.java | 205 -
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/AttributeType.java | 53
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObjectChangeListenerAdaptor.java | 10
opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObject.java | 49
opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/core/DataProviderStatus.java | 2
343 files changed, 2,354 insertions(+), 4,095 deletions(-)
diff --git a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/Argument.java b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/Argument.java
index 6e3cb89..7868474 100644
--- a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/Argument.java
+++ b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/Argument.java
@@ -41,51 +41,61 @@
* order to provide specific functionality.
*/
public abstract class Argument {
- // Indicates whether this argument should be hidden in the usage
- // information.
+ /**
+ * Indicates whether this argument should be hidden in the usage
+ * information.
+ */
private boolean isHidden;
- // Indicates whether this argument may be specified more than once for
- // multiple values.
+ /**
+ * Indicates whether this argument may be specified more than once for
+ * multiple values.
+ */
private boolean isMultiValued;
- // Indicates whether this argument was provided in the set of
- // command-line arguments.
+ /**
+ * Indicates whether this argument was provided in the set of
+ * command-line arguments.
+ */
private boolean isPresent;
- // Indicates whether this argument is required to have a value.
+ /** Indicates whether this argument is required to have a value. */
private boolean isRequired;
- // Indicates whether this argument requires a value.
+ /** Indicates whether this argument requires a value. */
private boolean needsValue;
- // The single-character identifier for this argument.
+ /** The single-character identifier for this argument. */
private final Character shortIdentifier;
- // The unique ID of the description for this argument.
+ /** The unique ID of the description for this argument. */
private final LocalizableMessage description;
- // The set of values for this argument.
+ /** The set of values for this argument. */
private final LinkedList<String> values;
- // The default value for the argument if none other is provided.
+ /** The default value for the argument if none other is provided. */
private String defaultValue;
- // The long identifier for this argument.
+ /** The long identifier for this argument. */
private final String longIdentifier;
- // The generic name that will be used to refer to this argument.
+ /** The generic name that will be used to refer to this argument. */
private final String name;
- // The name of the property that can be used to set the default value.
+ /** The name of the property that can be used to set the default value. */
private String propertyName;
- // The value placeholder for this argument, which will be used in
- // usage information.
+ /**
+ * The value placeholder for this argument, which will be used in
+ * usage information.
+ */
private LocalizableMessage valuePlaceholder;
- // Indicates whether this argument was provided in the set of
- // properties found is a properties file.
+ /**
+ * Indicates whether this argument was provided in the set of
+ * properties found is a properties file.
+ */
private boolean isValueSetByProperty;
/**
diff --git a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentConstants.java b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentConstants.java
index c131f2e..1518577 100644
--- a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentConstants.java
+++ b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentConstants.java
@@ -721,7 +721,7 @@
*/
public static final String OPTION_LONG_RESTART = "restart";
- // Prevent instantiation.
+ /** Prevent instantiation. */
private ArgumentConstants() {
}
diff --git a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentException.java b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentException.java
index fa14f50..1b20baf 100644
--- a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentException.java
+++ b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentException.java
@@ -35,7 +35,7 @@
*/
@SuppressWarnings("serial")
public final class ArgumentException extends Exception implements LocalizableException {
- // The I18N message associated with this exception.
+ /** The I18N message associated with this exception. */
private final LocalizableMessage message;
/**
diff --git a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentGroup.java b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentGroup.java
index 6a7df74..3c0101b 100644
--- a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentGroup.java
+++ b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentGroup.java
@@ -39,13 +39,13 @@
*/
public final class ArgumentGroup implements Comparable<ArgumentGroup> {
- // Description for this group of arguments
+ /** Description for this group of arguments. */
private LocalizableMessage description = null;
- // List of arguments belonging to this group
+ /** List of arguments belonging to this group. */
private List<Argument> args = null;
- // Governs groups position within usage statement
+ /** Governs groups position within usage statement. */
private final Integer priority;
/**
diff --git a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/CliConstants.java b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/CliConstants.java
index 8dd0db1..e5cc678 100755
--- a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/CliConstants.java
+++ b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/CliConstants.java
@@ -68,7 +68,7 @@
public static final String GLOBAL_ADMIN_UID = "admin";
- // Prevent instantiation.
+ /** Prevent instantiation. */
private CliConstants() {
}
diff --git a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/CommonArguments.java b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/CommonArguments.java
index 97767fd..d199502 100644
--- a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/CommonArguments.java
+++ b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/CommonArguments.java
@@ -37,7 +37,7 @@
*/
public final class CommonArguments {
- // Prevent instantiation.
+ /** Prevent instantiation. */
private CommonArguments() {
// Nothing to do.
}
diff --git a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/FileBasedArgument.java b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/FileBasedArgument.java
index 3bfcaf7..1fd9fe7 100644
--- a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/FileBasedArgument.java
+++ b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/FileBasedArgument.java
@@ -54,8 +54,10 @@
* multiple lines, then only the first line will be read.
*/
public final class FileBasedArgument extends Argument {
- // The mapping between filenames specified and the first lines read
- // from those files.
+ /**
+ * The mapping between filenames specified and the first lines read
+ * from those files.
+ */
private final LinkedHashMap<String, String> namesToValues;
/**
diff --git a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/IntegerArgument.java b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/IntegerArgument.java
index cb57056..90e41a0 100644
--- a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/IntegerArgument.java
+++ b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/IntegerArgument.java
@@ -36,17 +36,19 @@
* potentially only those in a given range.
*/
public final class IntegerArgument extends Argument {
- // Indicates whether a lower bound will be enforced for this argument.
+ /** Indicates whether a lower bound will be enforced for this argument. */
private final boolean hasLowerBound;
- // Indicates whether an upper bound will be enforced for this
- // argument.
+ /**
+ * Indicates whether an upper bound will be enforced for this
+ * argument.
+ */
private final boolean hasUpperBound;
- // The lower bound that will be enforced for this argument.
+ /** The lower bound that will be enforced for this argument. */
private final int lowerBound;
- // The upper bound that will be enforced for this argument.
+ /** The upper bound that will be enforced for this argument. */
private final int upperBound;
/**
diff --git a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/MenuBuilder.java b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/MenuBuilder.java
index 3fd925b..30f834e 100644
--- a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/MenuBuilder.java
+++ b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/MenuBuilder.java
@@ -55,7 +55,7 @@
*/
private static final class CompositeCallback<T> implements MenuCallback<T> {
- // The list of underlying call-backs.
+ /** The list of underlying call-backs. */
private final Collection<MenuCallback<T>> callbacks;
/**
@@ -94,42 +94,46 @@
*/
private static final class MenuImpl<T> implements Menu<T> {
- // Indicates whether the menu will allow selection of multiple
- // numeric options.
+ /**
+ * Indicates whether the menu will allow selection of multiple
+ * numeric options.
+ */
private final boolean allowMultiSelect;
- // The application console.
+ /** The application console. */
private final ConsoleApplication app;
- // The call-back lookup table.
+ /** The call-back lookup table. */
private final Map<String, MenuCallback<T>> callbacks;
- // The char options table builder.
+ /** The char options table builder. */
private final TableBuilder cbuilder;
- // The call-back for the optional default action.
+ /** The call-back for the optional default action. */
private final MenuCallback<T> defaultCallback;
- // The description of the optional default action.
+ /** The description of the optional default action. */
private final LocalizableMessage defaultDescription;
- // The numeric options table builder.
+ /** The numeric options table builder. */
private final TableBuilder nbuilder;
- // The table printer.
+ /** The table printer. */
private final TablePrinter printer;
- // The menu prompt.
+ /** The menu prompt. */
private final LocalizableMessage prompt;
- // The menu title.
+ /** The menu title. */
private final LocalizableMessage title;
- // The maximum number of times we display the menu if the user provides
- // bad input (-1 for unlimited).
+ /**
+ * The maximum number of times we display the menu if the user provides
+ * bad input (-1 for unlimited).
+ */
private int nMaxTries;
- // Private constructor.
+ /** Private constructor. */
private MenuImpl(ConsoleApplication app, LocalizableMessage title, LocalizableMessage prompt,
TableBuilder ntable, TableBuilder ctable, TablePrinter printer, Map<String, MenuCallback<T>> callbacks,
boolean allowMultiSelect, MenuCallback<T> defaultCallback, LocalizableMessage defaultDescription,
@@ -284,10 +288,10 @@
*/
private static final class ResultCallback<T> implements MenuCallback<T> {
- // The result to be returned by this call-back.
+ /** The result to be returned by this call-back. */
private final MenuResult<T> result;
- // Private constructor.
+ /** Private constructor. */
private ResultCallback(MenuResult<T> result) {
this.result = result;
}
@@ -299,51 +303,55 @@
}
- // The multiple column display threshold.
+ /** The multiple column display threshold. */
private int threshold = -1;
- // Indicates whether the menu will allow selection of multiple
- // numeric options.
+ /**
+ * Indicates whether the menu will allow selection of multiple
+ * numeric options.
+ */
private boolean allowMultiSelect = false;
- // The application console.
+ /** The application console. */
private final ConsoleApplication app;
- // The char option call-backs.
+ /** The char option call-backs. */
private final List<MenuCallback<T>> charCallbacks = new ArrayList<MenuCallback<T>>();
- // The char option keys (must be single-character messages).
+ /** The char option keys (must be single-character messages). */
private final List<LocalizableMessage> charKeys = new ArrayList<LocalizableMessage>();
- // The synopsis of char options.
+ /** The synopsis of char options. */
private final List<LocalizableMessage> charSynopsis = new ArrayList<LocalizableMessage>();
- // Optional column headings.
+ /** Optional column headings. */
private final List<LocalizableMessage> columnHeadings = new ArrayList<LocalizableMessage>();
- // Optional column widths.
+ /** Optional column widths. */
private final List<Integer> columnWidths = new ArrayList<Integer>();
- // The call-back for the optional default action.
+ /** The call-back for the optional default action. */
private MenuCallback<T> defaultCallback = null;
- // The description of the optional default action.
+ /** The description of the optional default action. */
private LocalizableMessage defaultDescription = null;
- // The numeric option call-backs.
+ /** The numeric option call-backs. */
private final List<MenuCallback<T>> numericCallbacks = new ArrayList<MenuCallback<T>>();
- // The numeric option fields.
+ /** The numeric option fields. */
private final List<List<LocalizableMessage>> numericFields = new ArrayList<List<LocalizableMessage>>();
- // The menu title.
+ /** The menu title. */
private LocalizableMessage title = null;
- // The menu prompt.
+ /** The menu prompt. */
private LocalizableMessage prompt = null;
- // The maximum number of times that we allow the user to provide an invalid
- // answer (-1 if unlimited).
+ /**
+ * The maximum number of times that we allow the user to provide an invalid
+ * answer (-1 if unlimited).
+ */
private int nMaxTries = -1;
/**
diff --git a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/MenuResult.java b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/MenuResult.java
index 433b634..9b00aa0 100644
--- a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/MenuResult.java
+++ b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/MenuResult.java
@@ -174,13 +174,13 @@
return success(Collections.singleton(value));
}
- // The type of result returned from the menu.
+ /** The type of result returned from the menu. */
private final Type type;
- // The menu result value(s).
+ /** The menu result value(s). */
private final Collection<T> values;
- // Private constructor.
+ /** Private constructor. */
private MenuResult(Type type, Collection<T> values) {
this.type = type;
this.values = values;
diff --git a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/MultiChoiceArgument.java b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/MultiChoiceArgument.java
index 44d4632..e33bea4 100644
--- a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/MultiChoiceArgument.java
+++ b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/MultiChoiceArgument.java
@@ -41,11 +41,13 @@
* The type of values returned by this argument.
*/
public final class MultiChoiceArgument<T> extends Argument {
- // Indicates whether argument values should be treated in a
- // case-sensitive manner.
+ /**
+ * Indicates whether argument values should be treated in a
+ * case-sensitive manner.
+ */
private final boolean caseSensitive;
- // The set of values that will be allowed for use with this argument.
+ /** The set of values that will be allowed for use with this argument. */
private final Collection<T> allowedValues;
/**
diff --git a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/SubCommand.java b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/SubCommand.java
index f320edc..467cc08 100644
--- a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/SubCommand.java
+++ b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/SubCommand.java
@@ -40,44 +40,58 @@
* argument parser. The subcommand has a name, a description, and a set of arguments.
*/
public class SubCommand {
- // Indicates whether this subCommand should be hidden in the usage
- // information.
+ /**
+ * Indicates whether this subCommand should be hidden in the usage
+ * information.
+ */
private boolean isHidden;
- // The mapping between the short argument IDs and the arguments for this
- // subcommand.
+ /**
+ * The mapping between the short argument IDs and the arguments for this
+ * subcommand.
+ */
private HashMap<Character, Argument> shortIDMap;
- // The mapping between the long argument IDs and the arguments for this
- // subcommand.
+ /**
+ * The mapping between the long argument IDs and the arguments for this
+ * subcommand.
+ */
private HashMap<String, Argument> longIDMap;
- // The list of arguments associated with this subcommand.
+ /** The list of arguments associated with this subcommand. */
private LinkedList<Argument> arguments;
- // The description for this subcommand.
+ /** The description for this subcommand. */
private LocalizableMessage description;
- // The name of this subcommand.
+ /** The name of this subcommand. */
private String name;
- // The argument parser with which this subcommand is associated.
+ /** The argument parser with which this subcommand is associated. */
private SubCommandArgumentParser parser;
- // Indicates whether this parser will allow additional unnamed
- // arguments at the end of the list.
+ /**
+ * Indicates whether this parser will allow additional unnamed
+ * arguments at the end of the list.
+ */
private boolean allowsTrailingArguments;
- // The maximum number of unnamed trailing arguments that may be
- // provided.
+ /**
+ * The maximum number of unnamed trailing arguments that may be
+ * provided.
+ */
private int maxTrailingArguments;
- // The minimum number of unnamed trailing arguments that may be
- // provided.
+ /**
+ * The minimum number of unnamed trailing arguments that may be
+ * provided.
+ */
private int minTrailingArguments;
- // The display name that will be used for the trailing arguments in
- // the usage information.
+ /**
+ * The display name that will be used for the trailing arguments in
+ * the usage information.
+ */
private String trailingArgsDisplayName;
/**
diff --git a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/TableBuilder.java b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/TableBuilder.java
index 06692c7..44b8eae 100644
--- a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/TableBuilder.java
+++ b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/TableBuilder.java
@@ -39,29 +39,31 @@
*/
public final class TableBuilder {
- // The current column number in the current row where 0 represents
- // the left-most column in the table.
+ /**
+ * The current column number in the current row where 0 represents
+ * the left-most column in the table.
+ */
private int column = 0;
- // The current with of each column.
+ /** The current with of each column. */
private List<Integer> columnWidths = new ArrayList<Integer>();
- // The list of column headings.
+ /** The list of column headings. */
private List<LocalizableMessage> header = new ArrayList<LocalizableMessage>();
- // The current number of rows in the table.
+ /** The current number of rows in the table. */
private int height = 0;
- // The list of table rows.
+ /** The list of table rows. */
private List<List<String>> rows = new ArrayList<List<String>>();
- // The linked list of sort keys comparators.
+ /** The linked list of sort keys comparators. */
private List<Comparator<String>> sortComparators = new ArrayList<Comparator<String>>();
- // The linked list of sort keys.
+ /** The linked list of sort keys. */
private List<Integer> sortKeys = new ArrayList<Integer>();
- // The current number of columns in the table.
+ /** The current number of columns in the table. */
private int width = 0;
/**
diff --git a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/TextTablePrinter.java b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/TextTablePrinter.java
index 3b785bd..5d7f235 100644
--- a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/TextTablePrinter.java
+++ b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/TextTablePrinter.java
@@ -48,20 +48,20 @@
*/
private final class Serializer extends TableSerializer {
- /*The real column widths taking into account size constraints but
+ /**The real column widths taking into account size constraints but
not including padding or separators.*/
private final List<Integer> columnWidths = new ArrayList<Integer>();
- // The cells in the current row.
+ /** The cells in the current row. */
private final List<String> currentRow = new ArrayList<String>();
- // Width of the table in columns.
+ /** Width of the table in columns. */
private int totalColumns = 0;
- // The padding to use for indenting the table.
+ /** The padding to use for indenting the table. */
private final String indentPadding;
- // Private constructor.
+ /** Private constructor. */
private Serializer() {
// Compute the indentation padding.
final StringBuilder builder = new StringBuilder();
@@ -227,7 +227,7 @@
currentRow.clear();
}
- // We need to calculate the effective width of each column.
+ /** We need to calculate the effective width of each column. */
private void determineColumnWidths() {
// First calculate the minimum width so that we know how much
// expandable columns can expand.
@@ -297,35 +297,43 @@
*/
private static final int DEFAULT_PADDING = 1;
- // The string which should be used to separate one column
- // from the next (not including padding).
+ /**
+ * The string which should be used to separate one column
+ * from the next (not including padding).
+ */
private String columnSeparator = DEFAULT_COLUMN_SEPARATOR;
- // Indicates whether or not the headings should be output.
+ /** Indicates whether or not the headings should be output. */
private boolean displayHeadings = true;
- // Table indicating whether or not a column is fixed width.
+ /** Table indicating whether or not a column is fixed width. */
private final Map<Integer, Integer> fixedColumns = new HashMap<Integer, Integer>();
- // The number of characters the table should be indented.
+ /** The number of characters the table should be indented. */
private int indentWidth = 0;
- // The character which should be used to separate the table
- // heading row from the rows beneath.
+ /**
+ * The character which should be used to separate the table
+ * heading row from the rows beneath.
+ */
private char headingSeparator = DEFAULT_HEADING_SEPARATOR;
- // The column where the heading separator should begin.
+ /** The column where the heading separator should begin. */
private int headingSeparatorStartColumn = 0;
- // The padding which will be used to separate a cell's
- // contents from its adjacent column separators.
+ /**
+ * The padding which will be used to separate a cell's
+ * contents from its adjacent column separators.
+ */
private int padding = DEFAULT_PADDING;
- // Total permitted width for the table which expandable columns
- // can use up.
+ /**
+ * Total permitted width for the table which expandable columns
+ * can use up.
+ */
private int totalWidth = MAX_LINE_WIDTH;
- // The output destination.
+ /** The output destination. */
private PrintWriter writer = null;
/**
diff --git a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/Utils.java b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/Utils.java
index 7df440f..a1fb8cc 100644
--- a/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/Utils.java
+++ b/opendj-sdk/opendj-cli/src/main/java/com/forgerock/opendj/cli/Utils.java
@@ -534,7 +534,7 @@
}
- // Prevent instantiation.
+ /** Prevent instantiation. */
private Utils() {
// Do nothing.
}
diff --git a/opendj-sdk/opendj-cli/src/test/java/com/forgerock/opendj/cli/TestSubCommandArgumentParserTestCase.java b/opendj-sdk/opendj-cli/src/test/java/com/forgerock/opendj/cli/TestSubCommandArgumentParserTestCase.java
index b52a303..c5a7c99 100644
--- a/opendj-sdk/opendj-cli/src/test/java/com/forgerock/opendj/cli/TestSubCommandArgumentParserTestCase.java
+++ b/opendj-sdk/opendj-cli/src/test/java/com/forgerock/opendj/cli/TestSubCommandArgumentParserTestCase.java
@@ -47,10 +47,10 @@
private SubCommandArgumentParser parser;
- // First sub-command.
+ /** First sub-command. */
private SubCommand sc1;
- // Second sub-command.
+ /** Second sub-command. */
private SubCommand sc2;
/**
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ACIPropertyDefinition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ACIPropertyDefinition.java
index 156a9cc..086d86c 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ACIPropertyDefinition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ACIPropertyDefinition.java
@@ -41,14 +41,12 @@
*/
public static final class Builder extends AbstractBuilder<String, ACIPropertyDefinition> {
- // Private constructor
+ /** Private constructor. */
private Builder(AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
super(d, propertyName);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected ACIPropertyDefinition buildInstance(AbstractManagedObjectDefinition<?, ?> d,
String propertyName, EnumSet<PropertyOption> options,
@@ -80,16 +78,14 @@
+ "(\\s*(?i)version(?-i)\\s*(\\d\\.\\d)\\s*;\\s*(?i)acl(?-i)\\s*\"([^\"]*)"
+ "\"\\s*;\\s*\\s*(\\w+)\\s*\\(([^()]+)\\)\\s*(.+?\"[)]*)\\s*;\\s*\\s*\\)\\s*$");
- // Private constructor.
+ /** Private constructor. */
private ACIPropertyDefinition(AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options, AdministratorAction adminAction,
DefaultBehaviorProvider<String> defaultBehavior) {
super(d, String.class, propertyName, options, adminAction, defaultBehavior);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(String value) {
Reject.ifNull(value);
@@ -97,9 +93,7 @@
// No additional validation required.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String decodeValue(String value) {
Reject.ifNull(value);
@@ -117,25 +111,19 @@
throw PropertyException.illegalPropertyValueException(this, value);
}
- /**
- * {@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, String value, P p) {
return v.visitACI(this, value, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compare(String o1, String o2) {
return o1.toString().compareTo(o2.toString());
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AbsoluteInheritedDefaultBehaviorProvider.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AbsoluteInheritedDefaultBehaviorProvider.java
index 8e23477..cf8cea9 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AbsoluteInheritedDefaultBehaviorProvider.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AbsoluteInheritedDefaultBehaviorProvider.java
@@ -35,14 +35,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 = null;
- // 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;
/**
@@ -61,9 +63,7 @@
this.propertyName = propertyName;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <R, P> R accept(DefaultBehaviorProviderVisitor<T, R, P> v, P p) {
return v.visitAbsoluteInherited(this, p);
}
@@ -100,9 +100,7 @@
return propertyName;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected void initialize() throws Exception {
// Decode the path.
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AbstractManagedObjectDefinition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AbstractManagedObjectDefinition.java
index 96f8a14..139b6ae 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AbstractManagedObjectDefinition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AbstractManagedObjectDefinition.java
@@ -58,55 +58,73 @@
*/
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;
/**
@@ -754,9 +772,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final String toString() {
StringBuilder builder = new StringBuilder();
@@ -938,23 +954,28 @@
}
}
- // 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 <C1 extends ConfigurationClient, S1 extends Configuration> void registerReverseRelationDefinition(
RelationDefinition<C1, S1> rd) {
rd.getChildDefinition().reverseRelationDefinitions.add(rd);
}
- // 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) {
apd.getRelationDefinition().getChildDefinition().reverseAggregationPropertyDefinitions.add(apd);
}
- // 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, DefinitionResolver r) {
if (!r.matches(d)) {
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AdministratorAction.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AdministratorAction.java
index 85ed70f..7ba15c3 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AdministratorAction.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AdministratorAction.java
@@ -79,17 +79,15 @@
*/
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;
@@ -97,15 +95,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-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AggregationPropertyDefinition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AggregationPropertyDefinition.java
index 01c7da7..fa0d17d 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AggregationPropertyDefinition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AggregationPropertyDefinition.java
@@ -117,23 +117,31 @@
public static final class Builder<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 = null;
- // 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 = null;
- // 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);
}
@@ -192,9 +200,7 @@
this.targetNeedsEnablingCondition = condition;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected AggregationPropertyDefinition<C, S> buildInstance(AbstractManagedObjectDefinition<?, ?> d,
String propertyName, EnumSet<PropertyOption> options, AdministratorAction adminAction,
@@ -220,22 +226,22 @@
*/
private final 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;
this.message = message;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ConfigChangeResult applyConfigurationChange(ServerManagedObject<? extends S> mo) {
try {
if (targetIsEnabledCondition.evaluate(mo)) {
@@ -252,9 +258,7 @@
+ relationDefinition.getChildDefinition().getUserFriendlyName());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isConfigurationChangeAcceptable(ServerManagedObject<? extends S> mo,
List<LocalizableMessage> unacceptableReasons) {
// Always prevent the referenced component from being
@@ -280,7 +284,7 @@
}
}
- // Gets the path associated with this listener.
+ /** Gets the path associated with this listener. */
private ManagedObjectPath<C, S> getManagedObjectPath() {
return path;
}
@@ -292,22 +296,22 @@
*/
private final 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;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ConfigChangeResult applyConfigurationDelete(S configuration) {
// This should not happen - the
// isConfigurationDeleteAcceptable() call-back should have
@@ -323,16 +327,13 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isConfigurationDeleteAcceptable(S configuration, List<LocalizableMessage> unacceptableReasons) {
if (configuration.dn().equals(dn)) {
// Always prevent deletion of the referenced component.
unacceptableReasons.add(message);
return false;
}
-
return true;
}
@@ -343,9 +344,7 @@
*/
private class ServerHandler extends ServerConstraintHandler {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isUsable(ServerManagedObject<?> managedObject,
Collection<LocalizableMessage> unacceptableReasons) throws ConfigException {
@@ -382,9 +381,7 @@
return isUsable;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void performPostAdd(ServerManagedObject<?> managedObject) throws ConfigException {
// First make sure existing listeners associated with this
@@ -440,9 +437,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void performPostDelete(ServerManagedObject<?> managedObject) throws ConfigException {
// Remove any registered delete and change listeners.
@@ -472,9 +467,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void performPostModify(ServerManagedObject<?> managedObject) throws ConfigException {
// Remove all the constraints associated with this managed
@@ -491,9 +484,7 @@
*/
private class SourceClientHandler extends ClientConstraintHandler {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isAddAcceptable(ManagementContext context, ManagedObject<?> managedObject,
Collection<LocalizableMessage> unacceptableReasons) throws LdapException {
@@ -543,9 +534,7 @@
return isAcceptable;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isModifyAcceptable(ManagementContext context, ManagedObject<?> managedObject,
Collection<LocalizableMessage> unacceptableReasons) throws LdapException {
@@ -562,9 +551,7 @@
*/
private class TargetClientHandler extends ClientConstraintHandler {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isDeleteAcceptable(ManagementContext context, ManagedObjectPath<?, ?> path,
Collection<LocalizableMessage> unacceptableReasons) throws LdapException {
@@ -589,9 +576,7 @@
return isAcceptable;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isModifyAcceptable(ManagementContext context, ManagedObject<?> managedObject,
Collection<LocalizableMessage> unacceptableReasons) throws LdapException {
@@ -627,8 +612,10 @@
return isAcceptable;
}
- // 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 <C1 extends ConfigurationClient> List<ManagedObject<? extends C1>> findReferences(
ManagementContext context, AbstractManagedObjectDefinition<C1, ?> mod, String name)
throws LdapException {
@@ -654,7 +641,7 @@
return instances;
}
- // Find all instances of a specific type of managed object.
+ /** Find all instances of a specific type of managed object. */
@SuppressWarnings("unchecked")
private <C1 extends ConfigurationClient> List<ManagedObject<? extends C1>> findInstances(
ManagementContext context, AbstractManagedObjectDefinition<C1, ?> mod) throws LdapException {
@@ -725,44 +712,60 @@
private static final Logger debugLogger = LoggerFactory.getLogger(AggregationPropertyDefinition.class);
- // 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,
DefaultBehaviorProvider<String> defaultBehavior, String parentPathString, String rdName,
@@ -775,17 +778,13 @@
this.targetIsEnabledCondition = targetIsEnabledCondition;
this.sourceConstraint = new Constraint() {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<ClientConstraintHandler> getClientConstraintHandlers() {
ClientConstraintHandler handler = new SourceClientHandler();
return Collections.singleton(handler);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<ServerConstraintHandler> getServerConstraintHandlers() {
ServerConstraintHandler handler = new ServerHandler();
return Collections.singleton(handler);
@@ -793,25 +792,19 @@
};
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitAggregation(this, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, String value, P p) {
return v.visitAggregation(this, value, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String decodeValue(String value) {
Reject.ifNull(value);
@@ -944,9 +937,7 @@
return targetNeedsEnablingCondition;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String normalizeValue(String value) {
try {
@@ -957,9 +948,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void toString(StringBuilder builder) {
super.toString(builder);
@@ -977,9 +966,7 @@
builder.append(String.valueOf(targetIsEnabledCondition));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(String value) {
try {
@@ -989,9 +976,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
@Override
public void initialize() throws Exception {
@@ -1012,17 +997,13 @@
// 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);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<ServerConstraintHandler> getServerConstraintHandlers() {
return Collections.emptyList();
}
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AliasDefaultBehaviorProvider.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AliasDefaultBehaviorProvider.java
index 46cac8c..5e01cfd 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AliasDefaultBehaviorProvider.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AliasDefaultBehaviorProvider.java
@@ -42,12 +42,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;
/**
@@ -65,9 +69,7 @@
this.propertyName = propertyName;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <R, P> R accept(DefaultBehaviorProviderVisitor<T, R, P> v, P p) {
return v.visitAlias(this, p);
}
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AttributeTypePropertyDefinition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AttributeTypePropertyDefinition.java
index fa82135..ea1177f 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AttributeTypePropertyDefinition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/AttributeTypePropertyDefinition.java
@@ -44,14 +44,12 @@
*/
public static final class Builder extends AbstractBuilder<AttributeType, AttributeTypePropertyDefinition> {
- // Private constructor
+ /** Private constructor. */
private Builder(AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
super(d, propertyName);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected AttributeTypePropertyDefinition buildInstance(AbstractManagedObjectDefinition<?, ?> d,
String propertyName, EnumSet<PropertyOption> options, AdministratorAction adminAction,
@@ -74,40 +72,32 @@
return new Builder(d, propertyName);
}
- // Private constructor.
+ /** Private constructor. */
private AttributeTypePropertyDefinition(AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options, AdministratorAction adminAction,
DefaultBehaviorProvider<AttributeType> defaultBehavior) {
super(d, AttributeType.class, propertyName, options, adminAction, defaultBehavior);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitAttributeType(this, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, AttributeType value, P p) {
return v.visitAttributeType(this, value, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compare(AttributeType o1, AttributeType o2) {
return o1.getNameOrOID().compareToIgnoreCase(o2.getNameOrOID());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public AttributeType decodeValue(String value) {
Reject.ifNull(value);
@@ -128,17 +118,13 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String encodeValue(AttributeType value) {
return value.getNameOrOID();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(AttributeType value) {
Reject.ifNull(value);
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/BooleanPropertyDefinition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/BooleanPropertyDefinition.java
index bf39a6e..03ce69d 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/BooleanPropertyDefinition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/BooleanPropertyDefinition.java
@@ -55,14 +55,12 @@
*/
public static final class Builder extends AbstractBuilder<Boolean, BooleanPropertyDefinition> {
- // Private constructor
+ /** Private constructor. */
private Builder(AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
super(d, propertyName);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected BooleanPropertyDefinition buildInstance(AbstractManagedObjectDefinition<?, ?> d,
String propertyName, EnumSet<PropertyOption> options, AdministratorAction adminAction,
@@ -86,16 +84,14 @@
return new Builder(d, propertyName);
}
- // Private constructor.
+ /** Private constructor. */
private BooleanPropertyDefinition(AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options, AdministratorAction adminAction,
DefaultBehaviorProvider<Boolean> defaultBehavior) {
super(d, Boolean.class, propertyName, options, adminAction, defaultBehavior);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(Boolean value) {
Reject.ifNull(value);
@@ -103,9 +99,7 @@
// No additional validation required.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Boolean decodeValue(String value) {
Reject.ifNull(value);
@@ -120,25 +114,19 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitBoolean(this, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, Boolean value, P p) {
return v.visitBoolean(this, value, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compare(Boolean o1, Boolean o2) {
return o1.compareTo(o2);
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ClassPropertyDefinition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ClassPropertyDefinition.java
index 9f51ee9..40722bf 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ClassPropertyDefinition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ClassPropertyDefinition.java
@@ -53,10 +53,10 @@
*/
public static final 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);
@@ -84,9 +84,7 @@
instanceOfInterfaces.add(value);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected ClassPropertyDefinition buildInstance(AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options, AdministratorAction adminAction,
@@ -97,7 +95,7 @@
}
- // 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_]+)*$";
/**
@@ -114,15 +112,15 @@
return new Builder(d, propertyName);
}
- // Load a named class.
+ /** Load a named class. */
private static Class<?> loadClass(String className, boolean initialize) throws ClassNotFoundException {
return Class.forName(className, initialize, ConfigurationFramework.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, AdministratorAction adminAction,
DefaultBehaviorProvider<String> defaultBehavior, List<String> instanceOfInterfaces) {
@@ -131,25 +129,19 @@
this.instanceOfInterfaces = Collections.unmodifiableList(new LinkedList<String>(instanceOfInterfaces));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitClass(this, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, String value, P p) {
return v.visitClass(this, value, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String decodeValue(String value) {
Reject.ifNull(value);
@@ -204,9 +196,7 @@
return theClass.asSubclass(instanceOf);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String normalizeValue(String value) {
Reject.ifNull(value);
@@ -214,9 +204,7 @@
return value.trim();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(String value) {
Reject.ifNull(value);
@@ -233,7 +221,7 @@
}
}
- /*
+ /**
* Do some basic checks to make sure the string representation is valid.
*/
private void validateClassName(String className) {
@@ -243,7 +231,7 @@
}
}
- /*
+ /**
* Make sure that named class implements the interfaces named by this
* definition.
*/
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ConfigurationFramework.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ConfigurationFramework.java
index f31216b..fef9caf 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ConfigurationFramework.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ConfigurationFramework.java
@@ -130,20 +130,22 @@
.getLocalizedLogger(AdminMessages.resourceName());
private static final Logger debugLogger = LoggerFactory.getLogger(ConfigurationFramework.class);
- // 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 ConfigurationFramework INSTANCE = new ConfigurationFramework();
- // 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(), REVISION_NUMBER };
@@ -157,17 +159,19 @@
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).
+ * <p>
+ * 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 = null;
private boolean isClient = true;
@@ -175,7 +179,7 @@
private String instancePath;
private ClassLoader parent;
- // Private constructor.
+ /** Private constructor. */
private ConfigurationFramework() {
// No implementation required.
}
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DNPropertyDefinition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DNPropertyDefinition.java
index 9ce7c5c..feade4e 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DNPropertyDefinition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DNPropertyDefinition.java
@@ -37,8 +37,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;
/**
@@ -46,11 +48,13 @@
*/
public static final 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 = null;
- // Private constructor
+ /** Private constructor. */
private Builder(AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
super(d, propertyName);
}
@@ -86,9 +90,7 @@
this.baseDN = baseDN;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected DNPropertyDefinition buildInstance(AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options, AdministratorAction adminAction,
@@ -111,7 +113,7 @@
return new Builder(d, propertyName);
}
- // Private constructor.
+ /** Private constructor. */
private DNPropertyDefinition(AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options, AdministratorAction adminAction,
DefaultBehaviorProvider<DN> defaultBehavior, DN baseDN) {
@@ -130,9 +132,7 @@
return baseDN;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(DN value) {
Reject.ifNull(value);
@@ -150,9 +150,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public DN decodeValue(String value) {
Reject.ifNull(value);
@@ -166,25 +164,19 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitDN(this, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, DN value, P p) {
return v.visitDN(this, value, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compare(DN o1, DN o2) {
return o1.compareTo(o2);
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DefaultManagedObject.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DefaultManagedObject.java
index e0d4015..8b37bc3 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DefaultManagedObject.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DefaultManagedObject.java
@@ -55,10 +55,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>>();
/**
@@ -98,13 +98,13 @@
}
}
- // 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-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DefinedDefaultBehaviorProvider.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DefinedDefaultBehaviorProvider.java
index 0e15171..1c114dd 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DefinedDefaultBehaviorProvider.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DefinedDefaultBehaviorProvider.java
@@ -39,7 +39,7 @@
*/
public final class DefinedDefaultBehaviorProvider<T> extends DefaultBehaviorProvider<T> {
- // The collection of default values.
+ /** The collection of default values. */
private final Collection<String> values;
/**
@@ -59,9 +59,7 @@
this.values = Arrays.asList(values);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <R, P> R accept(DefaultBehaviorProviderVisitor<T, R, P> v, P p) {
return v.visitDefined(this, p);
}
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DefinitionDecodingException.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DefinitionDecodingException.java
index ad4a302..88a4538 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DefinitionDecodingException.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DefinitionDecodingException.java
@@ -65,7 +65,7 @@
*/
private static final long serialVersionUID = 3459033551415663416L;
- // Create the message.
+ /** Create the message. */
private static LocalizableMessage createLocalizableMessage(AbstractManagedObjectDefinition<?, ?> d, Reason reason) {
LocalizableMessage ufn = d.getUserFriendlyName();
switch (reason) {
@@ -78,10 +78,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-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DurationPropertyDefinition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DurationPropertyDefinition.java
index 0318fe9..0b80fb7 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DurationPropertyDefinition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DurationPropertyDefinition.java
@@ -58,24 +58,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;
/**
@@ -84,25 +86,26 @@
*/
public static final 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 = null;
- // The lower limit of the property value in milli-seconds.
+ /** The lower limit of the property value in milli-seconds. */
private long lowerLimit = 0L;
- // 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 = null;
- // 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 = false;
- // Private constructor
+ /** Private constructor. */
private Builder(AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
super(d, propertyName);
}
@@ -299,9 +302,7 @@
this.allowUnlimited = allowUnlimited;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected DurationPropertyDefinition buildInstance(AbstractManagedObjectDefinition<?, ?> d,
String propertyName, EnumSet<PropertyOption> options, AdministratorAction adminAction,
@@ -325,7 +326,7 @@
return new Builder(d, propertyName);
}
- // Private constructor.
+ /** Private constructor. */
private DurationPropertyDefinition(AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options, AdministratorAction adminAction,
DefaultBehaviorProvider<Long> defaultBehavior, DurationUnit baseUnit, DurationUnit maximumUnit,
@@ -388,9 +389,7 @@
return allowUnlimited;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(Long value) {
Reject.ifNull(value);
@@ -409,9 +408,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String encodeValue(Long value) {
Reject.ifNull(value);
@@ -432,9 +429,7 @@
return builder.toString();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Long decodeValue(String value) {
Reject.ifNull(value);
@@ -470,25 +465,19 @@
return i;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitDuration(this, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, Long value, P p) {
return v.visitDuration(this, value, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void toString(StringBuilder builder) {
super.toString(builder);
@@ -515,9 +504,7 @@
builder.append(allowUnlimited);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compare(Long o1, Long o2) {
return o1.compareTo(o2);
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DurationUnit.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DurationUnit.java
index 269bd82..65d69c7 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DurationUnit.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/DurationUnit.java
@@ -65,7 +65,7 @@
*/
WEEKS((long) 7 * 24 * 60 * 60 * 1000, "w", "weeks");
- // A lookup table for resolving a unit from its name.
+ /** A lookup table for resolving a unit from its name. */
private static final Map<String, DurationUnit> NAME_TO_UNIT;
static {
NAME_TO_UNIT = new HashMap<String, DurationUnit>();
@@ -272,16 +272,16 @@
return builder.toString();
}
- // The long name of the unit.
+ /** The long name of the unit. */
private final String longName;
- // The abbreviation of the unit.
+ /** The abbreviation of the unit. */
private final String shortName;
- // The size of the unit in milliseconds.
+ /** The size of the unit in milliseconds. */
private final long sz;
- // Private constructor.
+ /** Private constructor. */
private DurationUnit(long sz, String shortName, String longName) {
this.sz = sz;
this.shortName = shortName;
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/EnumPropertyDefinition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/EnumPropertyDefinition.java
index 01405aa..d847bd9 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/EnumPropertyDefinition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/EnumPropertyDefinition.java
@@ -54,10 +54,10 @@
*/
public final 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);
this.enumClass = null;
@@ -75,9 +75,7 @@
this.enumClass = enumClass;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected EnumPropertyDefinition<E> buildInstance(AbstractManagedObjectDefinition<?, ?> d,
String propertyName, EnumSet<PropertyOption> options, AdministratorAction adminAction,
@@ -109,13 +107,13 @@
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, DefaultBehaviorProvider<E> defaultBehavior,
Class<E> enumClass) {
@@ -130,25 +128,19 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitEnum(this, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, E value, P p) {
return v.visitEnum(this, value, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public E decodeValue(String value) {
Reject.ifNull(value);
@@ -205,9 +197,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String normalizeValue(E value) {
Reject.ifNull(value);
@@ -215,9 +205,7 @@
return value.toString().trim().toLowerCase();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(E value) {
Reject.ifNull(value);
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/GenericConstraint.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/GenericConstraint.java
index 17ad341..ab09601 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/GenericConstraint.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/GenericConstraint.java
@@ -52,14 +52,12 @@
*/
private final 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) throws LdapException {
@@ -71,9 +69,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isModifyAcceptable(ManagementContext context, ManagedObject<?> managedObject,
Collection<LocalizableMessage> unacceptableReasons) throws LdapException {
@@ -92,14 +88,12 @@
*/
private final 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 {
@@ -113,19 +107,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();
/**
@@ -144,16 +138,12 @@
this.condition = condition;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<ClientConstraintHandler> getClientConstraintHandlers() {
return Collections.singleton(clientHandler);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<ServerConstraintHandler> getServerConstraintHandlers() {
return Collections.singleton(serverHandler);
}
@@ -180,9 +170,7 @@
return resource.getMessage(definition, property, locale);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected void initialize() throws Exception {
condition.initialize(definition);
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/IPAddressMaskPropertyDefinition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/IPAddressMaskPropertyDefinition.java
index e6b8c30..25df066 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/IPAddressMaskPropertyDefinition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/IPAddressMaskPropertyDefinition.java
@@ -44,14 +44,12 @@
*/
public static final class Builder extends AbstractBuilder<AddressMask, IPAddressMaskPropertyDefinition> {
- // Private constructor
+ /** Private constructor. */
private Builder(AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
super(d, propertyName);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected IPAddressMaskPropertyDefinition buildInstance(AbstractManagedObjectDefinition<?, ?> d,
String propertyName, EnumSet<PropertyOption> options, AdministratorAction adminAction,
@@ -75,16 +73,14 @@
return new Builder(d, propertyName);
}
- // Private constructor.
+ /** Private constructor. */
private IPAddressMaskPropertyDefinition(AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options, AdministratorAction adminAction,
DefaultBehaviorProvider<AddressMask> defaultBehavior) {
super(d, AddressMask.class, propertyName, options, adminAction, defaultBehavior);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(AddressMask value) {
Reject.ifNull(value);
@@ -92,9 +88,7 @@
// No additional validation required.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public AddressMask decodeValue(String value) {
Reject.ifNull(value);
@@ -107,25 +101,19 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitIPAddressMask(this, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, AddressMask value, P p) {
return v.visitIPAddressMask(this, value, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compare(AddressMask o1, AddressMask o2) {
return o1.toString().compareTo(o2.toString());
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/IPAddressPropertyDefinition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/IPAddressPropertyDefinition.java
index 3b06b5c..c19bb17 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/IPAddressPropertyDefinition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/IPAddressPropertyDefinition.java
@@ -43,14 +43,12 @@
*/
public static final class Builder extends AbstractBuilder<InetAddress, IPAddressPropertyDefinition> {
- // Private constructor
+ /** Private constructor. */
private Builder(AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
super(d, propertyName);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected IPAddressPropertyDefinition buildInstance(AbstractManagedObjectDefinition<?, ?> d,
String propertyName, EnumSet<PropertyOption> options, AdministratorAction adminAction,
@@ -74,16 +72,14 @@
return new Builder(d, propertyName);
}
- // Private constructor.
+ /** Private constructor. */
private IPAddressPropertyDefinition(AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options, AdministratorAction adminAction,
DefaultBehaviorProvider<InetAddress> defaultBehavior) {
super(d, InetAddress.class, propertyName, options, adminAction, defaultBehavior);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(InetAddress value) {
Reject.ifNull(value);
@@ -91,9 +87,7 @@
// No additional validation required.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public InetAddress decodeValue(String value) {
Reject.ifNull(value);
@@ -106,9 +100,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String encodeValue(InetAddress value) {
// We should return the host name if it is available, or the IP
@@ -126,25 +118,19 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitIPAddress(this, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, InetAddress value, P p) {
return v.visitIPAddress(this, value, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compare(InetAddress o1, InetAddress o2) {
return o1.getHostAddress().compareTo(o2.getHostAddress());
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/InstantiableRelationDefinition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/InstantiableRelationDefinition.java
index 8058fb1..6d0517d 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/InstantiableRelationDefinition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/InstantiableRelationDefinition.java
@@ -64,14 +64,16 @@
public static final class Builder<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 = null;
- // 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>>();
@@ -121,9 +123,7 @@
this.namingPropertyDefinition = namingPropertyDefinition;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected InstantiableRelationDefinition<C, S> buildInstance(Common<C, S> common) {
return new InstantiableRelationDefinition<C, S>(common, pluralName, namingPropertyDefinition,
@@ -132,17 +132,19 @@
}
- // 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,
Map<String, DefaultManagedObject<? extends C, ? extends S>> defaultManagedObjects) {
@@ -152,9 +154,7 @@
this.defaultManagedObjects = defaultManagedObjects;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(RelationDefinitionVisitor<R, P> v, P p) {
return v.visitInstantiable(this, p);
@@ -235,9 +235,7 @@
return ManagedObjectDefinitionI18NResource.getInstance().getMessage(getParentDefinition(), property, locale);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void toString(StringBuilder builder) {
builder.append("name=");
@@ -248,9 +246,7 @@
builder.append(getChildDefinition().getName());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected void initialize() throws Exception {
for (DefaultManagedObject<?, ?> dmo : defaultManagedObjects.values()) {
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/IntegerPropertyDefinition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/IntegerPropertyDefinition.java
index 8d2afc4..b622dd1 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/IntegerPropertyDefinition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/IntegerPropertyDefinition.java
@@ -43,17 +43,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;
/**
@@ -61,18 +63,19 @@
*/
public static final class Builder extends AbstractBuilder<Integer, IntegerPropertyDefinition> {
- // The lower limit of the property value.
+ /** The lower limit of the property value. */
private int lowerLimit = 0;
- // The optional upper limit of the property value.
+ /** The optional upper limit of the property value. */
private Integer upperLimit = null;
- // 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 = false;
- // Private constructor
+ /** Private constructor. */
private Builder(AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
super(d, propertyName);
}
@@ -127,9 +130,7 @@
this.allowUnlimited = allowUnlimited;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected IntegerPropertyDefinition buildInstance(AbstractManagedObjectDefinition<?, ?> d,
String propertyName, EnumSet<PropertyOption> options, AdministratorAction adminAction,
@@ -154,7 +155,7 @@
return new Builder(d, propertyName);
}
- // Private constructor.
+ /** Private constructor. */
private IntegerPropertyDefinition(AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options, AdministratorAction adminAction,
DefaultBehaviorProvider<Integer> defaultBehavior, int lowerLimit, Integer upperLimit, boolean allowUnlimited) {
@@ -225,9 +226,7 @@
return allowUnlimited;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(Integer value) {
Reject.ifNull(value);
@@ -245,9 +244,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String encodeValue(Integer value) {
Reject.ifNull(value);
@@ -262,9 +259,7 @@
return value.toString();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Integer decodeValue(String value) {
Reject.ifNull(value);
@@ -291,25 +286,19 @@
return i;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitInteger(this, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, Integer value, P p) {
return v.visitInteger(this, value, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void toString(StringBuilder builder) {
super.toString(builder);
@@ -326,9 +315,7 @@
builder.append(allowUnlimited);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compare(Integer o1, Integer o2) {
return o1.compareTo(o2);
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/LDAPProfile.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/LDAPProfile.java
index ca43507..52f18c1 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/LDAPProfile.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/LDAPProfile.java
@@ -147,7 +147,7 @@
}
}
- // The singleton instance.
+ /** The singleton instance. */
private static final LDAPProfile INSTANCE = new LDAPProfile();
/**
@@ -159,13 +159,13 @@
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-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ManagedObjectDefinitionI18NResource.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ManagedObjectDefinitionI18NResource.java
index fca5190..9bb8fa1 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ManagedObjectDefinitionI18NResource.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ManagedObjectDefinitionI18NResource.java
@@ -41,7 +41,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>();
@@ -67,7 +67,7 @@
return getInstance("config.profiles." + profile);
}
- // Get a resource instance creating it if necessary.
+ /** Get a resource instance creating it if necessary. */
private synchronized static ManagedObjectDefinitionI18NResource getInstance(String prefix) {
ManagedObjectDefinitionI18NResource instance = INSTANCES.get(prefix);
@@ -79,13 +79,13 @@
return instance;
}
- // 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>>();
this.prefix = prefix;
@@ -260,8 +260,10 @@
map.put(locale, resoureBundle);
}
- // 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) {
if (d.isTop()) {
throw new UnsupportedOperationException("I18n resources are not available for the "
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ManagedObjectDefinitionResource.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ManagedObjectDefinitionResource.java
index f434ce3..c3fa99b 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ManagedObjectDefinitionResource.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ManagedObjectDefinitionResource.java
@@ -45,10 +45,10 @@
*/
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;
/**
@@ -62,7 +62,7 @@
return new ManagedObjectDefinitionResource("config.profiles." + profile);
}
- // Private constructor.
+ /** Private constructor. */
private ManagedObjectDefinitionResource(String prefix) {
this.properties = new HashMap<AbstractManagedObjectDefinition<?, ?>, Properties>();
this.prefix = prefix;
@@ -101,8 +101,10 @@
return result;
}
- // 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) {
Properties p = properties.get(d);
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ManagedObjectPath.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ManagedObjectPath.java
index 1e6645a..af4a181 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ManagedObjectPath.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/ManagedObjectPath.java
@@ -117,21 +117,19 @@
*/
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();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration> void appendManagedObjectPathElement(
InstantiableRelationDefinition<? super C, ? super S> r, AbstractManagedObjectDefinition<C, S> d,
String name) {
@@ -144,9 +142,7 @@
dn = dn.child(new RDN(attrType, name));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration> void appendManagedObjectPathElement(
SetRelationDefinition<? super C, ? super S> r, AbstractManagedObjectDefinition<C, S> d) {
// Add the RDN sequence representing the relation.
@@ -158,31 +154,27 @@
dn = dn.child(new RDN(attrType, d.getName()));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration> void appendManagedObjectPathElement(
OptionalRelationDefinition<? super C, ? super S> r, AbstractManagedObjectDefinition<C, S> d) {
// Add the RDN sequence representing the relation.
appendManagedObjectPathElement(r);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration> void appendManagedObjectPathElement(
SingletonRelationDefinition<? super C, ? super S> r, AbstractManagedObjectDefinition<C, S> d) {
// Add the RDN sequence representing the relation.
appendManagedObjectPathElement(r);
}
- // Appends the RDN sequence representing the provided relation.
+ /** Appends the RDN sequence representing the provided relation. */
private void appendManagedObjectPathElement(RelationDefinition<?, ?> r) {
DN localName = DN.valueOf(profile.getRelationRDNSequence(r));
dn = dn.child(localName);
}
- // Gets the serialized DN value.
+ /** Gets the serialized DN value. */
private DN toDN() {
return dn;
}
@@ -193,7 +185,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;
/**
@@ -248,20 +240,20 @@
private static final class InstantiableElement<C extends ConfigurationClient, S extends Configuration> extends
Element<C, S> {
- // Factory method.
+ /** Factory method. */
private static final <C extends ConfigurationClient, S extends Configuration> InstantiableElement<C, S> create(
InstantiableRelationDefinition<? super C, ? super S> r, AbstractManagedObjectDefinition<C, S> d,
String name) {
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) {
super(d);
@@ -269,25 +261,19 @@
this.name = name;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getName() {
return name;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public InstantiableRelationDefinition<? super C, ? super S> getRelationDefinition() {
return r;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void serialize(ManagedObjectPathSerializer serializer) {
serializer.appendManagedObjectPathElement(r, getManagedObjectDefinition(), name);
@@ -300,33 +286,29 @@
private static final class OptionalElement<C extends ConfigurationClient, S extends Configuration> extends
Element<C, S> {
- // Factory method.
+ /** Factory method. */
private static final <C extends ConfigurationClient, S extends Configuration> OptionalElement<C, S> create(
OptionalRelationDefinition<? super C, ? super S> r, AbstractManagedObjectDefinition<C, S> d) {
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);
this.r = r;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public OptionalRelationDefinition<? super C, ? super S> getRelationDefinition() {
return r;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void serialize(ManagedObjectPathSerializer serializer) {
serializer.appendManagedObjectPathElement(r, getManagedObjectDefinition());
@@ -339,32 +321,28 @@
private static final class SetElement<C extends ConfigurationClient, S extends Configuration> extends
Element<C, S> {
- // Factory method.
+ /** Factory method. */
private static final <C extends ConfigurationClient, S extends Configuration> SetElement<C, S> create(
SetRelationDefinition<? super C, ? super S> r, AbstractManagedObjectDefinition<C, S> d) {
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) {
super(d);
this.r = r;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public SetRelationDefinition<? super C, ? super S> getRelationDefinition() {
return r;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void serialize(ManagedObjectPathSerializer serializer) {
serializer.appendManagedObjectPathElement(r, getManagedObjectDefinition());
@@ -377,33 +355,29 @@
private static final class SingletonElement<C extends ConfigurationClient, S extends Configuration> extends
Element<C, S> {
- // Factory method.
+ /** Factory method. */
private static final <C extends ConfigurationClient, S extends Configuration> SingletonElement<C, S> create(
SingletonRelationDefinition<? super C, ? super S> r, AbstractManagedObjectDefinition<C, S> d) {
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) {
super(d);
this.r = r;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public SingletonRelationDefinition<? super C, ? super S> getRelationDefinition() {
return r;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void serialize(ManagedObjectPathSerializer serializer) {
serializer.appendManagedObjectPathElement(r, getManagedObjectDefinition());
@@ -415,17 +389,15 @@
*/
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, AbstractManagedObjectDefinition<M, N> d,
String name) {
@@ -436,31 +408,25 @@
builder.append(name.replace("/", "//"));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <M extends ConfigurationClient, N extends Configuration> void appendManagedObjectPathElement(
OptionalRelationDefinition<? super M, ? super N> r, AbstractManagedObjectDefinition<M, N> d) {
serializeElement(r, d);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <M extends ConfigurationClient, N extends Configuration> void appendManagedObjectPathElement(
SingletonRelationDefinition<? super M, ? super N> r, AbstractManagedObjectDefinition<M, N> d) {
serializeElement(r, d);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <M extends ConfigurationClient, N extends Configuration> void appendManagedObjectPathElement(
SetRelationDefinition<? super M, ? super N> r, AbstractManagedObjectDefinition<M, N> d) {
serializeElement(r, d);
}
- // Common element serialization.
+ /** Common element serialization. */
private <M, N> void serializeElement(RelationDefinition<?, ?> r, AbstractManagedObjectDefinition<?, ?> d) {
// Always specify the relation name.
builder.append("/relation=");
@@ -475,12 +441,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*)?" + "(\\+\\s*name=\\s*([^+]+)\\s*)?$");
@@ -588,8 +554,10 @@
return create(elements, lastElement);
}
- // 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) {
return new ManagedObjectPath<C, S>(elements, lastElement.getRelationDefinition(),
@@ -662,16 +630,16 @@
}
}
- // 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) {
this.elements = Collections.unmodifiableList(elements);
@@ -943,9 +911,7 @@
return child(r, r.getChildDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean equals(Object obj) {
if (obj == this) {
@@ -1001,9 +967,7 @@
return r;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
return toString().hashCode();
@@ -1154,9 +1118,7 @@
return serializer.toDN();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/OptionalRelationDefinition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/OptionalRelationDefinition.java
index bbe57c0..b1434e8 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/OptionalRelationDefinition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/OptionalRelationDefinition.java
@@ -55,8 +55,10 @@
public static final class Builder<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 = null;
/**
@@ -88,9 +90,7 @@
this.defaultManagedObject = defaultManagedObject;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected OptionalRelationDefinition<C, S> buildInstance(Common<C, S> common) {
return new OptionalRelationDefinition<C, S>(common, defaultManagedObject);
@@ -98,20 +98,20 @@
}
- // 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);
this.defaultManagedObject = defaultManagedObject;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(RelationDefinitionVisitor<R, P> v, P p) {
return v.visitOptional(this, p);
@@ -129,9 +129,7 @@
return defaultManagedObject;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void toString(StringBuilder builder) {
builder.append("name=");
@@ -142,9 +140,7 @@
builder.append(getChildDefinition().getName());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected void initialize() throws Exception {
if (defaultManagedObject != null) {
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyDefinition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyDefinition.java
index 4ec9ec1..0834779 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyDefinition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyDefinition.java
@@ -60,19 +60,19 @@
*/
protected abstract static 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;
/**
@@ -156,22 +156,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-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyDefinitionUsageBuilder.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyDefinitionUsageBuilder.java
index ef3b27f..e19c5df 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyDefinitionUsageBuilder.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyDefinitionUsageBuilder.java
@@ -46,14 +46,16 @@
*/
private static final 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;
@@ -62,34 +64,26 @@
this.numberFormat.setMaximumFractionDigits(2);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <C extends ConfigurationClient, S extends Configuration> LocalizableMessage visitAggregation(
AggregationPropertyDefinition<C, S> d, Void p) {
return LocalizableMessage.raw("NAME");
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage visitAttributeType(AttributeTypePropertyDefinition d, Void p) {
return LocalizableMessage.raw("OID");
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage visitACI(ACIPropertyDefinition d, Void p) {
return LocalizableMessage.raw("ACI");
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage visitBoolean(BooleanPropertyDefinition d, Void p) {
if (isDetailed) {
@@ -99,9 +93,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage visitClass(ClassPropertyDefinition d, Void p) {
if (isDetailed && !d.getInstanceOfInterface().isEmpty()) {
@@ -111,9 +103,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage visitDN(DNPropertyDefinition d, Void p) {
if (isDetailed && d.getBaseDN() != null) {
@@ -123,9 +113,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage visitDuration(DurationPropertyDefinition d, Void p) {
LocalizableMessageBuilder builder = new LocalizableMessageBuilder();
@@ -154,9 +142,7 @@
return builder.toMessage();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <E extends Enum<E>> LocalizableMessage visitEnum(EnumPropertyDefinition<E> d, Void p) {
if (!isDetailed) {
@@ -177,9 +163,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage visitInteger(IntegerPropertyDefinition d, Void p) {
LocalizableMessageBuilder builder = new LocalizableMessageBuilder();
@@ -203,25 +187,19 @@
return builder.toMessage();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage visitIPAddress(IPAddressPropertyDefinition d, Void p) {
return LocalizableMessage.raw("HOST_NAME");
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage visitIPAddressMask(IPAddressMaskPropertyDefinition d, Void p) {
return LocalizableMessage.raw("IP_ADDRESS_MASK");
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage visitSize(SizePropertyDefinition d, Void p) {
LocalizableMessageBuilder builder = new LocalizableMessageBuilder();
@@ -273,9 +251,7 @@
return builder.toMessage();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LocalizableMessage visitString(StringPropertyDefinition d, Void p) {
if (d.getPattern() != null) {
@@ -293,16 +269,14 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <T> LocalizableMessage visitUnknown(PropertyDefinition<T> d, Void p) {
return LocalizableMessage.raw("?");
}
}
- // Underlying implementation.
+ /** Underlying implementation. */
private final MyPropertyDefinitionVisitor pimpl;
/**
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyException.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyException.java
index 9eb6966..6cb2d79 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyException.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyException.java
@@ -142,7 +142,7 @@
pd.getName(), pd.getClass().getName()));
}
- // Create the message.
+ /** Create the message. */
private static LocalizableMessage createMessage(final PropertyDefinition<?> pd,
final Object value) {
final PropertyDefinitionUsageBuilder builder = new PropertyDefinitionUsageBuilder(true);
@@ -150,11 +150,13 @@
builder.getUsage(pd));
}
- // 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.
+ /**
+ * The property definition associated with the property that caused
+ * the exception.
+ */
private final PropertyDefinition<?> pd;
private PropertyException(final PropertyDefinition<?> pd, final LocalizableMessage message) {
@@ -170,9 +172,7 @@
this.pd = pd;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public LocalizableMessage getMessageObject() {
return message;
}
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyNotFoundException.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyNotFoundException.java
index db07150..c171e9f 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyNotFoundException.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyNotFoundException.java
@@ -41,7 +41,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-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyProvider.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyProvider.java
index 62bc0f7..c901eb5 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyProvider.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/PropertyProvider.java
@@ -41,9 +41,7 @@
*/
public static final PropertyProvider DEFAULT_PROVIDER = new PropertyProvider() {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <T> Collection<T> getPropertyValues(PropertyDefinition<T> d) {
return Collections.<T> emptySet();
}
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/Reference.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/Reference.java
index ef6d591..7f10fab 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/Reference.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/Reference.java
@@ -132,17 +132,19 @@
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) {
this.relation = relation;
this.name = name;
@@ -177,15 +179,15 @@
return path.toDN();
}
- /**
- * {@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-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/RelationDefinition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/RelationDefinition.java
index bc1a2bf..3347088 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/RelationDefinition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/RelationDefinition.java
@@ -95,7 +95,7 @@
protected abstract static class AbstractBuilder<C extends ConfigurationClient, S extends Configuration,
D extends RelationDefinition<C, S>> {
- // Common fields.
+ /** Common fields. */
private final Common<C, S> common;
/**
@@ -157,19 +157,19 @@
*/
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;
@@ -179,7 +179,7 @@
}
}
- // Common fields.
+ /** Common fields. */
private final Common<C, S> common;
/**
@@ -327,9 +327,7 @@
return common.options.contains(option);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final String toString() {
StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/RelativeInheritedDefaultBehaviorProvider.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/RelativeInheritedDefaultBehaviorProvider.java
index 972cd9c..c8cfce7 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/RelativeInheritedDefaultBehaviorProvider.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/RelativeInheritedDefaultBehaviorProvider.java
@@ -35,14 +35,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;
/**
@@ -75,9 +77,7 @@
this.offset = offset;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <R, P> R accept(DefaultBehaviorProviderVisitor<T, R, P> v, P p) {
return v.visitRelativeInherited(this, p);
}
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/SetRelationDefinition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/SetRelationDefinition.java
index 834a2ba..422fdf9 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/SetRelationDefinition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/SetRelationDefinition.java
@@ -62,11 +62,13 @@
public static final class Builder<C extends ConfigurationClient, S extends Configuration> 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 =
new HashMap<String, DefaultManagedObject<? extends C, ? extends S>>();
@@ -100,9 +102,7 @@
defaultManagedObject);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected SetRelationDefinition<C, S> buildInstance(Common<C, S> common) {
return new SetRelationDefinition<C, S>(common, pluralName, defaultManagedObjects);
@@ -110,14 +110,16 @@
}
- // 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,
Map<String, DefaultManagedObject<? extends C, ? extends S>> defaultManagedObjects) {
super(common);
@@ -125,9 +127,7 @@
this.defaultManagedObjects = defaultManagedObjects;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(RelationDefinitionVisitor<R, P> v, P p) {
return v.visitSet(this, p);
@@ -197,9 +197,7 @@
return ManagedObjectDefinitionI18NResource.getInstance().getMessage(getParentDefinition(), property, locale);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void toString(StringBuilder builder) {
builder.append("name=");
@@ -210,9 +208,7 @@
builder.append(getChildDefinition().getName());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected void initialize() throws Exception {
for (DefaultManagedObject<?, ?> dmo : defaultManagedObjects.values()) {
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/SingletonRelationDefinition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/SingletonRelationDefinition.java
index d898b9e..4970d80 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/SingletonRelationDefinition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/SingletonRelationDefinition.java
@@ -55,8 +55,10 @@
public static final class Builder<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 = null;
/**
@@ -88,9 +90,7 @@
this.defaultManagedObject = defaultManagedObject;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected SingletonRelationDefinition<C, S> buildInstance(Common<C, S> common) {
return new SingletonRelationDefinition<C, S>(common, defaultManagedObject);
@@ -98,20 +98,20 @@
}
- // 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);
this.defaultManagedObject = defaultManagedObject;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(RelationDefinitionVisitor<R, P> v, P p) {
return v.visitSingleton(this, p);
@@ -129,9 +129,7 @@
return defaultManagedObject;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void toString(StringBuilder builder) {
builder.append("name=");
@@ -142,9 +140,7 @@
builder.append(getChildDefinition().getName());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected void initialize() throws Exception {
if (defaultManagedObject != null) {
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/SizePropertyDefinition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/SizePropertyDefinition.java
index 0e38cb9..f7f3dc0 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/SizePropertyDefinition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/SizePropertyDefinition.java
@@ -41,17 +41,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;
/**
@@ -60,18 +62,19 @@
*/
public static final 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 = 0L;
- // The optional upper limit of the property value in bytes.
+ /** The optional upper limit of the property value in bytes. */
private Long upperLimit = null;
- // 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 = false;
- // Private constructor
+ /** Private constructor. */
private Builder(AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
super(d, propertyName);
}
@@ -160,9 +163,7 @@
this.allowUnlimited = allowUnlimited;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected SizePropertyDefinition buildInstance(AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options, AdministratorAction adminAction,
@@ -187,7 +188,7 @@
return new Builder(d, propertyName);
}
- // Private constructor.
+ /** Private constructor. */
private SizePropertyDefinition(AbstractManagedObjectDefinition<?, ?> d, String propertyName,
EnumSet<PropertyOption> options, AdministratorAction adminAction,
DefaultBehaviorProvider<Long> defaultBehavior, Long lowerLimit, Long upperLimit, boolean allowUnlimited) {
@@ -226,9 +227,7 @@
return allowUnlimited;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(Long value) {
Reject.ifNull(value);
@@ -246,9 +245,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String encodeValue(Long value) {
Reject.ifNull(value);
@@ -272,9 +269,7 @@
return builder.toString();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Long decodeValue(String value) {
Reject.ifNull(value);
@@ -302,25 +297,19 @@
return i;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitSize(this, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, Long value, P p) {
return v.visitSize(this, value, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void toString(StringBuilder builder) {
super.toString(builder);
@@ -338,9 +327,7 @@
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compare(Long o1, Long o2) {
return o1.compareTo(o2);
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/SizeUnit.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/SizeUnit.java
index 66253d2..e0a0427 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/SizeUnit.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/SizeUnit.java
@@ -80,7 +80,7 @@
*/
TERA_BYTES((long) 1000 * 1000 * 1000 * 1000, "tb", "terabytes");
- // A lookup table for resolving a unit from its name.
+ /** A lookup table for resolving a unit from its name. */
private static final Map<String, SizeUnit> NAME_TO_UNIT;
static {
NAME_TO_UNIT = new HashMap<String, SizeUnit>();
@@ -269,16 +269,16 @@
return unit.toBytes(d);
}
- // The long name of the unit.
+ /** The long name of the unit. */
private final String longName;
- // The abbreviation of the unit.
+ /** The abbreviation of the unit. */
private final String shortName;
- // The size of the unit in bytes.
+ /** The size of the unit in bytes. */
private final long sz;
- // Private constructor.
+ /** Private constructor. */
private SizeUnit(long sz, String shortName, String longName) {
this.sz = sz;
this.shortName = shortName;
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/StringPropertyDefinition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/StringPropertyDefinition.java
index 8dc7810..7c2f627 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/StringPropertyDefinition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/StringPropertyDefinition.java
@@ -47,18 +47,22 @@
*/
public static final 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 = null;
- // 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 = null;
- // Private constructor
+ /** Private constructor. */
private Builder(AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
super(d, propertyName);
}
@@ -101,9 +105,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected StringPropertyDefinition buildInstance(AbstractManagedObjectDefinition<?, ?> d,
String propertyName, EnumSet<PropertyOption> options, AdministratorAction adminAction,
@@ -128,18 +130,22 @@
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,
DefaultBehaviorProvider<String> defaultBehavior, boolean isCaseInsensitive, Pattern pattern,
@@ -150,25 +156,19 @@
this.patternUsage = patternUsage;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitString(this, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R, P> R accept(PropertyValueVisitor<R, P> v, String value, P p) {
return v.visitString(this, value, p);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String decodeValue(String value) {
Reject.ifNull(value);
@@ -251,9 +251,7 @@
return isCaseInsensitive;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String normalizeValue(String value) {
Reject.ifNull(value);
@@ -265,9 +263,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void validateValue(String value) {
Reject.ifNull(value);
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/TopCfgDefn.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/TopCfgDefn.java
index a9d65cf..578a41e 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/TopCfgDefn.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/TopCfgDefn.java
@@ -42,7 +42,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-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/UndefinedDefaultBehaviorProvider.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/UndefinedDefaultBehaviorProvider.java
index 31bdfb9..ede2a27 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/UndefinedDefaultBehaviorProvider.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/UndefinedDefaultBehaviorProvider.java
@@ -43,9 +43,7 @@
// No implementation required.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <R, P> R accept(DefaultBehaviorProviderVisitor<T, R, P> v, P p) {
return v.visitUndefined(this, p);
}
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/ManagedObjectDecodingException.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/ManagedObjectDecodingException.java
index 39e418d..7f32fc2 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/ManagedObjectDecodingException.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/ManagedObjectDecodingException.java
@@ -49,7 +49,7 @@
*/
private static final long serialVersionUID = -4268510652395945357L;
- // Create the message.
+ /** Create the message. */
private static LocalizableMessage createMessage(ManagedObject<?> partialManagedObject,
Collection<PropertyException> causes) {
Reject.ifNull(causes);
@@ -75,10 +75,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-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/MissingMandatoryPropertiesException.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/MissingMandatoryPropertiesException.java
index 25c3df3..5483167 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/MissingMandatoryPropertiesException.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/MissingMandatoryPropertiesException.java
@@ -48,7 +48,7 @@
*/
private static final long serialVersionUID = 6342522125252055588L;
- // Create the message.
+ /** Create the message. */
private static LocalizableMessage createMessage(Collection<PropertyException> causes) {
Reject.ifNull(causes);
Reject.ifFalse(!causes.isEmpty(), "causes should not be empty");
@@ -72,15 +72,19 @@
}
}
- // 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-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/OperationRejectedException.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/OperationRejectedException.java
index 5ff7868..9038325 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/OperationRejectedException.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/OperationRejectedException.java
@@ -73,7 +73,7 @@
*/
private static final long serialVersionUID = 8547688890613079044L;
- // Gets the default message.
+ /** Gets the default message. */
private static LocalizableMessage getDefaultMessage(Collection<LocalizableMessage> messages) {
Reject.ifNull(messages);
Reject.ifFalse(!messages.isEmpty(), "Messages should not be empty");
@@ -85,7 +85,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();
@@ -105,14 +105,16 @@
}
}
- // 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-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/ldap/DNBuilder.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/ldap/DNBuilder.java
index c679936..7008f04 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/ldap/DNBuilder.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/ldap/DNBuilder.java
@@ -123,9 +123,7 @@
this.profile = profile;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration> void appendManagedObjectPathElement(
InstantiableRelationDefinition<? super C, ? super S> r,
AbstractManagedObjectDefinition<C, S> d, String name) {
@@ -168,9 +166,7 @@
return rdnsOfDn;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration> void appendManagedObjectPathElement(
OptionalRelationDefinition<? super C, ? super S> r,
AbstractManagedObjectDefinition<C, S> d) {
@@ -178,9 +174,7 @@
appendManagedObjectPathElement(r);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration> void appendManagedObjectPathElement(
SingletonRelationDefinition<? super C, ? super S> r,
AbstractManagedObjectDefinition<C, S> d) {
@@ -188,9 +182,7 @@
appendManagedObjectPathElement(r);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration> void appendManagedObjectPathElement(
SetRelationDefinition<? super C, ? super S> r, AbstractManagedObjectDefinition<C, S> d) {
// Add the RDN sequence representing the relation.
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/ldap/LDAPDriver.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/ldap/LDAPDriver.java
index 07c00ea..62acf30 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/ldap/LDAPDriver.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/ldap/LDAPDriver.java
@@ -105,14 +105,12 @@
return pd.castValue(pd.accept(new ValueDecoder(), s));
}
- // Prevent instantiation.
+ /** Prevent instantiation. */
private ValueDecoder() {
// Do nothing.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <C extends ConfigurationClient, S extends Configuration> Object visitAggregation(
AggregationPropertyDefinition<C, S> d, String p) {
@@ -126,9 +124,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <T> Object visitUnknown(PropertyDefinition<T> d, String p) {
// By default the property definition's decoder will do.
@@ -140,8 +136,10 @@
private final Connection connection;
- // 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;
/**
@@ -162,17 +160,13 @@
this.context = context;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void close() {
connection.close();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <C extends ConfigurationClient, S extends Configuration> ManagedObject<? extends C> getManagedObject(
ManagedObjectPath<C, S> path) throws DefinitionDecodingException, ManagedObjectDecodingException,
@@ -224,9 +218,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@SuppressWarnings("unchecked")
@Override
public <C extends ConfigurationClient, S extends Configuration, P> SortedSet<P> getPropertyValues(
@@ -291,18 +283,14 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ManagedObject<RootCfgClient> getRootConfigurationManagedObject() {
return new LDAPManagedObject<RootCfgClient>(this, RootCfgDefn.getInstance(), ManagedObjectPath.emptyPath(),
new PropertySet(), true, null);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <C extends ConfigurationClient, S extends Configuration> String[] listManagedObjects(
ManagedObjectPath<?, ?> parent, InstantiableRelationDefinition<C, S> rd,
@@ -337,9 +325,7 @@
return children.toArray(new String[children.size()]);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <C extends ConfigurationClient, S extends Configuration> String[] listManagedObjects(
ManagedObjectPath<?, ?> parent, SetRelationDefinition<C, S> rd,
@@ -375,9 +361,7 @@
return children.toArray(new String[children.size()]);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean managedObjectExists(ManagedObjectPath<?, ?> path) throws ManagedObjectNotFoundException,
LdapException {
@@ -395,9 +379,7 @@
return entryExists(dn);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected <C extends ConfigurationClient, S extends Configuration> void deleteManagedObject(
ManagedObjectPath<C, S> path) throws OperationRejectedException, LdapException {
@@ -415,9 +397,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected LDAPManagementContext getManagementContext() {
return context;
@@ -461,7 +441,7 @@
return profile;
}
- // 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, ManagedObjectPath<? super M, ? super N> p, PropertySet properties) {
RelationDefinition<?, ?> rd = p.getRelationDefinition();
@@ -473,7 +453,7 @@
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 <P> void decodeProperty(PropertySet newProperties, ManagedObjectPath<?, ?> path,
PropertyDefinition<P> propertyDef, Attribute attribute) {
PropertyException exception = null;
@@ -556,7 +536,7 @@
return d.resolveManagedObjectDefinition(resolver);
}
- /*
+ /**
* Delete a subtree of entries. We cannot use the subtree delete control because it is not supported by the config
* backend.
*/
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/ldap/LDAPManagedObject.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/ldap/LDAPManagedObject.java
index d3de70b..85dffd1 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/ldap/LDAPManagedObject.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/ldap/LDAPManagedObject.java
@@ -78,14 +78,12 @@
*/
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(
AggregationPropertyDefinition<C, S> pd, String v, Void p) {
@@ -95,16 +93,14 @@
return reference.toDN().toString();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <P> Object visitUnknown(PropertyDefinition<P> propertyDef, P value, Void p) {
return propertyDef.encodeValue(value);
}
}
- // The LDAP management driver associated with this managed object.
+ /** The LDAP management driver associated with this managed object. */
private final LDAPDriver driver;
/**
@@ -131,9 +127,7 @@
this.driver = driver;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected void addNewManagedObject() throws LdapException, OperationRejectedException,
ConcurrentModificationException, ManagedObjectAlreadyExistsException {
@@ -239,17 +233,13 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected Driver getDriver() {
return driver;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected void modifyExistingManagedObject() throws ConcurrentModificationException, OperationRejectedException,
LdapException {
@@ -285,9 +275,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected <M extends ConfigurationClient> ManagedObject<M> newInstance(ManagedObjectDefinition<M, ?> d,
ManagedObjectPath<M, ?> path, PropertySet properties, boolean existsOnServer,
@@ -295,7 +283,7 @@
return new LDAPManagedObject<M>(driver, d, path, properties, existsOnServer, namingPropertyDefinition);
}
- // Encode a property into LDAP string values.
+ /** Encode a property into LDAP string values. */
private <P> void encodeProperty(Attribute attribute, PropertyDefinition<P> propertyDef) {
PropertyValueVisitor<Object, Void> visitor = new ValueEncoder();
Property<P> property = getProperty(propertyDef);
@@ -313,9 +301,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isModified() {
ManagedObjectDefinition<?, ?> d = getManagedObjectDefinition();
for (PropertyDefinition<?> pd : d.getAllPropertyDefinitions()) {
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/spi/AbstractManagedObject.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/spi/AbstractManagedObject.java
index e05bd0c..974c152 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/spi/AbstractManagedObject.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/spi/AbstractManagedObject.java
@@ -81,7 +81,7 @@
*/
private final class DefaultManagedObjectFactory implements RelationDefinitionVisitor<Void, Void> {
- // Possible exceptions.
+ /** Possible exceptions. */
private ManagedObjectAlreadyExistsException moaee = null;
private MissingMandatoryPropertiesException mmpe = null;
@@ -92,9 +92,7 @@
private LdapException ere = null;
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <C extends ConfigurationClient, S extends Configuration> Void visitInstantiable(
InstantiableRelationDefinition<C, S> rd, Void p) {
@@ -113,9 +111,7 @@
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <C extends ConfigurationClient, S extends Configuration> Void visitOptional(
OptionalRelationDefinition<C, S> rd, Void p) {
@@ -128,9 +124,7 @@
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <C extends ConfigurationClient, S extends Configuration> Void visitSingleton(
SingletonRelationDefinition<C, S> rd, Void p) {
@@ -139,9 +133,7 @@
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <C extends ConfigurationClient, S extends Configuration> Void visitSet(SetRelationDefinition<C, S> rd,
Void p) {
@@ -154,7 +146,7 @@
return null;
}
- // Create the child managed object.
+ /** Create the child managed object. */
private void createDefaultManagedObject(ManagedObjectDefinition<?, ?> d, ManagedObject<?> child,
DefaultManagedObject<?, ?> dmo) {
for (PropertyDefinition<?> pd : d.getAllPropertyDefinitions()) {
@@ -201,29 +193,33 @@
}
}
- // Set property values.
+ /** Set property values. */
private <P> void setPropertyValues(ManagedObject<?> mo, PropertyDefinition<P> pd,
DefaultManagedObject<?, ?> dmo) {
mo.setPropertyValues(pd, dmo.getPropertyValues(pd));
}
}
- // 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;
/**
@@ -252,9 +248,7 @@
this.namingPropertyDefinition = namingPropertyDefinition;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final void commit() throws ManagedObjectAlreadyExistsException, MissingMandatoryPropertiesException,
ConcurrentModificationException, OperationRejectedException, LdapException {
@@ -325,9 +319,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final <C extends ConfigurationClient, S extends Configuration, C1 extends C> ManagedObject<C1> createChild(
InstantiableRelationDefinition<C, S> r, ManagedObjectDefinition<C1, ? extends S> d, String name,
@@ -354,9 +346,7 @@
return createNewManagedObject(d, childPath, pd, name, exceptions);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final <C extends ConfigurationClient, S extends Configuration, C1 extends C> ManagedObject<C1> createChild(
OptionalRelationDefinition<C, S> r, ManagedObjectDefinition<C1, ? extends S> d,
@@ -366,9 +356,7 @@
return createNewManagedObject(d, childPath, null, null, exceptions);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final <C extends ConfigurationClient, S extends Configuration, C1 extends C> ManagedObject<C1> createChild(
SetRelationDefinition<C, S> r, ManagedObjectDefinition<C1, ? extends S> d,
@@ -379,9 +367,7 @@
return createNewManagedObject(d, childPath, null, null, exceptions);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final <C extends ConfigurationClient, S extends Configuration> ManagedObject<? extends C> getChild(
InstantiableRelationDefinition<C, S> r, String name) throws DefinitionDecodingException,
@@ -393,9 +379,7 @@
return ctx.getManagedObject(path.child(r, name));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final <C extends ConfigurationClient, S extends Configuration> ManagedObject<? extends C> getChild(
OptionalRelationDefinition<C, S> r) throws DefinitionDecodingException, ManagedObjectDecodingException,
@@ -406,9 +390,7 @@
return ctx.getManagedObject(path.child(r));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final <C extends ConfigurationClient, S extends Configuration> ManagedObject<? extends C> getChild(
SingletonRelationDefinition<C, S> r) throws DefinitionDecodingException, ManagedObjectDecodingException,
@@ -419,9 +401,7 @@
return ctx.getManagedObject(path.child(r));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final <C extends ConfigurationClient, S extends Configuration> ManagedObject<? extends C> getChild(
SetRelationDefinition<C, S> r, String name) throws DefinitionDecodingException,
@@ -445,41 +425,31 @@
return ctx.getManagedObject(path.child(r, cd));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final T getConfiguration() {
return definition.createClientConfiguration(this);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final ManagedObjectDefinition<T, ? extends Configuration> getManagedObjectDefinition() {
return definition;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final ManagedObjectPath<T, ? extends Configuration> getManagedObjectPath() {
return path;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final <P> SortedSet<P> getPropertyDefaultValues(PropertyDefinition<P> pd) {
return new TreeSet<P>(getProperty(pd).getDefaultValues());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final <P> P getPropertyValue(PropertyDefinition<P> pd) {
Set<P> values = getProperty(pd).getEffectiveValues();
@@ -490,17 +460,13 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final <P> SortedSet<P> getPropertyValues(PropertyDefinition<P> pd) {
return new TreeSet<P>(getProperty(pd).getEffectiveValues());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final <C extends ConfigurationClient, S extends Configuration> boolean hasChild(
OptionalRelationDefinition<C, S> r) throws ConcurrentModificationException, LdapException {
@@ -513,26 +479,20 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final boolean isPropertyPresent(PropertyDefinition<?> pd) {
return !getProperty(pd).isEmpty();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final <C extends ConfigurationClient, S extends Configuration> String[] listChildren(
InstantiableRelationDefinition<C, S> r) throws ConcurrentModificationException, LdapException {
return listChildren(r, r.getChildDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final <C extends ConfigurationClient, S extends Configuration> String[] listChildren(
InstantiableRelationDefinition<C, S> r, AbstractManagedObjectDefinition<? extends C, ? extends S> d)
@@ -546,18 +506,14 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final <C extends ConfigurationClient, S extends Configuration> String[] listChildren(
SetRelationDefinition<C, S> r) throws ConcurrentModificationException, LdapException {
return listChildren(r, r.getChildDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final <C extends ConfigurationClient, S extends Configuration> String[] listChildren(
SetRelationDefinition<C, S> r, AbstractManagedObjectDefinition<? extends C, ? extends S> d)
@@ -571,9 +527,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final <C extends ConfigurationClient, S extends Configuration> void removeChild(
InstantiableRelationDefinition<C, S> r, String name) throws ManagedObjectNotFoundException,
@@ -593,9 +547,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final <C extends ConfigurationClient, S extends Configuration> void removeChild(
OptionalRelationDefinition<C, S> r) throws ManagedObjectNotFoundException, OperationRejectedException,
@@ -615,9 +567,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final <C extends ConfigurationClient, S extends Configuration> void removeChild(
SetRelationDefinition<C, S> r, String name) throws ManagedObjectNotFoundException,
@@ -637,9 +587,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final <P> void setPropertyValue(PropertyDefinition<P> pd, P value) {
if (value == null) {
@@ -649,9 +597,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final <P> void setPropertyValues(PropertyDefinition<P> pd, Collection<P> values) {
if (pd.hasOption(PropertyOption.MONITORING)) {
@@ -672,9 +618,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
StringBuilder builder = new StringBuilder();
@@ -788,8 +732,10 @@
ManagedObjectPath<M, ?> path, PropertySet properties, boolean existsOnServer,
PropertyDefinition<?> namingPropertyDefinition);
- // 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, P> ManagedObject<M> createNewManagedObject(
ManagedObjectDefinition<M, ?> d, ManagedObjectPath<M, ?> p, PropertyDefinition<P> namingPropertyDefinition,
String name, Collection<PropertyException> exceptions) {
@@ -814,7 +760,7 @@
return newInstance(d, p, childProperties, false, namingPropertyDefinition);
}
- // Create an empty property.
+ /** Create an empty property. */
private <P> void createProperty(PropertySet properties, ManagedObjectPath<?, ?> p, PropertyDefinition<P> pd) {
try {
Driver context = getDriver();
@@ -827,7 +773,7 @@
}
}
- // Makes sure that this managed object exists.
+ /** Makes sure that this managed object exists. */
private void ensureThisManagedObjectExists() throws ConcurrentModificationException, LdapException {
if (!path.isEmpty()) {
Driver ctx = getDriver();
@@ -842,8 +788,10 @@
}
}
- // 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) {
ManagedObjectDefinition<T, ?> d = getManagedObjectDefinition();
RelationDefinition<?, ?> tmp = d.getRelationDefinition(rd.getName());
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/spi/Driver.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/spi/Driver.java
index 0f6016b..dc37177 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/spi/Driver.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/spi/Driver.java
@@ -83,31 +83,31 @@
*/
private final 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 = null;
- // 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 = null;
- // The next property whose default values were required.
+ /** The next property whose default values were required. */
private PropertyDefinition<T> nextProperty = null;
- // Private constructor.
+ /** Private constructor. */
private DefaultValueFinder(ManagedObjectPath<?, ?> p, boolean isCreate) {
this.firstPath = p;
this.isCreate = isCreate;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Collection<T> visitAbsoluteInherited(AbsoluteInheritedDefaultBehaviorProvider<T> d, Void p) {
try {
@@ -119,17 +119,13 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Collection<T> visitAlias(AliasDefaultBehaviorProvider<T> d, Void p) {
return Collections.emptySet();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Collection<T> visitDefined(DefinedDefaultBehaviorProvider<T> d, Void p) {
Collection<String> stringValues = d.getDefaultValues();
@@ -147,9 +143,7 @@
return values;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Collection<T> visitRelativeInherited(RelativeInheritedDefaultBehaviorProvider<T> d, Void p) {
try {
@@ -161,15 +155,13 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Collection<T> visitUndefined(UndefinedDefaultBehaviorProvider<T> d, Void p) {
return Collections.emptySet();
}
- // 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) {
this.nextPath = p;
this.nextProperty = pd;
@@ -187,7 +179,7 @@
return values;
}
- // Get an inherited property value.
+ /** Get an inherited property value. */
@SuppressWarnings("unchecked")
private Collection<T> getInheritedProperty(ManagedObjectPath<?, ?> target,
AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
@@ -619,9 +611,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, OperationRejectedException,
LdapException {
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/spi/PropertySet.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/spi/PropertySet.java
index 718cd92..ed4a4fa 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/client/spi/PropertySet.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/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;
/**
@@ -97,25 +97,19 @@
activeValues.addAll(pendingValues);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public SortedSet<T> getActiveValues() {
return Collections.unmodifiableSortedSet(activeValues);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public SortedSet<T> getDefaultValues() {
return defaultValues;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public SortedSet<T> getEffectiveValues() {
SortedSet<T> values = getPendingValues();
@@ -127,33 +121,25 @@
return values;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public SortedSet<T> getPendingValues() {
return Collections.unmodifiableSortedSet(pendingValues);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public PropertyDefinition<T> getPropertyDefinition() {
return d;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isEmpty() {
return pendingValues.isEmpty();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isModified() {
if (activeValues.size() == pendingValues.size() && activeValues.containsAll(pendingValues)) {
@@ -173,24 +159,20 @@
pendingValues.addAll(c);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
return getEffectiveValues().toString();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean wasEmpty() {
return activeValues.isEmpty();
}
}
- // The properties.
+ /** The properties. */
private final Map<PropertyDefinition<?>, MyProperty<?>> properties;
/**
@@ -240,9 +222,7 @@
return (Property<T>) properties.get(d);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/ANDCondition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/ANDCondition.java
index 50738e0..bb9df90 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/ANDCondition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/ANDCondition.java
@@ -43,7 +43,7 @@
*/
public final class ANDCondition implements Condition {
- // The list of sub-conditions.
+ /** The list of sub-conditions. */
private final List<Condition> conditions;
/**
@@ -57,9 +57,7 @@
this.conditions = Arrays.asList(conditions);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ManagementContext context, ManagedObject<?> managedObject) throws LdapException {
for (Condition condition : conditions) {
if (!condition.evaluate(context, managedObject)) {
@@ -69,9 +67,7 @@
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ServerManagedObject<?> managedObject) throws ConfigException {
for (Condition condition : conditions) {
if (!condition.evaluate(managedObject)) {
@@ -81,9 +77,7 @@
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void initialize(AbstractManagedObjectDefinition<?, ?> d) throws Exception {
for (Condition condition : conditions) {
condition.initialize(d);
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/Conditions.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/Conditions.java
index 44d9142..458d4fd 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/Conditions.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/Conditions.java
@@ -44,23 +44,17 @@
*/
public static final Condition FALSE = new Condition() {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ManagementContext context, ManagedObject<?> managedObject) throws LdapException {
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ServerManagedObject<?> managedObject) throws ConfigException {
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void initialize(AbstractManagedObjectDefinition<?, ?> d) throws Exception {
// No implementation required.
}
@@ -72,23 +66,17 @@
*/
public static final Condition TRUE = new Condition() {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ManagementContext context, ManagedObject<?> managedObject) throws LdapException {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ServerManagedObject<?> managedObject) throws ConfigException {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void initialize(AbstractManagedObjectDefinition<?, ?> d) throws Exception {
// No implementation required.
}
@@ -184,7 +172,7 @@
return new ORCondition(conditions);
}
- // Prevent instantiation.
+ /** Prevent instantiation. */
private Conditions() {
// No implementation required.
}
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/ContainsCondition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/ContainsCondition.java
index 6c6e1e7..600251c 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/ContainsCondition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/ContainsCondition.java
@@ -51,55 +51,49 @@
*/
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) {
this.pd = pd;
this.value = value;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ManagementContext context, ManagedObject<?> managedObject) throws LdapException {
SortedSet<T> values = managedObject.getPropertyValues(pd);
return values.contains(value);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ServerManagedObject<?> managedObject) throws ConfigException {
SortedSet<T> values = managedObject.getPropertyValues(pd);
return values.contains(value);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void initialize(AbstractManagedObjectDefinition<?, ?> d) throws Exception {
// Not used.
}
- // 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 = null;
- // 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;
/**
@@ -116,16 +110,12 @@
this.propertyStringValue = stringValue;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ManagementContext context, ManagedObject<?> managedObject) throws LdapException {
return impl.evaluate(context, managedObject);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ServerManagedObject<?> managedObject) throws ConfigException {
return impl.evaluate(managedObject);
}
@@ -141,15 +131,13 @@
impl.setPropertyValue(managedObject);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void initialize(AbstractManagedObjectDefinition<?, ?> d) throws Exception {
// Decode the property.
buildImpl(d.getPropertyDefinition(propertyName));
}
- // Creates the new private implementation.
+ /** Creates the new private implementation. */
private <T> void buildImpl(PropertyDefinition<T> pd) {
T value = pd.decodeValue(propertyStringValue);
this.impl = new Impl<T>(pd, value);
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/IsPresentCondition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/IsPresentCondition.java
index bcf1ea7..a07e2d2 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/IsPresentCondition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/IsPresentCondition.java
@@ -43,10 +43,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;
/**
@@ -60,25 +60,19 @@
this.propertyName = propertyName;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ManagementContext context, ManagedObject<?> managedObject) throws LdapException {
SortedSet<?> values = managedObject.getPropertyValues(pd);
return !values.isEmpty();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ServerManagedObject<?> managedObject) throws ConfigException {
SortedSet<?> values = managedObject.getPropertyValues(pd);
return !values.isEmpty();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void initialize(AbstractManagedObjectDefinition<?, ?> d) throws Exception {
// Decode the property.
this.pd = d.getPropertyDefinition(propertyName);
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/NOTCondition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/NOTCondition.java
index 2bf44cf..b3f3bdb 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/NOTCondition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/NOTCondition.java
@@ -41,7 +41,7 @@
*/
public final class NOTCondition implements Condition {
- // The single sub-condition.
+ /** The single sub-condition. */
private final Condition condition;
/**
@@ -55,23 +55,17 @@
this.condition = condition;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ManagementContext context, ManagedObject<?> managedObject) throws LdapException {
return !condition.evaluate(context, managedObject);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ServerManagedObject<?> managedObject) throws ConfigException {
return !condition.evaluate(managedObject);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void initialize(AbstractManagedObjectDefinition<?, ?> d) throws Exception {
condition.initialize(d);
}
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/ORCondition.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/ORCondition.java
index 7daf327..a5f6a1b 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/ORCondition.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/conditions/ORCondition.java
@@ -43,7 +43,7 @@
*/
public final class ORCondition implements Condition {
- // The list of sub-conditions.
+ /** The list of sub-conditions. */
private final List<Condition> conditions;
/**
@@ -57,9 +57,7 @@
this.conditions = Arrays.asList(conditions);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ManagementContext context, ManagedObject<?> managedObject) throws LdapException {
for (Condition condition : conditions) {
if (condition.evaluate(context, managedObject)) {
@@ -69,9 +67,7 @@
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean evaluate(ServerManagedObject<?> managedObject) throws ConfigException {
for (Condition condition : conditions) {
if (condition.evaluate(managedObject)) {
@@ -81,9 +77,7 @@
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void initialize(AbstractManagedObjectDefinition<?, ?> d) throws Exception {
for (Condition condition : conditions) {
condition.initialize(d);
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/ArgumentExceptionFactory.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/ArgumentExceptionFactory.java
index 2626cd1..19ca82a 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/ArgumentExceptionFactory.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/ArgumentExceptionFactory.java
@@ -556,7 +556,7 @@
return new ClientException(ReturnCode.ERROR_USER_DATA, msg);
}
- // Prevent instantiation.
+ /** Prevent instantiation. */
private ArgumentExceptionFactory() {
// No implementation required.
}
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/GetPropSubCommandHandler.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/GetPropSubCommandHandler.java
index 092d860..0b7d3dd 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/GetPropSubCommandHandler.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/GetPropSubCommandHandler.java
@@ -152,16 +152,16 @@
return new GetPropSubCommandHandler(parser, path.child(r), r);
}
- // The sub-commands naming arguments.
+ /** The sub-commands naming arguments. */
private final List<StringArgument> namingArgs;
- // The path of the managed object.
+ /** The path of the managed object. */
private final ManagedObjectPath<?, ?> path;
- // The sub-command associated with this handler.
+ /** The sub-command associated with this handler. */
private final SubCommand subCommand;
- // Private constructor.
+ /** Private constructor. */
private GetPropSubCommandHandler(SubCommandArgumentParser parser, ManagedObjectPath<?, ?> path,
RelationDefinition<?, ?> r) throws ArgumentException {
this.path = path;
@@ -194,17 +194,13 @@
return path.getRelationDefinition();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public SubCommand getSubCommand() {
return subCommand;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public MenuResult<Integer> run(ConsoleApplication app, LDAPManagementContextFactory factory)
throws ArgumentException, ClientException {
@@ -306,7 +302,7 @@
return MenuResult.success(0);
}
- // Display the set of values associated with a property.
+ /** Display the set of values associated with a property. */
private <T> void displayProperty(final ConsoleApplication app, TableBuilder builder, ManagedObject<?> mo,
PropertyDefinition<T> pd, PropertyValuePrinter valuePrinter) {
SortedSet<T> values = mo.getPropertyValues(pd);
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/PropertyValueEditor.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/PropertyValueEditor.java
index 1ce45f5..fb0e7e0 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/PropertyValueEditor.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/PropertyValueEditor.java
@@ -444,9 +444,7 @@
}
}
- /**
- * /** {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public MenuResult<Void> visitBoolean(BooleanPropertyDefinition d, Void p) {
MenuBuilder<Boolean> builder = new MenuBuilder<Boolean>(app);
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/SubCommandHandler.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/SubCommandHandler.java
index d78d50e..39951b6 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/SubCommandHandler.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/SubCommandHandler.java
@@ -32,7 +32,6 @@
import java.io.PrintStream;
import java.util.ArrayList;
-import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
@@ -126,6 +125,7 @@
private MenuResult<ManagedObject<?>> result;
/** {@inheritDoc} */
+ @Override
public <C extends ConfigurationClient, S extends Configuration> void appendManagedObjectPathElement(
InstantiableRelationDefinition<? super C, ? super S> r, AbstractManagedObjectDefinition<C, S> d,
String name) {
@@ -196,6 +196,7 @@
}
/** {@inheritDoc} */
+ @Override
public <C extends ConfigurationClient, S extends Configuration> void appendManagedObjectPathElement(
OptionalRelationDefinition<? super C, ? super S> r, AbstractManagedObjectDefinition<C, S> d) {
if (result.isSuccess()) {
@@ -234,6 +235,7 @@
}
/** {@inheritDoc} */
+ @Override
public <C extends ConfigurationClient, S extends Configuration> void appendManagedObjectPathElement(
SetRelationDefinition<? super C, ? super S> r, AbstractManagedObjectDefinition<C, S> d) {
if (result.isSuccess()) {
@@ -318,6 +320,7 @@
}
/** {@inheritDoc} */
+ @Override
public <C extends ConfigurationClient, S extends Configuration> void appendManagedObjectPathElement(
SingletonRelationDefinition<? super C, ? super S> r, AbstractManagedObjectDefinition<C, S> d) {
if (result.isSuccess()) {
@@ -400,6 +403,7 @@
this.dde = null;
this.mode = null;
this.monfe = null;
+ this.ere = null;
path.serialize(this);
@@ -429,7 +433,7 @@
/**
* A path serializer which is used to register a sub-command's naming arguments.
*/
- protected static final class NamingArgumentBuilder implements ManagedObjectPathSerializer {
+ private static final class NamingArgumentBuilder implements ManagedObjectPathSerializer {
/**
* Creates the naming arguments for a given path.
@@ -445,8 +449,8 @@
* @throws ArgumentException
* If one or more naming arguments could not be registered.
*/
- public static List<StringArgument> create(SubCommand subCommand, ManagedObjectPath<?, ?> path, boolean isCreate)
- throws ArgumentException {
+ private static List<StringArgument> create(SubCommand subCommand, ManagedObjectPath<?, ?> path,
+ boolean isCreate) throws ArgumentException {
NamingArgumentBuilder builder = new NamingArgumentBuilder(subCommand, path.size(), isCreate);
path.serialize(builder);
@@ -485,6 +489,7 @@
}
/** {@inheritDoc} */
+ @Override
public <C extends ConfigurationClient, S extends Configuration> void appendManagedObjectPathElement(
InstantiableRelationDefinition<? super C, ? super S> r, AbstractManagedObjectDefinition<C, S> d,
String name) {
@@ -523,12 +528,14 @@
}
/** {@inheritDoc} */
+ @Override
public <C extends ConfigurationClient, S extends Configuration> void appendManagedObjectPathElement(
OptionalRelationDefinition<? super C, ? super S> r, AbstractManagedObjectDefinition<C, S> d) {
sz--;
}
/** {@inheritDoc} */
+ @Override
public <C extends ConfigurationClient, S extends Configuration> void appendManagedObjectPathElement(
SetRelationDefinition<? super C, ? super S> r, AbstractManagedObjectDefinition<C, S> d) {
sz--;
@@ -553,6 +560,7 @@
}
/** {@inheritDoc} */
+ @Override
public <C extends ConfigurationClient, S extends Configuration> void appendManagedObjectPathElement(
SingletonRelationDefinition<? super C, ? super S> r, AbstractManagedObjectDefinition<C, S> d) {
sz--;
@@ -639,6 +647,7 @@
}
/** {@inheritDoc} */
+ @Override
public final int compareTo(SubCommandHandler o) {
String s1 = getSubCommand().getName();
String s2 = o.getSubCommand().getName();
@@ -758,16 +767,6 @@
}
/**
- * Adds one or more tags to this sub-command handler.
- *
- * @param tags
- * The tags to be added to this sub-command handler.
- */
- protected final void addTags(Tag... tags) {
- addTags(Arrays.asList(tags));
- }
-
- /**
* Creates the naming arguments for a given path and registers them.
*
* @param subCommand
@@ -855,9 +854,8 @@
final String value = arg.getValue();
if (value == null && !app.isInteractive()) {
throw ArgumentExceptionFactory.missingMandatoryNonInteractiveArgument(arg);
- } else {
- values.add(value);
}
+ values.add(value);
}
return values;
}
@@ -1209,7 +1207,7 @@
* the type of the property to be retrieved.
* @return the String value to be displayed in the equivalent command-line.
*/
- protected static <T> String castAndGetArgumentValue(PropertyDefinition<T> propertyDefinition, Object o) {
+ static <T> String castAndGetArgumentValue(PropertyDefinition<T> propertyDefinition, Object o) {
return propertyDefinition.encodeValue(propertyDefinition.castValue(o));
}
@@ -1224,7 +1222,7 @@
* the type of the property to be retrieved.
* @return the String value to be displayed in the equivalent command-line.
*/
- protected static <T> String getArgumentValue(PropertyDefinition<T> propertyDefinition, T o) {
+ static <T> String getArgumentValue(PropertyDefinition<T> propertyDefinition, T o) {
return propertyDefinition.encodeValue(o);
}
@@ -1240,7 +1238,7 @@
* The managed object definition.
* @return A mapping of managed object type argument values to their corresponding managed object definitions.
*/
- protected static <C extends ConfigurationClient, S extends Configuration> SortedMap<String,
+ static <C extends ConfigurationClient, S extends Configuration> SortedMap<String,
ManagedObjectDefinition<? extends C, ? extends S>> getSubTypes(
AbstractManagedObjectDefinition<C, S> d) {
SortedMap<String, ManagedObjectDefinition<? extends C, ? extends S>> map;
@@ -1283,7 +1281,7 @@
* The child definition.
* @return The type short name.
*/
- protected static <C extends ConfigurationClient, S extends Configuration> String getShortTypeName(
+ private static <C extends ConfigurationClient, S extends Configuration> String getShortTypeName(
AbstractManagedObjectDefinition<C, S> d, AbstractManagedObjectDefinition<?, ?> c) {
if (c == d) {
// This is the top-level definition, so use the value "generic" or
@@ -1322,7 +1320,7 @@
* The managed object definition.
* @return A usage string representing the list of possible types for the provided managed object definition.
*/
- protected static String getSubTypesUsage(AbstractManagedObjectDefinition<?, ?> d) {
+ static String getSubTypesUsage(AbstractManagedObjectDefinition<?, ?> d) {
// Build the -t option usage.
SortedMap<String, ?> types = getSubTypes(d);
StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigAddListenerAdaptor.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigAddListenerAdaptor.java
index 393ae92..98eb8a0 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigAddListenerAdaptor.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigAddListenerAdaptor.java
@@ -59,22 +59,22 @@
private static final Logger debugLogger = LoggerFactory.getLogger(ConfigAddListenerAdaptor.class);
- // 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;
private final ServerManagementContext serverContext;
@@ -149,9 +149,7 @@
this.cachedManagedObject = null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ConfigChangeResult applyConfigurationAdd(Entry configEntry) {
if (optionalRelation != null) {
// Optional managed objects are located directly beneath the
@@ -186,9 +184,7 @@
return result;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean configAddIsAcceptable(Entry configEntry, LocalizableMessageBuilder unacceptableReason) {
DN dn = configEntry.getName();
String name = dn.rdn().getFirstAVA().getAttributeValue().toString().trim();
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigChangeListenerAdaptor.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigChangeListenerAdaptor.java
index bfd1bcf..4c996d0 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigChangeListenerAdaptor.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigChangeListenerAdaptor.java
@@ -102,17 +102,15 @@
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) {
ManagedObjectPath<?, ?> next = d.getManagedObjectPath();
dependencies.add(DNBuilder.create(next));
@@ -127,23 +125,17 @@
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Void visitAlias(AliasDefaultBehaviorProvider<T> d, ManagedObjectPath<?, ?> p) {
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Void visitDefined(DefinedDefaultBehaviorProvider<T> d, ManagedObjectPath<?, ?> p) {
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Void visitRelativeInherited(RelativeInheritedDefaultBehaviorProvider<T> d, ManagedObjectPath<?, ?> p) {
ManagedObjectPath<?, ?> next = d.getManagedObjectPath(p);
dependencies.add(DNBuilder.create(next));
@@ -158,9 +150,7 @@
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Void visitUndefined(UndefinedDefaultBehaviorProvider<T> d, ManagedObjectPath<?, ?> p) {
return null;
}
@@ -294,9 +284,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ConfigChangeResult applyConfigurationChange(Entry configEntry) {
// Looking at the ConfigFileHandler implementation reveals
// that this ConfigEntry will actually be a different object to
@@ -324,9 +312,7 @@
return result;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean configChangeIsAcceptable(Entry configEntry, LocalizableMessageBuilder unacceptableReason) {
return configChangeIsAcceptable(configEntry, unacceptableReason, configEntry);
}
@@ -408,8 +394,10 @@
return listener;
}
- // 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 Entry getConfigEntry(DN dn) {
try {
if (configRepository.hasEntry(dn)) {
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigChangeResult.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigChangeResult.java
index 965f5ae..9fcb553 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigChangeResult.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigChangeResult.java
@@ -37,17 +37,21 @@
* about the result of processing a configuration change.
*/
public final class ConfigChangeResult {
- // A set of messages describing the changes that were made, any
- // action that may be required, or any problems that were
- // encountered.
+ /**
+ * A set of messages describing the changes that were made, any
+ * action that may be required, or any problems that were encountered.
+ */
private List<LocalizableMessage> messages;
- // Indicates whether one or more of the changes requires
- // administrative action in order to take effect.
+ /**
+ * Indicates whether one or more of the changes requires
+ * administrative action in order to take effect.
+ */
private boolean adminActionRequired;
- // The result code to return to the client from this configuration
- // change.
+ /**
+ * The result code to return to the client from this configuration change.
+ */
private ResultCode resultCode;
/**
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigDeleteListenerAdaptor.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigDeleteListenerAdaptor.java
index becbdff..4ae422e 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigDeleteListenerAdaptor.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigDeleteListenerAdaptor.java
@@ -61,22 +61,22 @@
private static final Logger debugLogger = LoggerFactory.getLogger(ConfigDeleteListenerAdaptor.class);
- // 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;
private final ServerManagementContext serverContext;
@@ -148,9 +148,7 @@
this.cachedManagedObject = null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ConfigChangeResult applyConfigurationDelete(Entry configEntry) {
if (optionalRelation != null) {
@@ -186,9 +184,7 @@
return result;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean configDeleteIsAcceptable(Entry configEntry, LocalizableMessageBuilder unacceptableReason) {
DN dn = configEntry.getName();
String name = dn.rdn().getFirstAVA().getAttributeValue().toString().trim();
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigExceptionFactory.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigExceptionFactory.java
index 17b6624..d54dafd 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigExceptionFactory.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConfigExceptionFactory.java
@@ -38,10 +38,10 @@
*/
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-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConstraintViolationException.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConstraintViolationException.java
index 92b8071..7efd35f 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConstraintViolationException.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ConstraintViolationException.java
@@ -48,10 +48,10 @@
*/
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(), "messages should not be empty");
@@ -63,7 +63,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();
@@ -83,7 +83,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-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/DNBuilder.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/DNBuilder.java
index 2dbecbb..0f76e27 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/DNBuilder.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/DNBuilder.java
@@ -65,7 +65,7 @@
return dn.child(localName);
}
- // Prevent instantiation.
+ /** Prevent instantiation. */
private DNBuilder() {
// No implementation required.
}
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/DelayedConfigAddListener.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/DelayedConfigAddListener.java
index 880dc59..1bd2c0b 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/DelayedConfigAddListener.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/DelayedConfigAddListener.java
@@ -44,20 +44,25 @@
private static final Logger debugLogger = LoggerFactory.getLogger(DelayedConfigAddListener.class);
- // 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;
private final ConfigurationRepository configRepository;
@@ -105,9 +110,7 @@
this.delayedDeleteListener = deleteListener;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ConfigChangeResult applyConfigurationAdd(Entry configEntry) {
if (configEntry.getName().equals(child)) {
@@ -136,9 +139,7 @@
return new ConfigChangeResult(ResultCode.SUCCESS, false);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean configAddIsAcceptable(Entry configEntry, LocalizableMessageBuilder unacceptableReason) {
// Always acceptable.
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObject.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObject.java
index 3714cdc..a9b9b5e 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObject.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObject.java
@@ -966,9 +966,7 @@
registerDeleteListener(baseDN, adaptor);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
StringBuilder builder = new StringBuilder();
@@ -1031,7 +1029,7 @@
this.configDN = configDN;
}
- // Deregister an add listener.
+ /** Deregister an add listener. */
private <M extends Configuration> void deregisterAddListener(DN baseDN, ConfigurationAddListener<M> listener) {
try {
if (configRepository.hasEntry(baseDN)) {
@@ -1059,7 +1057,7 @@
}
}
- // Deregister an add listener.
+ /** Deregister an add listener. */
private <M extends Configuration> void deregisterAddListener(DN baseDN,
ServerManagedObjectAddListener<M> listener) {
try {
@@ -1131,7 +1129,7 @@
return Pair.empty();
}
- // Deregister a delete listener.
+ /** Deregister a delete listener. */
private <M extends Configuration> void deregisterDeleteListener(DN baseDN,
ConfigurationDeleteListener<M> listener) {
try {
@@ -1160,7 +1158,7 @@
}
}
- // Deregister a delete listener.
+ /** Deregister a delete listener. */
private <M extends Configuration> void deregisterDeleteListener(DN baseDN,
ServerManagedObjectDeleteListener<M> listener) {
try {
@@ -1184,7 +1182,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
ConfigException {
if (configRepository.hasEntry(baseDN)) {
@@ -1197,8 +1195,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 currentDN = baseDN.parent();
DN previousDN = currentDN;
@@ -1218,8 +1218,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();
@@ -1270,8 +1272,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 {
DN parentDN = baseDN.parent();
@@ -1322,8 +1326,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();
@@ -1369,8 +1375,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 {
DN parentDN = baseDN.parent();
@@ -1416,7 +1424,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 {
if (configRepository.hasEntry(baseDN)) {
configRepository.registerDeleteListener(baseDN, adaptor);
@@ -1428,8 +1436,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) {
RelationDefinition<?, ?> tmp = definition.getRelationDefinition(rd.getName());
if (tmp != rd) {
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObjectAddListenerAdaptor.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObjectAddListenerAdaptor.java
index 2349060..2029f97 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObjectAddListenerAdaptor.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObjectAddListenerAdaptor.java
@@ -41,7 +41,7 @@
final class ServerManagedObjectAddListenerAdaptor<T extends Configuration> implements
ServerManagedObjectAddListener<T> {
- // The underlying add listener.
+ /** The underlying add listener. */
private final ConfigurationAddListener<T> listener;
/**
@@ -54,9 +54,7 @@
this.listener = listener;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ConfigChangeResult applyConfigurationAdd(ServerManagedObject<? extends T> mo) {
return listener.applyConfigurationAdd(mo.getConfiguration());
}
@@ -71,9 +69,7 @@
return listener;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isConfigurationAddAcceptable(ServerManagedObject<? extends T> mo,
List<LocalizableMessage> unacceptableReasons) {
return listener.isConfigurationAddAcceptable(mo.getConfiguration(), unacceptableReasons);
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObjectChangeListenerAdaptor.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObjectChangeListenerAdaptor.java
index 5227598..dcdcca5 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObjectChangeListenerAdaptor.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObjectChangeListenerAdaptor.java
@@ -41,7 +41,7 @@
final class ServerManagedObjectChangeListenerAdaptor<T extends Configuration> implements
ServerManagedObjectChangeListener<T> {
- // The underlying change listener.
+ /** The underlying change listener. */
private final ConfigurationChangeListener<? super T> listener;
/**
@@ -54,9 +54,7 @@
this.listener = listener;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ConfigChangeResult applyConfigurationChange(ServerManagedObject<? extends T> mo) {
return listener.applyConfigurationChange(mo.getConfiguration());
@@ -72,9 +70,7 @@
return listener;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isConfigurationChangeAcceptable(ServerManagedObject<? extends T> mo,
List<LocalizableMessage> unacceptableReasons) {
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObjectDecodingException.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObjectDecodingException.java
index 48df7b7..e807c5c 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObjectDecodingException.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObjectDecodingException.java
@@ -50,7 +50,7 @@
*/
private static final long serialVersionUID = 1598401431084729853L;
- // Create the message.
+ /** Create the message. */
private static LocalizableMessage createMessage(ServerManagedObject<?> partialManagedObject,
Collection<PropertyException> causes) {
Reject.ifNull(causes);
@@ -76,10 +76,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-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObjectDeleteListenerAdaptor.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObjectDeleteListenerAdaptor.java
index 529c8fb..8633c07 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObjectDeleteListenerAdaptor.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagedObjectDeleteListenerAdaptor.java
@@ -41,7 +41,7 @@
final class ServerManagedObjectDeleteListenerAdaptor<T extends Configuration> implements
ServerManagedObjectDeleteListener<T> {
- // The underlying delete listener.
+ /** The underlying delete listener. */
private final ConfigurationDeleteListener<T> listener;
/**
@@ -54,9 +54,7 @@
this.listener = listener;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ConfigChangeResult applyConfigurationDelete(ServerManagedObject<? extends T> mo) {
return listener.applyConfigurationDelete(mo.getConfiguration());
}
@@ -71,9 +69,7 @@
return listener;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isConfigurationDeleteAcceptable(ServerManagedObject<? extends T> mo,
List<LocalizableMessage> unacceptableReasons) {
return listener.isConfigurationDeleteAcceptable(mo.getConfiguration(), unacceptableReasons);
diff --git a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagementContext.java b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagementContext.java
index c854f3b..529edaf 100644
--- a/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagementContext.java
+++ b/opendj-sdk/opendj-config/src/main/java/org/forgerock/opendj/config/server/ServerManagementContext.java
@@ -94,28 +94,30 @@
*/
private final 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 = null;
- // 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 Entry newConfigEntry;
- // The path of the managed object containing the next property.
+ /** The path of the managed object containing the next property. */
private ManagedObjectPath<?, ?> nextPath = null;
- // The next property whose default values were required.
+ /** The next property whose default values were required. */
private PropertyDefinition<T> nextProperty = null;
- // Private constructor.
+ /** Private constructor. */
private DefaultValueFinder(Entry newConfigEntry) {
this.newConfigEntry = newConfigEntry;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<T> visitAbsoluteInherited(AbsoluteInheritedDefaultBehaviorProvider<T> d, Void p) {
try {
return getInheritedProperty(d.getManagedObjectPath(), d.getManagedObjectDefinition(),
@@ -126,16 +128,12 @@
}
}
- /**
- * {@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();
List<T> values = new ArrayList<T>(stringValues.size());
@@ -152,9 +150,7 @@
return values;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<T> visitRelativeInherited(RelativeInheritedDefaultBehaviorProvider<T> d, Void p) {
try {
return getInheritedProperty(d.getManagedObjectPath(nextPath), d.getManagedObjectDefinition(),
@@ -165,14 +161,12 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<T> visitUndefined(UndefinedDefaultBehaviorProvider<T> d, Void p) {
return Collections.emptySet();
}
- // Find the default values for the next path/property.
+ /** Find the default values for the next path/property. */
private Collection<T> find(ManagedObjectPath<?, ?> path, PropertyDefinition<T> propertyDef) {
nextPath = path;
nextProperty = propertyDef;
@@ -190,7 +184,7 @@
return values;
}
- // Get an inherited property value.
+ /** Get an inherited property value. */
@SuppressWarnings("unchecked")
private Collection<T> getInheritedProperty(ManagedObjectPath<?, ?> target,
AbstractManagedObjectDefinition<?, ?> definition, String propertyName) {
@@ -258,17 +252,15 @@
*/
private static final class MyDefinitionResolver implements DefinitionResolver {
- // The config entry.
+ /** The config entry. */
private final Entry entry;
- // Private constructor.
+ /** Private constructor. */
private MyDefinitionResolver(Entry entry) {
this.entry = entry;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean matches(AbstractManagedObjectDefinition<?, ?> d) {
String oc = LDAPProfile.getInstance().getObjectClass(d);
// TODO : use the schema to get object class and check it in the entry
@@ -306,14 +298,12 @@
return propertyDef.castValue(propertyDef.accept(new ValueDecoder(), value));
}
- // Prevent instantiation.
+ /** Prevent instantiation. */
private ValueDecoder() {
// Do nothing.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <C extends ConfigurationClient, S extends Configuration> Object visitAggregation(
AggregationPropertyDefinition<C, S> d, String p) {
@@ -327,9 +317,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <T> Object visitUnknown(PropertyDefinition<T> d, String p) {
// By default the property definition's decoder will do.
@@ -681,7 +669,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, ManagedObjectDefinition<C, S> d,
Map<PropertyDefinition<?>, SortedSet<?>> properties, DN configDN) {
@@ -753,7 +741,7 @@
return values;
}
- // 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,
Entry newConfigEntry) {
DefaultValueFinder<T> v = new DefaultValueFinder<T>(newConfigEntry);
@@ -782,8 +770,10 @@
return configRepository;
}
- // 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 Entry getManagedObjectConfigEntry(DN dn) throws ConfigException {
Entry configEntry;
try {
@@ -806,7 +796,7 @@
return configEntry;
}
- // 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) {
AbstractManagedObjectDefinition<?, ?> d = path.getManagedObjectDefinition();
RelationDefinition<?, ?> tmp = d.getRelationDefinition(rd.getName());
diff --git a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/AdminTestCase.java b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/AdminTestCase.java
index b9eba52..17a552b 100644
--- a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/AdminTestCase.java
+++ b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/AdminTestCase.java
@@ -55,12 +55,12 @@
return configRepository;
}
- /** Returns the name used for the provided entry (the value of the cn attribute) */
+ /** Returns the name used for the provided entry (the value of the cn attribute). */
protected final String entryName(final Entry entry) {
return entry.getName().rdn().getFirstAVA().getAttributeValue().toString();
}
- /** Gets the named parent configuration corresponding to the provided entry */
+ /** Gets the named parent configuration corresponding to the provided entry. */
protected final TestParentCfg getParentCfg(final Entry entry, final ServerManagementContext serverContext)
throws Exception {
return getParentCfg(entryName(entry), serverContext);
diff --git a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/AttributeTypePropertyDefinitionTest.java b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/AttributeTypePropertyDefinitionTest.java
index c1d4141..a8e692d 100644
--- a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/AttributeTypePropertyDefinitionTest.java
+++ b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/AttributeTypePropertyDefinitionTest.java
@@ -83,7 +83,7 @@
assertEquals(type.getNameOrOID(), value);
}
- // Create a new definition.
+ /** Create a new definition. */
private AttributeTypePropertyDefinition createPropertyDefinition() {
AttributeTypePropertyDefinition.Builder builder = AttributeTypePropertyDefinition.createBuilder(
RootCfgDefn.getInstance(), "test-property");
diff --git a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/ClassPropertyDefinitionTest.java b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/ClassPropertyDefinitionTest.java
index 5ca63c5..f02d773 100644
--- a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/ClassPropertyDefinitionTest.java
+++ b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/ClassPropertyDefinitionTest.java
@@ -40,7 +40,7 @@
@SuppressWarnings("javadoc")
public class ClassPropertyDefinitionTest extends ConfigTestCase {
- // Dummy class used in tests.
+ /** Dummy class used in tests. */
public static final class Dummy {
public class X {
// no implementation
diff --git a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/DurationPropertyDefinitionTest.java b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/DurationPropertyDefinitionTest.java
index 7d897f5..f444c9a 100644
--- a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/DurationPropertyDefinitionTest.java
+++ b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/DurationPropertyDefinitionTest.java
@@ -44,7 +44,7 @@
}
/**
- * Creates data for testing string-based limit values
+ * Creates data for testing string-based limit values.
*
* @return data
*/
@@ -56,7 +56,7 @@
}
/**
- * Creates data for testing limit values
+ * Creates data for testing limit values.
*
* @return data
*/
@@ -213,7 +213,7 @@
assertEquals(def.encodeValue(valueToEncode), expectedValue);
}
- /** Test that accept doesn't throw and exception */
+ /** Test that accept doesn't throw and exception. */
@Test
public void testAccept() {
DurationPropertyDefinition.Builder builder = createTestBuilder();
@@ -232,7 +232,7 @@
assertEquals((boolean) def.accept(v, null), true);
}
- /** Make sure toString doesn't barf */
+ /** Make sure toString doesn't barf. */
@Test
public void testToString() {
DurationPropertyDefinition.Builder builder = createTestBuilder();
@@ -241,7 +241,7 @@
def.toString();
}
- /** Make sure toString doesn't barf */
+ /** Make sure toString doesn't barf. */
@Test
public void testToString2() {
DurationPropertyDefinition.Builder builder = createTestBuilder();
diff --git a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/EnumPropertyDefinitionTest.java b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/EnumPropertyDefinitionTest.java
index ac48f49..c9ca475 100644
--- a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/EnumPropertyDefinitionTest.java
+++ b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/EnumPropertyDefinitionTest.java
@@ -55,7 +55,7 @@
}
/**
- * Tests that exception thrown when no enum class specified by builder
+ * Tests that exception thrown when no enum class specified by builder.
*/
@Test
public void testBuildInstance() {
@@ -64,7 +64,7 @@
}
/**
- * Tests that exception thrown when no enum class specified by builder
+ * Tests that exception thrown when no enum class specified by builder.
*/
@Test(expectedExceptions = { IllegalStateException.class })
public void testBuildInstanceWithoutEnumClassSpecified() {
@@ -74,7 +74,7 @@
}
/**
- * Creates data decodeValue test
+ * Creates data decodeValue test.
*
* @return data
*/
@@ -84,7 +84,7 @@
}
/**
- * Tests decodeValue()
+ * Tests decodeValue().
*
* @param value
* to decode
@@ -98,7 +98,7 @@
}
/**
- * Creates illegal data for decode value test
+ * Creates illegal data for decode value test.
*
* @return data
*/
@@ -108,7 +108,7 @@
}
/**
- * Tests decodeValue()
+ * Tests decodeValue().
*
* @param value
* to decode
@@ -120,18 +120,14 @@
def.decodeValue(value);
}
- /**
- * Tests normalization
- */
+ /** Tests normalization. */
@Test
public void testNormalizeValue() {
EnumPropertyDefinition<TestEnum> def = builder.getInstance();
assertEquals(def.normalizeValue(TestEnum.ONE), "one");
}
- /**
- * Tests validation
- */
+ /** Tests validation. */
@Test
public void testValidateValue() {
EnumPropertyDefinition<TestEnum> def = builder.getInstance();
diff --git a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/LDAPProfileTest.java b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/LDAPProfileTest.java
index bcfd343..aef8ebd 100644
--- a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/LDAPProfileTest.java
+++ b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/LDAPProfileTest.java
@@ -35,7 +35,7 @@
@SuppressWarnings("javadoc")
public class LDAPProfileTest extends ConfigTestCase {
- /** Makes sure the returned list contains "top" */
+ /** Makes sure the returned list contains "top". */
@Test
public void testGetObjectClasses() {
LDAPProfile ldapProfile = LDAPProfile.getInstance();
diff --git a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/MockLDAPProfile.java b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/MockLDAPProfile.java
index 30afa19..04e5114 100644
--- a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/MockLDAPProfile.java
+++ b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/MockLDAPProfile.java
@@ -38,9 +38,7 @@
// No implementation required.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getAttributeName(AbstractManagedObjectDefinition<?, ?> d, PropertyDefinition<?> pd) {
@@ -82,22 +80,17 @@
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getRelationChildRDNType(InstantiableRelationDefinition<?, ?> r) {
if (r == TestCfg.getTestOneToManyParentRelationDefinition()
|| r == TestParentCfgDefn.getInstance().getTestChildrenRelationDefinition()) {
return "cn";
- } else {
- return null;
}
+ return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getObjectClass(AbstractManagedObjectDefinition<?, ?> d) {
if (d == TestParentCfgDefn.getInstance()) {
@@ -110,9 +103,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getRelationRDNSequence(RelationDefinition<?, ?> r) {
if (r == TestCfg.getTestOneToManyParentRelationDefinition()) {
diff --git a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/StringPropertyDefinitionTest.java b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/StringPropertyDefinitionTest.java
index a1dd324..2843f02 100644
--- a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/StringPropertyDefinitionTest.java
+++ b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/StringPropertyDefinitionTest.java
@@ -65,7 +65,7 @@
d.decodeValue("abc123");
}
- // Create a string property definition.
+ /** Create a string property definition. */
private StringPropertyDefinition getDefinition(boolean isCaseInsensitive, String pattern) {
StringPropertyDefinition.Builder builder = StringPropertyDefinition.createBuilder(RootCfgDefn.getInstance(),
"test-property");
diff --git a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/TestCfg.java b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/TestCfg.java
index 8f29f68..184e0ca 100644
--- a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/TestCfg.java
+++ b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/TestCfg.java
@@ -48,7 +48,7 @@
RD_TEST_ONE_TO_ZERO_OR_ONE_PARENT;
// @Checkstyle:on
- // Create a one-to-many relation for test-parent components.
+ /** Create a one-to-many relation for test-parent components. */
static {
InstantiableRelationDefinition.Builder<TestParentCfgClient, TestParentCfg> builder =
new InstantiableRelationDefinition.Builder<TestParentCfgClient, TestParentCfg>(
@@ -57,7 +57,7 @@
RD_TEST_ONE_TO_MANY_PARENT = builder.getInstance();
}
- // Create a one-to-many relation for test-parent components.
+ /** Create a one-to-many relation for test-parent components. */
static {
OptionalRelationDefinition.Builder<TestParentCfgClient, TestParentCfg> builder =
new OptionalRelationDefinition.Builder<TestParentCfgClient, TestParentCfg>(
@@ -187,7 +187,7 @@
TestChildCfgDefn.getInstance().deregisterConstraint(constraint);
}
- // Prevent instantiation.
+ /** Prevent instantiation. */
private TestCfg() {
// No implementation required.
}
diff --git a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/TestChildCfgDefn.java b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/TestChildCfgDefn.java
index a83eeca..0a880de 100644
--- a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/TestChildCfgDefn.java
+++ b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/TestChildCfgDefn.java
@@ -50,31 +50,30 @@
*/
public final class TestChildCfgDefn extends ManagedObjectDefinition<TestChildCfgClient, TestChildCfg> {
- // The singleton configuration definition instance.
+ /** The singleton configuration definition instance. */
private static final TestChildCfgDefn INSTANCE = new TestChildCfgDefn();
- // The "aggregation-property" property definition.
// @Checkstyle:off
+ /** The "aggregation-property" property definition. */
private static final AggregationPropertyDefinition<ConnectionHandlerCfgClient, ConnectionHandlerCfg>
PROPDEF_AGGREGATION_PROPERTY;
// @Checkstyle:on
-
- // The "mandatory-boolean-property" property definition.
+ /** The "mandatory-boolean-property" property definition. */
private static final BooleanPropertyDefinition PROPDEF_MANDATORY_BOOLEAN_PROPERTY;
- // The "mandatory-class-property" property definition.
+ /** The "mandatory-class-property" property definition. */
private static final ClassPropertyDefinition PROPDEF_MANDATORY_CLASS_PROPERTY;
- // The "mandatory-read-only-attribute-type-property" property definition.
+ /** The "mandatory-read-only-attribute-type-property" property definition. */
private static final AttributeTypePropertyDefinition PROPDEF_MANDATORY_READ_ONLY_ATTRIBUTE_TYPE_PROPERTY;
- // The "optional-multi-valued-dn-property1" property definition.
+ /** The "optional-multi-valued-dn-property1" property definition. */
private static final DNPropertyDefinition PROPDEF_OPTIONAL_MULTI_VALUED_DN_PROPERTY1;
- // The "optional-multi-valued-dn-property2" property definition.
+ /** The "optional-multi-valued-dn-property2" property definition. */
private static final DNPropertyDefinition PROPDEF_OPTIONAL_MULTI_VALUED_DN_PROPERTY2;
- // Build the "aggregation-property" property definition.
+ /** Build the "aggregation-property" property definition. */
static {
AggregationPropertyDefinition.Builder<ConnectionHandlerCfgClient, ConnectionHandlerCfg> builder =
AggregationPropertyDefinition.createBuilder(INSTANCE, "aggregation-property");
@@ -89,7 +88,7 @@
INSTANCE.registerConstraint(PROPDEF_AGGREGATION_PROPERTY.getSourceConstraint());
}
- // Build the "mandatory-boolean-property" property definition.
+ /** Build the "mandatory-boolean-property" property definition. */
static {
BooleanPropertyDefinition.Builder builder = BooleanPropertyDefinition.createBuilder(INSTANCE,
"mandatory-boolean-property");
@@ -101,7 +100,7 @@
INSTANCE.registerPropertyDefinition(PROPDEF_MANDATORY_BOOLEAN_PROPERTY);
}
- // Build the "mandatory-class-property" property definition.
+ /** Build the "mandatory-class-property" property definition. */
static {
ClassPropertyDefinition.Builder builder = ClassPropertyDefinition.createBuilder(INSTANCE,
"mandatory-class-property");
@@ -116,8 +115,10 @@
INSTANCE.registerPropertyDefinition(PROPDEF_MANDATORY_CLASS_PROPERTY);
}
- // Build the "mandatory-read-only-attribute-type-property" property
- // definition.
+ /**
+ * Build the "mandatory-read-only-attribute-type-property" property
+ * definition.
+ */
static {
AttributeTypePropertyDefinition.Builder builder = AttributeTypePropertyDefinition.createBuilder(INSTANCE,
"mandatory-read-only-attribute-type-property");
@@ -130,7 +131,7 @@
INSTANCE.registerPropertyDefinition(PROPDEF_MANDATORY_READ_ONLY_ATTRIBUTE_TYPE_PROPERTY);
}
- // Build the "optional-multi-valued-dn-property1" property definition.
+ /** Build the "optional-multi-valued-dn-property1" property definition. */
static {
DNPropertyDefinition.Builder builder = DNPropertyDefinition.createBuilder(INSTANCE,
"optional-multi-valued-dn-property1");
@@ -144,7 +145,7 @@
INSTANCE.registerPropertyDefinition(PROPDEF_OPTIONAL_MULTI_VALUED_DN_PROPERTY1);
}
- // Build the "optional-multi-valued-dn-property2" property definition.
+ /** Build the "optional-multi-valued-dn-property2" property definition. */
static {
DNPropertyDefinition.Builder builder = DNPropertyDefinition.createBuilder(INSTANCE,
"optional-multi-valued-dn-property2");
@@ -174,23 +175,17 @@
super("test-child", null);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public TestChildCfgClient createClientConfiguration(ManagedObject<? extends TestChildCfgClient> impl) {
return new TestChildCfgClientImpl(impl);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public TestChildCfg createServerConfiguration(ServerManagedObject<? extends TestChildCfg> impl) {
return new TestChildCfgServerImpl(impl);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Class<TestChildCfg> getServerConfigurationClass() {
return TestChildCfg.class;
}
@@ -275,115 +270,85 @@
*/
private static class TestChildCfgClientImpl implements TestChildCfgClient {
- // Private implementation.
+ /** Private implementation. */
private ManagedObject<? extends TestChildCfgClient> impl;
- // Private constructor.
+ /** Private constructor. */
private TestChildCfgClientImpl(ManagedObject<? extends TestChildCfgClient> impl) {
this.impl = impl;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public SortedSet<String> getAggregationProperty() {
return impl.getPropertyValues(INSTANCE.getAggregationPropertyPropertyDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void setAggregationProperty(Collection<String> values) {
impl.setPropertyValues(INSTANCE.getAggregationPropertyPropertyDefinition(), values);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Boolean isMandatoryBooleanProperty() {
return impl.getPropertyValue(INSTANCE.getMandatoryBooleanPropertyPropertyDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void setMandatoryBooleanProperty(boolean value) {
impl.setPropertyValue(INSTANCE.getMandatoryBooleanPropertyPropertyDefinition(), value);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getMandatoryClassProperty() {
return impl.getPropertyValue(INSTANCE.getMandatoryClassPropertyPropertyDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void setMandatoryClassProperty(String value) {
impl.setPropertyValue(INSTANCE.getMandatoryClassPropertyPropertyDefinition(), value);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public AttributeType getMandatoryReadOnlyAttributeTypeProperty() {
return impl.getPropertyValue(INSTANCE.getMandatoryReadOnlyAttributeTypePropertyPropertyDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void setMandatoryReadOnlyAttributeTypeProperty(AttributeType value) throws PropertyException {
impl.setPropertyValue(INSTANCE.getMandatoryReadOnlyAttributeTypePropertyPropertyDefinition(), value);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public SortedSet<DN> getOptionalMultiValuedDNProperty1() {
return impl.getPropertyValues(INSTANCE.getOptionalMultiValuedDNProperty1PropertyDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void setOptionalMultiValuedDNProperty1(Collection<DN> values) {
impl.setPropertyValues(INSTANCE.getOptionalMultiValuedDNProperty1PropertyDefinition(), values);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public SortedSet<DN> getOptionalMultiValuedDNProperty2() {
return impl.getPropertyValues(INSTANCE.getOptionalMultiValuedDNProperty2PropertyDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void setOptionalMultiValuedDNProperty2(Collection<DN> values) {
impl.setPropertyValues(INSTANCE.getOptionalMultiValuedDNProperty2PropertyDefinition(), values);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ManagedObjectDefinition<? extends TestChildCfgClient, ? extends TestChildCfg> definition() {
return INSTANCE;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public PropertyProvider properties() {
return impl;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void commit() throws ManagedObjectAlreadyExistsException, MissingMandatoryPropertiesException,
ConcurrentModificationException, OperationRejectedException, LdapException {
impl.commit();
@@ -396,80 +361,60 @@
*/
private static class TestChildCfgServerImpl implements TestChildCfg {
- // Private implementation.
+ /** Private implementation. */
private ServerManagedObject<? extends TestChildCfg> impl;
- // Private constructor.
+ /** Private constructor. */
private TestChildCfgServerImpl(ServerManagedObject<? extends TestChildCfg> impl) {
this.impl = impl;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void addChangeListener(ConfigurationChangeListener<TestChildCfg> listener) {
impl.registerChangeListener(listener);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void removeChangeListener(ConfigurationChangeListener<TestChildCfg> listener) {
impl.deregisterChangeListener(listener);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public SortedSet<String> getAggregationProperty() {
return impl.getPropertyValues(INSTANCE.getAggregationPropertyPropertyDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isMandatoryBooleanProperty() {
return impl.getPropertyValue(INSTANCE.getMandatoryBooleanPropertyPropertyDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getMandatoryClassProperty() {
return impl.getPropertyValue(INSTANCE.getMandatoryClassPropertyPropertyDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public AttributeType getMandatoryReadOnlyAttributeTypeProperty() {
return impl.getPropertyValue(INSTANCE.getMandatoryReadOnlyAttributeTypePropertyPropertyDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public SortedSet<DN> getOptionalMultiValuedDNProperty1() {
return impl.getPropertyValues(INSTANCE.getOptionalMultiValuedDNProperty1PropertyDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public SortedSet<DN> getOptionalMultiValuedDNProperty2() {
return impl.getPropertyValues(INSTANCE.getOptionalMultiValuedDNProperty2PropertyDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Class<? extends TestChildCfg> configurationClass() {
return TestChildCfg.class;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public DN dn() {
return impl.getDN();
}
diff --git a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/TestParentCfgDefn.java b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/TestParentCfgDefn.java
index 1524cc7..fb9eb59 100644
--- a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/TestParentCfgDefn.java
+++ b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/TestParentCfgDefn.java
@@ -53,28 +53,28 @@
*/
public final class TestParentCfgDefn extends ManagedObjectDefinition<TestParentCfgClient, TestParentCfg> {
- // The singleton configuration definition instance.
+ /** The singleton configuration definition instance. */
private static final TestParentCfgDefn INSTANCE = new TestParentCfgDefn();
- // The "mandatory-boolean-property" property definition.
+ /** The "mandatory-boolean-property" property definition. */
private static final BooleanPropertyDefinition PD_MANDATORY_BOOLEAN_PROPERTY;
- // The "mandatory-class-property" property definition.
+ /** The "mandatory-class-property" property definition. */
private static final ClassPropertyDefinition PD_MANDATORY_CLASS_PROPERTY;
- // The "mandatory-read-only-attribute-type-property" property definition.
+ /** The "mandatory-read-only-attribute-type-property" property definition. */
private static final AttributeTypePropertyDefinition PD_MANDATORY_READ_ONLY_ATTRIBUTE_TYPE_PROPERTY;
- // The "optional-multi-valued-dn-property" property definition.
+ /** The "optional-multi-valued-dn-property" property definition. */
private static final DNPropertyDefinition PD_OPTIONAL_MULTI_VALUED_DN_PROPERTY;
- // The "test-children" relation definition.
+ /** The "test-children" relation definition. */
private static final InstantiableRelationDefinition<TestChildCfgClient, TestChildCfg> RD_TEST_CHILDREN;
- // The "optional-test-child" relation definition.
+ /** The "optional-test-child" relation definition. */
private static final OptionalRelationDefinition<TestChildCfgClient, TestChildCfg> RD_OPTIONAL_TEST_CHILD;
- // Build the "mandatory-boolean-property" property definition.
+ /** Build the "mandatory-boolean-property" property definition. */
static {
BooleanPropertyDefinition.Builder builder = BooleanPropertyDefinition.createBuilder(INSTANCE,
"mandatory-boolean-property");
@@ -86,7 +86,7 @@
INSTANCE.registerPropertyDefinition(PD_MANDATORY_BOOLEAN_PROPERTY);
}
- // Build the "mandatory-class-property" property definition.
+ /** Build the "mandatory-class-property" property definition. */
static {
ClassPropertyDefinition.Builder builder = ClassPropertyDefinition.createBuilder(INSTANCE,
"mandatory-class-property");
@@ -101,8 +101,10 @@
INSTANCE.registerPropertyDefinition(PD_MANDATORY_CLASS_PROPERTY);
}
- // Build the "mandatory-read-only-attribute-type-property" property
- // definition.
+ /**
+ * Build the "mandatory-read-only-attribute-type-property" property
+ * definition.
+ */
static {
AttributeTypePropertyDefinition.Builder builder = AttributeTypePropertyDefinition.createBuilder(INSTANCE,
"mandatory-read-only-attribute-type-property");
@@ -115,7 +117,7 @@
INSTANCE.registerPropertyDefinition(PD_MANDATORY_READ_ONLY_ATTRIBUTE_TYPE_PROPERTY);
}
- // Build the "optional-multi-valued-dn-property" property definition.
+ /** Build the "optional-multi-valued-dn-property" property definition. */
static {
DNPropertyDefinition.Builder builder = DNPropertyDefinition.createBuilder(INSTANCE,
"optional-multi-valued-dn-property");
@@ -129,7 +131,7 @@
INSTANCE.registerPropertyDefinition(PD_OPTIONAL_MULTI_VALUED_DN_PROPERTY);
}
- // Build the "test-children" relation definition.
+ /** Build the "test-children" relation definition. */
static {
InstantiableRelationDefinition.Builder<TestChildCfgClient, TestChildCfg> builder =
new InstantiableRelationDefinition.Builder<TestChildCfgClient, TestChildCfg>(
@@ -138,7 +140,7 @@
INSTANCE.registerRelationDefinition(RD_TEST_CHILDREN);
}
- // Build the "optional-test-child" relation definition.
+ /** Build the "optional-test-child" relation definition. */
static {
OptionalRelationDefinition.Builder<TestChildCfgClient, TestChildCfg> builder =
new OptionalRelationDefinition.Builder<TestChildCfgClient, TestChildCfg>(
@@ -163,23 +165,17 @@
super("test-parent", null);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public TestParentCfgClient createClientConfiguration(ManagedObject<? extends TestParentCfgClient> impl) {
return new TestParentCfgClientImpl(impl);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public TestParentCfg createServerConfiguration(ServerManagedObject<? extends TestParentCfg> impl) {
return new TestParentCfgServerImpl(impl);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Class<TestParentCfg> getServerConfigurationClass() {
return TestParentCfg.class;
}
@@ -254,153 +250,115 @@
*/
private static class TestParentCfgClientImpl implements TestParentCfgClient {
- // Private implementation.
+ /** Private implementation. */
private ManagedObject<? extends TestParentCfgClient> impl;
- // Private constructor.
+ /** Private constructor. */
private TestParentCfgClientImpl(ManagedObject<? extends TestParentCfgClient> impl) {
this.impl = impl;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Boolean isMandatoryBooleanProperty() {
return impl.getPropertyValue(INSTANCE.getMandatoryBooleanPropertyPropertyDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void setMandatoryBooleanProperty(boolean value) {
impl.setPropertyValue(INSTANCE.getMandatoryBooleanPropertyPropertyDefinition(), value);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getMandatoryClassProperty() {
return impl.getPropertyValue(INSTANCE.getMandatoryClassPropertyPropertyDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void setMandatoryClassProperty(String value) {
impl.setPropertyValue(INSTANCE.getMandatoryClassPropertyPropertyDefinition(), value);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public AttributeType getMandatoryReadOnlyAttributeTypeProperty() {
return impl.getPropertyValue(INSTANCE.getMandatoryReadOnlyAttributeTypePropertyPropertyDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void setMandatoryReadOnlyAttributeTypeProperty(AttributeType value) throws PropertyException {
impl.setPropertyValue(INSTANCE.getMandatoryReadOnlyAttributeTypePropertyPropertyDefinition(), value);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public SortedSet<DN> getOptionalMultiValuedDNProperty() {
return impl.getPropertyValues(INSTANCE.getOptionalMultiValuedDNPropertyPropertyDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void setOptionalMultiValuedDNProperty(Collection<DN> values) {
impl.setPropertyValues(INSTANCE.getOptionalMultiValuedDNPropertyPropertyDefinition(), values);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String[] listTestChildren() throws ConcurrentModificationException, LdapException {
return impl.listChildren(INSTANCE.getTestChildrenRelationDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public TestChildCfgClient getTestChild(String name) throws DefinitionDecodingException,
ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException,
LdapException {
return impl.getChild(INSTANCE.getTestChildrenRelationDefinition(), name).getConfiguration();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <M extends TestChildCfgClient> M createTestChild(ManagedObjectDefinition<M, ? extends TestChildCfg> d,
String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException {
return impl.createChild(INSTANCE.getTestChildrenRelationDefinition(), d, name, exceptions)
.getConfiguration();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void removeTestChild(String name) throws ManagedObjectNotFoundException,
ConcurrentModificationException, OperationRejectedException, LdapException {
impl.removeChild(INSTANCE.getTestChildrenRelationDefinition(), name);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasOptionalTestChild() throws ConcurrentModificationException, LdapException {
return impl.hasChild(INSTANCE.getOptionalTestChildRelationDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public TestChildCfgClient getOptionalChild() throws DefinitionDecodingException,
ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException,
LdapException {
return impl.getChild(INSTANCE.getOptionalTestChildRelationDefinition()).getConfiguration();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <M extends TestChildCfgClient> M createOptionalTestChild(
ManagedObjectDefinition<M, ? extends TestChildCfg> d, Collection<PropertyException> exceptions) {
return impl.createChild(INSTANCE.getOptionalTestChildRelationDefinition(), d, exceptions)
.getConfiguration();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void removeOptionalTestChild() throws ManagedObjectNotFoundException, ConcurrentModificationException,
OperationRejectedException, LdapException {
impl.removeChild(INSTANCE.getOptionalTestChildRelationDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ManagedObjectDefinition<? extends TestParentCfgClient, ? extends TestParentCfg> definition() {
return INSTANCE;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public PropertyProvider properties() {
return impl;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void commit() throws ManagedObjectAlreadyExistsException, MissingMandatoryPropertiesException,
ConcurrentModificationException, OperationRejectedException, LdapException {
impl.commit();
@@ -413,153 +371,113 @@
*/
private static class TestParentCfgServerImpl implements TestParentCfg {
- // Private implementation.
+ /** Private implementation. */
private ServerManagedObject<? extends TestParentCfg> impl;
- // Private constructor.
+ /** Private constructor. */
private TestParentCfgServerImpl(ServerManagedObject<? extends TestParentCfg> impl) {
this.impl = impl;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void addChangeListener(ConfigurationChangeListener<TestParentCfg> listener) {
impl.registerChangeListener(listener);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void removeChangeListener(ConfigurationChangeListener<TestParentCfg> listener) {
impl.deregisterChangeListener(listener);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isMandatoryBooleanProperty() {
return impl.getPropertyValue(INSTANCE.getMandatoryBooleanPropertyPropertyDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getMandatoryClassProperty() {
return impl.getPropertyValue(INSTANCE.getMandatoryClassPropertyPropertyDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public AttributeType getMandatoryReadOnlyAttributeTypeProperty() {
return impl.getPropertyValue(INSTANCE.getMandatoryReadOnlyAttributeTypePropertyPropertyDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public SortedSet<DN> getOptionalMultiValuedDNProperty() {
return impl.getPropertyValues(INSTANCE.getOptionalMultiValuedDNPropertyPropertyDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String[] listTestChildren() {
return impl.listChildren(INSTANCE.getTestChildrenRelationDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public TestChildCfg getTestChild(String name) throws ConfigException {
return impl.getChild(INSTANCE.getTestChildrenRelationDefinition(), name).getConfiguration();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void addTestChildAddListener(ConfigurationAddListener<TestChildCfg> listener) throws ConfigException {
impl.registerAddListener(INSTANCE.getTestChildrenRelationDefinition(), listener);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void removeTestChildAddListener(ConfigurationAddListener<TestChildCfg> listener) {
impl.deregisterAddListener(INSTANCE.getTestChildrenRelationDefinition(), listener);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void addTestChildDeleteListener(ConfigurationDeleteListener<TestChildCfg> listener)
throws ConfigException {
impl.registerDeleteListener(INSTANCE.getTestChildrenRelationDefinition(), listener);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void removeTestChildDeleteListener(ConfigurationDeleteListener<TestChildCfg> listener) {
impl.deregisterDeleteListener(INSTANCE.getTestChildrenRelationDefinition(), listener);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasOptionalTestChild() {
return impl.hasChild(INSTANCE.getOptionalTestChildRelationDefinition());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public TestChildCfg getOptionalTestChild() throws ConfigException {
return impl.getChild(INSTANCE.getOptionalTestChildRelationDefinition()).getConfiguration();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void addOptionalTestChildAddListener(ConfigurationAddListener<TestChildCfg> listener)
throws ConfigException {
impl.registerAddListener(INSTANCE.getOptionalTestChildRelationDefinition(), listener);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void removeOptionalTestChildAddListener(ConfigurationAddListener<TestChildCfg> listener) {
impl.deregisterAddListener(INSTANCE.getOptionalTestChildRelationDefinition(), listener);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void addOptionalChildTestDeleteListener(ConfigurationDeleteListener<TestChildCfg> listener)
throws ConfigException {
impl.registerDeleteListener(INSTANCE.getOptionalTestChildRelationDefinition(), listener);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void removeOptionalTestChildDeleteListener(ConfigurationDeleteListener<TestChildCfg> listener) {
impl.deregisterDeleteListener(INSTANCE.getOptionalTestChildRelationDefinition(), listener);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Class<? extends TestParentCfg> configurationClass() {
return TestParentCfg.class;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public DN dn() {
return impl.getDN();
}
diff --git a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/ValidateConfigDefinitionsTest.java b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/ValidateConfigDefinitionsTest.java
index 37fa0ce..30e52b2 100644
--- a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/ValidateConfigDefinitionsTest.java
+++ b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/ValidateConfigDefinitionsTest.java
@@ -72,7 +72,7 @@
return params;
}
- // Exceptions to config objects having a different objectclass
+ /** Exceptions to config objects having a different objectclass. */
private static final List<String> CLASS_OBJECT_CLASS_EXCEPTIONS = Arrays.asList(new String[] {
"org.forgerock.opendj.config.std.meta.RootCfgDefn", "org.forgerock.opendj.config.std.meta.GlobalCfgDefn", });
@@ -109,19 +109,21 @@
}
}
- // Exceptions to properties ending in -class being exactly 'java-class'.
+ /** Exceptions to properties ending in -class being exactly 'java-class'. */
private static final List<String> CLASS_PROPERTY_EXCEPTIONS = Arrays.asList(new String[] {
// e.g. "prop-name-ending-with-class"
});
- // Exceptions to properties ending in -enabled being exactly 'enabled'.
+ /** Exceptions to properties ending in -enabled being exactly 'enabled'. */
private static final List<String> ENABLED_PROPERTY_EXCEPTIONS = Arrays.asList(new String[] {
"index-filter-analyzer-enabled", "subordinate-indexes-enabled"
// e.g. "prop-name-ending-with-enabled"
});
- // Exceptions to properties not starting with the name of their config
- // object
+ /**
+ * Exceptions to properties not starting with the name of their config
+ * object.
+ */
private static final List<String> OBJECT_PREFIX_PROPERTY_EXCEPTIONS = Arrays.asList(new String[] { "backend-id",
"plugin-type", "replication-server-id", "network-group-id", "workflow-id", "workflow-element-id",
"workflow-element"
diff --git a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/client/ldap/AggregationClientTest.java b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/client/ldap/AggregationClientTest.java
index 749af52..fbe9bec 100644
--- a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/client/ldap/AggregationClientTest.java
+++ b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/client/ldap/AggregationClientTest.java
@@ -60,7 +60,7 @@
@Test(singleThreaded = true)
public class AggregationClientTest extends AdminTestCase {
- // Test LDIF.
+ /** Test LDIF. */
private static final String[] TEST_LDIF = new String[] {
// @formatter:off
// Base entries.
@@ -331,7 +331,7 @@
"cn=JMX Connection Handler,cn=connection handlers, cn=config");
}
- // Retrieve the named test parent managed object.
+ /** Retrieve the named test parent managed object. */
private TestParentCfgClient getTestParent(ManagementContext context, String name)
throws Exception {
ManagedObject<RootCfgClient> root = context.getRootConfigurationManagedObject();
@@ -339,7 +339,7 @@
.getConfiguration();
}
- // Asserts that the actual set of DNs contains the expected values.
+ /** Asserts that the actual set of DNs contains the expected values. */
private void assertSetEquals(SortedSet<String> actual, String... expected) {
SortedSet<String> values =
new TreeSet<String>(TestChildCfgDefn.getInstance()
diff --git a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/client/ldap/LDAPClientTest.java b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/client/ldap/LDAPClientTest.java
index 6b15ab3..f57ab7c 100644
--- a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/client/ldap/LDAPClientTest.java
+++ b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/client/ldap/LDAPClientTest.java
@@ -915,7 +915,7 @@
}
}
- // Asserts that the actual set of DNs contains the expected values.
+ /** Asserts that the actual set of DNs contains the expected values. */
private void assertDNSetEquals(SortedSet<DN> actual, String... expected) {
String[] actualStrings = new String[actual.size()];
int i = 0;
@@ -926,7 +926,7 @@
Assert.assertEqualsNoOrder(actualStrings, expected);
}
- // Create the named test parent managed object.
+ /** Create the named test parent managed object. */
private TestParentCfgClient createTestParent(ManagementContext context, String name)
throws Exception {
ManagedObject<RootCfgClient> root = context.getRootConfigurationManagedObject();
@@ -934,7 +934,7 @@
TestParentCfgDefn.getInstance(), name, null).getConfiguration();
}
- // Retrieve the named test parent managed object.
+ /** Retrieve the named test parent managed object. */
private TestParentCfgClient getTestParent(ManagementContext context, String name)
throws Exception {
ManagedObject<RootCfgClient> root = context.getRootConfigurationManagedObject();
@@ -942,13 +942,13 @@
.getConfiguration();
}
- // List test parent managed objects.
+ /** List test parent managed objects. */
private String[] listTestParents(ManagementContext context) throws Exception {
ManagedObject<RootCfgClient> root = context.getRootConfigurationManagedObject();
return root.listChildren(TestCfg.getTestOneToManyParentRelationDefinition());
}
- // Remove the named test parent managed object.
+ /** Remove the named test parent managed object. */
private void removeTestParent(ManagementContext context, String name) throws Exception {
ManagedObject<RootCfgClient> root = context.getRootConfigurationManagedObject();
root.removeChild(TestCfg.getTestOneToManyParentRelationDefinition(), name);
diff --git a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/client/ldap/MockConstraint.java b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/client/ldap/MockConstraint.java
index 5d5555c..efac01e 100644
--- a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/client/ldap/MockConstraint.java
+++ b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/client/ldap/MockConstraint.java
@@ -49,9 +49,7 @@
*/
private class Handler extends ClientConstraintHandler {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isAddAcceptable(ManagementContext context, ManagedObject<?> managedObject,
Collection<LocalizableMessage> unacceptableReasons) throws LdapException {
@@ -62,9 +60,7 @@
return allowAdds;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isDeleteAcceptable(ManagementContext context, ManagedObjectPath<?, ?> path,
Collection<LocalizableMessage> unacceptableReasons) throws LdapException {
@@ -75,9 +71,7 @@
return allowDeletes;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isModifyAcceptable(ManagementContext context, ManagedObject<?> managedObject,
Collection<LocalizableMessage> unacceptableReasons) throws LdapException {
@@ -90,13 +84,13 @@
}
- // Determines if add operations are allowed.
+ /** Determines if add operations are allowed. */
private final boolean allowAdds;
- // Determines if modify operations are allowed.
+ /** Determines if modify operations are allowed. */
private final boolean allowModifies;
- // Determines if delete operations are allowed.
+ /** Determines if delete operations are allowed. */
private final boolean allowDeletes;
/**
@@ -115,16 +109,12 @@
this.allowDeletes = allowDeletes;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<ClientConstraintHandler> getClientConstraintHandlers() {
return Collections.<ClientConstraintHandler> singleton(new Handler());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<ServerConstraintHandler> getServerConstraintHandlers() {
return Collections.emptySet();
}
diff --git a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/AdminTestCaseUtils.java b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/AdminTestCaseUtils.java
index 27ae3d8..4b54477 100644
--- a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/AdminTestCaseUtils.java
+++ b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/AdminTestCaseUtils.java
@@ -42,14 +42,16 @@
*/
public final class AdminTestCaseUtils {
- // The relation name which will be used for dummy configurations. A
- // deliberately obfuscated name is chosen to avoid clashes.
+ /**
+ * The relation name which will be used for dummy configurations. A
+ * deliberately obfuscated name is chosen to avoid clashes.
+ */
private static final String DUMMY_TEST_RELATION = "*dummy*test*relation*";
- // Indicates if the dummy relation profile has been registered.
+ /** Indicates if the dummy relation profile has been registered. */
private static boolean isProfileRegistered = false;
- // Prevent instantiation.
+ /** Prevent instantiation. */
private AdminTestCaseUtils() {
// No implementation required.
}
diff --git a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/AggregationServerTest.java b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/AggregationServerTest.java
index dc2d16c..afb056e 100644
--- a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/AggregationServerTest.java
+++ b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/AggregationServerTest.java
@@ -200,7 +200,7 @@
"objectclass: ds-cfg-branch",
"cn: test children");
- /** this handler is disabled - see ds-cfg-enabled property */
+ /** This handler is disabled - see ds-cfg-enabled property. */
protected static final Entry TEST_CONNECTION_HANDLER_ENTRY_DISABLED = LDIF.makeEntry(
"dn: cn=" + "Test Connection Handler" + ",cn=Connection Handlers,cn=config",
"objectClass: top",
@@ -211,7 +211,7 @@
"ds-cfg-enabled: false",
"ds-cfg-listen-address: 0.0.0.0", "ds-cfg-listen-port: 389");
- /** this handler is enabled - see ds-cfg-enabled property */
+ /** This handler is enabled - see ds-cfg-enabled property. */
protected static final Entry TEST_CONNECTION_HANDLER_ENTRY_ENABLED = LDIF.makeEntry(
"dn: cn=" + "Test Connection Handler" + ",cn=Connection Handlers,cn=config",
"objectClass: top",
diff --git a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/ConstraintTest.java b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/ConstraintTest.java
index 078f9bc..8d8d0a9 100644
--- a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/ConstraintTest.java
+++ b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/ConstraintTest.java
@@ -114,8 +114,10 @@
"objectclass: ds-cfg-branch",
"cn: test children");
- // Parent 1 - uses default values for
- // optional-multi-valued-dn-property.
+ /**
+ * Parent 1 - uses default values for
+ * optional-multi-valued-dn-property.
+ */
private static final Entry TEST_PARENT_1 = LDIF.makeEntry(
"dn: cn=test parent 1,cn=test parents,cn=config",
"objectclass: top",
@@ -125,7 +127,6 @@
"ds-cfg-java-class: org.opends.server.extensions.UserDefinedVirtualAttributeProvider",
"ds-cfg-attribute-type: description",
"ds-cfg-conflict-behavior: virtual-overrides-real");
-
// @Checkstyle:on
@BeforeClass
@@ -138,7 +139,7 @@
TestCfg.cleanup();
}
- /** Success just ensure there is no exception raised */
+ /** Success just ensure there is no exception raised. */
@Test
public void testGetManagedObjectSuccess() throws Exception {
// arrange
diff --git a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/DefaultBehaviorTest.java b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/DefaultBehaviorTest.java
index 9f3092d..7d0dd72 100644
--- a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/DefaultBehaviorTest.java
+++ b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/DefaultBehaviorTest.java
@@ -119,7 +119,7 @@
"objectclass: ds-cfg-branch",
"cn: test parents");
- // Parent 1 - uses default values for optional-multi-valued-dn-property.
+ /** Parent 1 - uses default values for optional-multi-valued-dn-property. */
static final List<String> LDIF_TEST_PARENT_1 = Arrays.asList(
"dn: cn=test parent 1,cn=test parents,cn=config",
"objectclass: top",
@@ -132,7 +132,7 @@
static final Entry TEST_PARENT_1 = makeEntry(LDIF_TEST_PARENT_1);
- // Parent 2 - overrides default values for optional-multi-valued-dn-property.
+ /** Parent 2 - overrides default values for optional-multi-valued-dn-property. */
static final Entry TEST_PARENT_2 = makeEntry(
"dn: cn=test parent 2,cn=test parents,cn=config",
"objectclass: top",
@@ -218,7 +218,6 @@
"ds-cfg-java-class: org.opends.server.extensions.UserDefinedVirtualAttributeProvider",
"ds-cfg-attribute-type: description",
"ds-cfg-conflict-behavior: virtual-overrides-real");
-
// @Checkstyle:on
@BeforeClass
@@ -404,7 +403,7 @@
assertDNSetEquals(child.getOptionalMultiValuedDNProperty2(), dnProperty2);
}
- /** Asserts that the actual set of DNs contains the expected values */
+ /** Asserts that the actual set of DNs contains the expected values. */
private void assertDNSetEquals(SortedSet<DN> actualDNs, List<String> expectedDNs) {
String[] actualStrings = new String[actualDNs.size()];
int i = 0;
@@ -415,7 +414,7 @@
assertThat(actualStrings).containsOnly(expectedDNs.toArray(new Object[expectedDNs.size()]));
}
- /** Make an entry by combining two lists */
+ /** Make an entry by combining two lists. */
static Entry makeEntryFrom(List<String> base, List<String> attrs) {
List<String> ldif = new ArrayList<String>(base);
ldif.addAll(attrs);
diff --git a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/ListenerTest.java b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/ListenerTest.java
index d330fdb..2679a75 100644
--- a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/ListenerTest.java
+++ b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/ListenerTest.java
@@ -85,7 +85,7 @@
/**
* Register a listener for test parent entry and return the actual
- * registered listener
+ * registered listener.
*/
private ConfigAddListener registerAddListenerForTestParent(ConfigurationRepository configRepository,
ServerManagedObject<RootCfg> root, ConfigurationAddListener<TestParentCfg> parentListener) throws Exception {
@@ -98,7 +98,7 @@
/**
* Register a listener for test parent entry in delayed scenario and return
- * the actual registered listener
+ * the actual registered listener.
*/
private DelayedConfigAddListener registerAddListenerForTestParentDelayed(
ConfigurationRepository configRepository, ServerManagedObject<RootCfg> root,
diff --git a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/MockConstraint.java b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/MockConstraint.java
index b82abc2..143e8ec 100644
--- a/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/MockConstraint.java
+++ b/opendj-sdk/opendj-config/src/test/java/org/forgerock/opendj/config/server/MockConstraint.java
@@ -46,9 +46,7 @@
*/
private class MockConstraintHandler extends ServerConstraintHandler {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isDeleteAllowed(ServerManagedObject<?> managedObject,
Collection<LocalizableMessage> unacceptableReasons) throws ConfigException {
@@ -59,9 +57,7 @@
return isDeleteAllowed;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isUsable(ServerManagedObject<?> managedObject,
Collection<LocalizableMessage> unacceptableReasons) throws ConfigException {
@@ -72,9 +68,7 @@
return isUsable;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void performPostAdd(ServerManagedObject<?> managedObject) throws ConfigException {
// Make sure that the associated config entry exists.
@@ -82,9 +76,7 @@
Assert.assertTrue(configRepository.hasEntry(targetDN));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void performPostDelete(ServerManagedObject<?> managedObject) throws ConfigException {
// Make sure that the associated config entry does not exist.
@@ -92,9 +84,7 @@
Assert.assertTrue(configRepository.hasEntry(targetDN));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void performPostModify(ServerManagedObject<?> managedObject) throws ConfigException {
// Make sure that the associated config entry exists.
@@ -104,10 +94,10 @@
}
- // Determines if delete operations are allowed.
+ /** Determines if delete operations are allowed. */
private final boolean isDeleteAllowed;
- // Determines if configurations can be decoded.
+ /** Determines if configurations can be decoded. */
private final boolean isUsable;
private final ConfigurationRepository configRepository;
@@ -128,16 +118,12 @@
this.configRepository = configRepository;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<ClientConstraintHandler> getClientConstraintHandlers() {
return Collections.emptySet();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Collection<ServerConstraintHandler> getServerConstraintHandlers() {
return Collections.<ServerConstraintHandler> singleton(new MockConstraintHandler());
}
diff --git a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/controls/AccountUsabilityRequestControl.java b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/controls/AccountUsabilityRequestControl.java
index ceb93d9..2298977 100644
--- a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/controls/AccountUsabilityRequestControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/controls/AccountUsabilityRequestControl.java
@@ -105,42 +105,32 @@
return isCritical ? CRITICAL_INSTANCE : NONCRITICAL_INSTANCE;
}
- // Prevent direct instantiation.
+ /** Prevent direct instantiation. */
private AccountUsabilityRequestControl(final boolean isCritical) {
this.isCritical = isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/controls/AccountUsabilityResponseControl.java b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/controls/AccountUsabilityResponseControl.java
index 38b5fb1..7c1f532 100644
--- a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/controls/AccountUsabilityResponseControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/controls/AccountUsabilityResponseControl.java
@@ -252,36 +252,42 @@
secondsBeforeExpiration);
}
- // Indicates whether the user's account is usable.
+ /** Indicates whether the user's account is usable. */
private final boolean isUsable;
- // Indicates whether the user's password is expired.
+ /** Indicates whether the user's password is expired. */
private final boolean isExpired;
- // Indicates whether the user's account is inactive.
+ /** Indicates whether the user's account is inactive. */
private final boolean isInactive;
- // Indicates whether the user's account is currently locked.
+ /** Indicates whether the user's account is currently locked. */
private final boolean isLocked;
- // Indicates whether the user's password has been reset and must be
- // changed before anything else can be done.
+ /**
+ * Indicates whether the user's password has been reset and must be
+ * changed before anything else can be done.
+ */
private final boolean isReset;
- // The number of remaining grace logins, if available.
+ /** The number of remaining grace logins, if available. */
private final int remainingGraceLogins;
- // The length of time in seconds before the user's password expires,
- // if available.
+ /**
+ * The length of time in seconds before the user's password expires,
+ * if available.
+ */
private final int secondsBeforeExpiration;
- // The length of time before the user's account is unlocked, if
- // available.
+ /**
+ * The length of time before the user's account is unlocked, if
+ * available.
+ */
private final int secondsBeforeUnlock;
private final boolean isCritical;
- // Prevent direct instantiation.
+ /** Prevent direct instantiation. */
private AccountUsabilityResponseControl(final boolean isCritical, final boolean isUsable,
final boolean isInactive, final boolean isReset, final boolean isExpired,
final int remainingGraceLogins, final boolean isLocked, final int secondsBeforeUnlock,
@@ -297,9 +303,7 @@
this.secondsBeforeExpiration = secondsBeforeExpiration;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
@@ -340,9 +344,7 @@
return secondsBeforeUnlock;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
final ByteStringBuilder buffer = new ByteStringBuilder();
final ASN1Writer writer = ASN1.getWriter(buffer);
@@ -379,16 +381,12 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
@@ -446,9 +444,7 @@
return isUsable;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/controls/RealAttributesOnlyRequestControl.java b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/controls/RealAttributesOnlyRequestControl.java
index 119efd5..69ddf73 100644
--- a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/controls/RealAttributesOnlyRequestControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/controls/RealAttributesOnlyRequestControl.java
@@ -108,37 +108,27 @@
this.isCritical = isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/controls/VirtualAttributesOnlyRequestControl.java b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/controls/VirtualAttributesOnlyRequestControl.java
index 7620f81..a056775 100644
--- a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/controls/VirtualAttributesOnlyRequestControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/controls/VirtualAttributesOnlyRequestControl.java
@@ -108,37 +108,27 @@
this.isCritical = isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/GetConnectionIDExtendedRequest.java b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/GetConnectionIDExtendedRequest.java
index 11656d1..e476adc 100644
--- a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/GetConnectionIDExtendedRequest.java
+++ b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/GetConnectionIDExtendedRequest.java
@@ -70,9 +70,7 @@
private static final class ResultDecoder extends
AbstractExtendedResultDecoder<GetConnectionIDExtendedResult> {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public GetConnectionIDExtendedResult newExtendedErrorResult(final ResultCode resultCode,
final String matchedDN, final String diagnosticMessage) {
if (!resultCode.isExceptional()) {
@@ -123,7 +121,7 @@
*/
public static final String OID = "1.3.6.1.4.1.26027.1.6.2";
- // Singleton.
+ /** Singleton. */
private static final GetConnectionIDExtendedRequest INSTANCE =
new GetConnectionIDExtendedRequest();
@@ -133,7 +131,7 @@
*/
public static final RequestDecoder REQUEST_DECODER = new RequestDecoder();
- // No need to expose this.
+ /** No need to expose this. */
private static final ResultDecoder RESULT_DECODER = new ResultDecoder();
/**
@@ -145,46 +143,36 @@
return INSTANCE;
}
- // Prevent instantiation.
+ /** Prevent instantiation. */
private GetConnectionIDExtendedRequest() {
// Nothing to do.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ExtendedResultDecoder<GetConnectionIDExtendedResult> getResultDecoder() {
return RESULT_DECODER;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ByteString getValue() {
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean hasValue() {
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/GetConnectionIDExtendedResult.java b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/GetConnectionIDExtendedResult.java
index 4416c18..ba1e60d 100644
--- a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/GetConnectionIDExtendedResult.java
+++ b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/GetConnectionIDExtendedResult.java
@@ -75,17 +75,13 @@
return connectionID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getOID() {
return GetConnectionIDExtendedRequest.OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ByteString getValue() {
final ByteStringBuilder buffer = new ByteStringBuilder(6);
@@ -101,9 +97,7 @@
return buffer.toByteString();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean hasValue() {
return true;
@@ -121,9 +115,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/GetSymmetricKeyExtendedRequest.java b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/GetSymmetricKeyExtendedRequest.java
index 4e26e51..1cd870c 100644
--- a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/GetSymmetricKeyExtendedRequest.java
+++ b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/GetSymmetricKeyExtendedRequest.java
@@ -138,7 +138,7 @@
*/
public static final RequestDecoder REQUEST_DECODER = new RequestDecoder();
- // No need to expose this.
+ /** No need to expose this. */
private static final ResultDecoder RESULT_DECODER = new ResultDecoder();
/**
@@ -154,7 +154,7 @@
private String instanceKeyID = null;
- // Instantiation via factory.
+ /** Instantiation via factory. */
private GetSymmetricKeyExtendedRequest() {
}
@@ -168,9 +168,7 @@
return instanceKeyID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getOID() {
return OID;
@@ -185,17 +183,13 @@
return requestSymmetricKey;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ExtendedResultDecoder<ExtendedResult> getResultDecoder() {
return RESULT_DECODER;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ByteString getValue() {
final ByteStringBuilder buffer = new ByteStringBuilder();
@@ -218,9 +212,7 @@
return buffer.toByteString();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean hasValue() {
return true;
@@ -250,9 +242,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/PasswordPolicyStateExtendedRequest.java b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/PasswordPolicyStateExtendedRequest.java
index ebdbe2b..a78f2e4 100644
--- a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/PasswordPolicyStateExtendedRequest.java
+++ b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/PasswordPolicyStateExtendedRequest.java
@@ -150,9 +150,7 @@
return values;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
return property.toString() + ": " + values;
@@ -198,9 +196,7 @@
private static final class ResultDecoder extends
AbstractExtendedResultDecoder<PasswordPolicyStateExtendedResult> {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public PasswordPolicyStateExtendedResult newExtendedErrorResult(
final ResultCode resultCode, final String matchedDN, final String diagnosticMessage) {
if (!resultCode.isExceptional()) {
@@ -310,7 +306,7 @@
*/
public static final RequestDecoder REQUEST_DECODER = new RequestDecoder();
- // No need to expose this.
+ /** No need to expose this. */
private static final ResultDecoder RESULT_DECODER = new ResultDecoder();
static ByteString encode(final String targetUser,
@@ -422,9 +418,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void addOperation(final PasswordPolicyStateOperation operation) {
operations.add(operation);
}
@@ -499,47 +493,35 @@
operations.add(PasswordPolicyStateOperationType.CLEAR_PASSWORD_RESET_STATE);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Iterable<PasswordPolicyStateOperation> getOperations() {
return operations;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ExtendedResultDecoder<PasswordPolicyStateExtendedResult> getResultDecoder() {
return RESULT_DECODER;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getTargetUser() {
return targetUser;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ByteString getValue() {
return encode(targetUser, operations);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean hasValue() {
return true;
@@ -827,17 +809,13 @@
.valueOf(String.valueOf(state))));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void setTargetUser(String targetUser) {
this.targetUser = targetUser != null ? targetUser : "";
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/PasswordPolicyStateExtendedResult.java b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/PasswordPolicyStateExtendedResult.java
index 8bac7b6..64c4fbd 100644
--- a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/PasswordPolicyStateExtendedResult.java
+++ b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/PasswordPolicyStateExtendedResult.java
@@ -54,63 +54,47 @@
super(resultCode);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void addOperation(final PasswordPolicyStateOperation operation) {
operations.add(operation);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getOID() {
// No response name defined.
return PasswordPolicyStateExtendedRequest.OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Iterable<PasswordPolicyStateOperation> getOperations() {
return operations;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getTargetUser() {
return targetUser;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ByteString getValue() {
return PasswordPolicyStateExtendedRequest.encode(targetUser, operations);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean hasValue() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void setTargetUser(String targetUser) {
this.targetUser = targetUser != null ? targetUser : "";
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/PasswordPolicyStateOperationType.java b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/PasswordPolicyStateOperationType.java
index 01ea4ff..f6272f6 100644
--- a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/PasswordPolicyStateOperationType.java
+++ b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/ldap/extensions/PasswordPolicyStateOperationType.java
@@ -262,23 +262,17 @@
this.propertyName = propertyName;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public PasswordPolicyStateOperationType getOperationType() {
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Iterable<ByteString> getValues() {
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
return propertyName;
diff --git a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/ASCIICharProp.java b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/ASCIICharProp.java
index e849f4e..2bb063a 100644
--- a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/ASCIICharProp.java
+++ b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/ASCIICharProp.java
@@ -180,9 +180,7 @@
return c;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int compareTo(final ASCIICharProp o) {
return c - o.c;
}
@@ -198,17 +196,13 @@
return decimalValue;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean equals(final Object obj) {
return this == obj;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
return c;
@@ -315,9 +309,7 @@
return lowerCaseChar;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
return stringValue;
diff --git a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/Iterables.java b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/Iterables.java
index e64fa8f..bdf58d6 100644
--- a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/Iterables.java
+++ b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/Iterables.java
@@ -46,7 +46,7 @@
private static final class ArrayIterable<M> extends AbstractIterable<M> {
private final M[] a;
- // Constructed via factory methods.
+ /** Constructed via factory methods. */
private ArrayIterable(final M[] a) {
this.a = a;
}
@@ -69,7 +69,7 @@
private final P parameter;
private final Predicate<? super M, P> predicate;
- // Constructed via factory methods.
+ /** Constructed via factory methods. */
private FilteredIterable(final Iterable<M> iterable,
final Predicate<? super M, P> predicate, final P p) {
this.iterable = iterable;
@@ -86,7 +86,7 @@
private static final class SingletonIterable<M> extends AbstractIterable<M> {
private final M value;
- // Constructed via factory methods.
+ /** Constructed via factory methods. */
private SingletonIterable(final M value) {
this.value = value;
}
@@ -101,7 +101,7 @@
private final Function<? super M, ? extends N, NeverThrowsException> function;
private final Iterable<M> iterable;
- // Constructed via factory methods.
+ /** Constructed via factory methods. */
private TransformedIterable(final Iterable<M> iterable,
final Function<? super M, ? extends N, NeverThrowsException> function) {
this.iterable = iterable;
@@ -117,7 +117,7 @@
private static final class UnmodifiableIterable<M> extends AbstractIterable<M> {
private final Iterable<M> iterable;
- // Constructed via factory methods.
+ /** Constructed via factory methods. */
private UnmodifiableIterable(final Iterable<M> iterable) {
this.iterable = iterable;
}
@@ -327,7 +327,7 @@
return new UnmodifiableIterable<M>(iterable);
}
- // Prevent instantiation
+ /** Prevent instantiation. */
private Iterables() {
// Do nothing.
}
diff --git a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/OperatingSystem.java b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/OperatingSystem.java
index cac77e3..b9b15e6 100644
--- a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/OperatingSystem.java
+++ b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/OperatingSystem.java
@@ -91,7 +91,7 @@
*/
UNKNOWN("Unknown", false, false, false);
- // The human-readable name for this operating system.
+ /** The human-readable name for this operating system. */
private String osName;
private boolean isWindows;
diff --git a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/ReferenceCountedObject.java b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/ReferenceCountedObject.java
index 0ddc8d5..b532911 100644
--- a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/ReferenceCountedObject.java
+++ b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/ReferenceCountedObject.java
@@ -40,7 +40,7 @@
* released during garbage collection.
*/
public final class Reference {
- /*
+ /**
* The value will be accessed by the finalizer thread so it needs to be
* volatile in order to ensure that updates are published.
*/
diff --git a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/SizeLimitInputStream.java b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/SizeLimitInputStream.java
index f0837ff..c7d22e0 100644
--- a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/SizeLimitInputStream.java
+++ b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/SizeLimitInputStream.java
@@ -50,9 +50,7 @@
this.readLimit = readLimit;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int available() throws IOException {
final int streamAvail = parentStream.available();
@@ -60,9 +58,7 @@
return limitedAvail < streamAvail ? limitedAvail : streamAvail;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void close() throws IOException {
parentStream.close();
@@ -86,26 +82,20 @@
return readLimit;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public synchronized void mark(final int readlimit) {
parentStream.mark(readlimit);
markBytesRead = bytesRead;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean markSupported() {
return parentStream.markSupported();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int read() throws IOException {
if (bytesRead >= readLimit) {
@@ -119,9 +109,7 @@
return b;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int read(final byte[] b, final int off, int len) throws IOException {
if (off < 0 || len < 0 || off + len > b.length) {
@@ -147,18 +135,14 @@
return readLen;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public synchronized void reset() throws IOException {
parentStream.reset();
bytesRead = markBytesRead;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public long skip(long n) throws IOException {
if (bytesRead + n > readLimit) {
diff --git a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/StaticUtils.java b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/StaticUtils.java
index 03fe385..1ae8d38 100644
--- a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/StaticUtils.java
+++ b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/StaticUtils.java
@@ -1756,7 +1756,7 @@
return ' ';
}
- // Prevent instantiation.
+ /** Prevent instantiation. */
private StaticUtils() {
// No implementation required.
}
diff --git a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/SubstringReader.java b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/SubstringReader.java
index 7222929..f9ac447 100644
--- a/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/SubstringReader.java
+++ b/opendj-sdk/opendj-core/src/main/java/com/forgerock/opendj/util/SubstringReader.java
@@ -33,13 +33,13 @@
* A sub-string reader.
*/
public class SubstringReader {
- // The source string.
+ /** The source string. */
private final String source;
- // The current position.
+ /** The current position. */
private int pos;
- // The marked position.
+ /** The marked position. */
private int mark;
- // The length of the source.
+ /** The length of the source. */
private final int length;
/**
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/ASN1.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/ASN1.java
index 4805a24..9803123 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/ASN1.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/ASN1.java
@@ -331,7 +331,7 @@
return new ASN1OutputStreamWriter(stream, maxBufferSize);
}
- // Prevent instantiation.
+ /** Prevent instantiation. */
private ASN1() {
// Nothing to do.
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/ASN1ByteSequenceReader.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/ASN1ByteSequenceReader.java
index 442ed2c..5d764b3 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/ASN1ByteSequenceReader.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/ASN1ByteSequenceReader.java
@@ -73,16 +73,12 @@
this.maxElementSize = maxElementSize;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void close() throws IOException {
readerStack.clear();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean elementAvailable() throws IOException {
if ((state == ASN1.ELEMENT_READ_STATE_NEED_TYPE) && !needTypeState(false)) {
return false;
@@ -95,16 +91,12 @@
return peekLength <= reader.remaining();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasNextElement() throws IOException {
return (state != ASN1.ELEMENT_READ_STATE_NEED_TYPE) || needTypeState(false);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int peekLength() throws IOException {
peekType();
@@ -115,9 +107,7 @@
return peekLength;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public byte peekType() throws IOException {
if (state == ASN1.ELEMENT_READ_STATE_NEED_TYPE) {
// Read just the type.
@@ -134,9 +124,7 @@
return peekType;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean readBoolean() throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -156,9 +144,7 @@
return readByte != 0x00;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void readEndSequence() throws IOException {
if (readerStack.isEmpty()) {
final LocalizableMessage message = ERR_ASN1_SEQUENCE_READ_NOT_STARTED.get();
@@ -182,18 +168,14 @@
readEndSequence();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void readEndSet() throws IOException {
// From an implementation point of view, a set is equivalent to a
// sequence.
readEndSequence();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int readEnumerated() throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -208,9 +190,7 @@
return (int) readInteger();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public long readInteger() throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -251,9 +231,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void readNull() throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -267,9 +245,7 @@
state = ASN1.ELEMENT_READ_STATE_NEED_TYPE;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString readOctetString() throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -284,9 +260,7 @@
return reader.getByteString(peekLength);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteStringBuilder readOctetString(final ByteStringBuilder builder) throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -303,9 +277,7 @@
return builder;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String readOctetStringAsString() throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -320,9 +292,7 @@
return reader.getString(peekLength);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void readStartSequence() throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -347,18 +317,14 @@
readStartSequence();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void readStartSet() throws IOException {
// From an implementation point of view, a set is equivalent to a
// sequence.
readStartSequence();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Reader skipElement() throws IOException {
// Read the header if haven't done so already
peekLength();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/ASN1InputStreamReader.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/ASN1InputStreamReader.java
index a722f91..0beee40 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/ASN1InputStreamReader.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/ASN1InputStreamReader.java
@@ -81,9 +81,7 @@
this.maxElementSize = maxElementSize;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void close() throws IOException {
// Calling close of SizeLimitInputStream should close the parent
// stream.
@@ -91,9 +89,7 @@
streamStack.clear();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean elementAvailable() throws IOException {
if ((state == ASN1.ELEMENT_READ_STATE_NEED_TYPE) && !needTypeState(false, false)) {
return false;
@@ -110,9 +106,7 @@
return peekLength <= in.available();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasNextElement() throws IOException {
if (!streamStack.isEmpty()) {
// We are reading a sub sequence. Return true as long as we
@@ -125,9 +119,7 @@
return (state != ASN1.ELEMENT_READ_STATE_NEED_TYPE) || needTypeState(true, false);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int peekLength() throws IOException {
peekType();
switch (state) {
@@ -143,9 +135,7 @@
return peekLength;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public byte peekType() throws IOException {
if (state == ASN1.ELEMENT_READ_STATE_NEED_TYPE) {
needTypeState(true, true);
@@ -154,9 +144,7 @@
return peekType;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean readBoolean() throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -178,9 +166,7 @@
return readByte != 0x00;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void readEndSequence() throws IOException {
if (streamStack.isEmpty()) {
final LocalizableMessage message = ERR_ASN1_SEQUENCE_READ_NOT_STARTED.get();
@@ -209,18 +195,14 @@
readEndSequence();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void readEndSet() throws IOException {
// From an implementation point of view, a set is equivalent to a
// sequence.
readEndSequence();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int readEnumerated() throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -235,9 +217,7 @@
return (int) readInteger();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public long readInteger() throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -286,9 +266,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void readNull() throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -304,9 +282,7 @@
state = ASN1.ELEMENT_READ_STATE_NEED_TYPE;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString readOctetString() throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -337,9 +313,7 @@
return ByteString.wrap(value);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteStringBuilder readOctetString(final ByteStringBuilder builder) throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -367,9 +341,7 @@
return builder;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String readOctetStringAsString() throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -411,9 +383,7 @@
return str;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void readStartSequence() throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -435,18 +405,14 @@
readStartSequence();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void readStartSet() throws IOException {
// From an implementation point of view, a set is equivalent to a
// sequence.
readStartSequence();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Reader skipElement() throws IOException {
// Read the header if haven't done so already
peekLength();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/ASN1OutputStreamWriter.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/ASN1OutputStreamWriter.java
index b86d234..8db739f 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/ASN1OutputStreamWriter.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/ASN1OutputStreamWriter.java
@@ -71,9 +71,7 @@
this.stackDepth = -1;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void close() throws IOException {
while (stackDepth >= 0) {
@@ -84,17 +82,13 @@
rootStream.close();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void flush() throws IOException {
rootStream.flush();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ASN1Writer writeBoolean(final byte type, final boolean booleanValue) throws IOException {
out.write(type);
@@ -105,9 +99,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ASN1Writer writeEndSequence() throws IOException {
if (stackDepth < 0) {
@@ -135,25 +127,19 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ASN1Writer writeEndSet() throws IOException {
return writeEndSequence();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ASN1Writer writeEnumerated(final byte type, final int intValue) throws IOException {
return writeInteger(type, intValue);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ASN1Writer writeInteger(final byte type, final int intValue) throws IOException {
out.write(type);
@@ -186,9 +172,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ASN1Writer writeInteger(final byte type, final long longValue) throws IOException {
out.write(type);
@@ -263,9 +247,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ASN1Writer writeNull(final byte type) throws IOException {
out.write(type);
@@ -275,9 +257,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ASN1Writer writeOctetString(final byte type, final byte[] value, final int offset,
final int length) throws IOException {
@@ -289,9 +269,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ASN1Writer writeOctetString(final byte type, final ByteSequence value)
throws IOException {
@@ -303,9 +281,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ASN1Writer writeOctetString(final byte type, final String value) throws IOException {
out.write(type);
@@ -323,9 +299,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ASN1Writer writeStartSequence(final byte type) throws IOException {
// Write the type in current stream switch to next sub-stream
@@ -347,9 +321,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ASN1Writer writeStartSet(final byte type) throws IOException {
// From an implementation point of view, a set is equivalent to a
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/AbstractASN1Reader.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/AbstractASN1Reader.java
index 9327266..ef83c99 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/AbstractASN1Reader.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/AbstractASN1Reader.java
@@ -49,9 +49,7 @@
// No implementation required.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean readBoolean(byte type) throws IOException {
if (type == 0x00) {
type = ASN1.UNIVERSAL_BOOLEAN_TYPE;
@@ -60,9 +58,7 @@
return readBoolean();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int readEnumerated(byte type) throws IOException {
if (type == 0x00) {
type = ASN1.UNIVERSAL_ENUMERATED_TYPE;
@@ -71,9 +67,7 @@
return readEnumerated();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public long readInteger(byte type) throws IOException {
if (type == 0x00) {
type = ASN1.UNIVERSAL_INTEGER_TYPE;
@@ -82,9 +76,7 @@
return readInteger();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void readNull(byte type) throws IOException {
if (type == 0x00) {
type = ASN1.UNIVERSAL_NULL_TYPE;
@@ -93,9 +85,7 @@
readNull();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString readOctetString(byte type) throws IOException {
if (type == 0x00) {
type = ASN1.UNIVERSAL_OCTET_STRING_TYPE;
@@ -104,9 +94,7 @@
return readOctetString();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteStringBuilder readOctetString(byte type, final ByteStringBuilder builder)
throws IOException {
if (type == 0x00) {
@@ -117,9 +105,7 @@
return builder;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String readOctetStringAsString(byte type) throws IOException {
// We could cache the UTF-8 CharSet if performance proves to be an
// issue.
@@ -130,9 +116,7 @@
return readOctetStringAsString();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void readStartExplicitTag(byte type) throws IOException {
if (type == 0x00) {
type = (ASN1.TYPE_MASK_CONTEXT | ASN1.TYPE_MASK_CONSTRUCTED);
@@ -141,9 +125,7 @@
readStartExplicitTag();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void readStartSequence(byte type) throws IOException {
if (type == 0x00) {
type = ASN1.UNIVERSAL_SEQUENCE_TYPE;
@@ -152,9 +134,7 @@
readStartSequence();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void readStartSet(byte type) throws IOException {
// From an implementation point of view, a set is equivalent to a
// sequence.
@@ -165,9 +145,7 @@
readStartSet();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Reader skipElement(final byte expectedType) throws IOException {
if (peekType() != expectedType) {
final LocalizableMessage message =
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/AbstractASN1Writer.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/AbstractASN1Writer.java
index 26570ee..caefb70 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/AbstractASN1Writer.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/AbstractASN1Writer.java
@@ -43,87 +43,63 @@
// No implementation required.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeBoolean(final boolean value) throws IOException {
return writeBoolean(ASN1.UNIVERSAL_BOOLEAN_TYPE, value);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeEnumerated(final int value) throws IOException {
return writeEnumerated(ASN1.UNIVERSAL_ENUMERATED_TYPE, value);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeInteger(final int value) throws IOException {
return writeInteger(ASN1.UNIVERSAL_INTEGER_TYPE, value);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeInteger(final long value) throws IOException {
return writeInteger(ASN1.UNIVERSAL_INTEGER_TYPE, value);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeNull() throws IOException {
return writeNull(ASN1.UNIVERSAL_NULL_TYPE);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeOctetString(byte type, byte[] value) throws IOException {
return writeOctetString(type, value, 0, value.length);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeOctetString(byte[] value) throws IOException {
return writeOctetString(value, 0, value.length);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeOctetString(final byte[] value, final int offset, final int length)
throws IOException {
return writeOctetString(ASN1.UNIVERSAL_OCTET_STRING_TYPE, value, offset, length);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeOctetString(final ByteSequence value) throws IOException {
return writeOctetString(ASN1.UNIVERSAL_OCTET_STRING_TYPE, value);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeOctetString(final String value) throws IOException {
return writeOctetString(ASN1.UNIVERSAL_OCTET_STRING_TYPE, value);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeStartSequence() throws IOException {
return writeStartSequence(ASN1.UNIVERSAL_SEQUENCE_TYPE);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeStartSet() throws IOException {
return writeStartSet(ASN1.UNIVERSAL_SET_TYPE);
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/LDAP.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/LDAP.java
index 452c167..c093c44 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/LDAP.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/LDAP.java
@@ -836,7 +836,7 @@
}
}
- // Prevent instantiation.
+ /** Prevent instantiation. */
private LDAP() {
// Nothing to do.
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/LDAPWriter.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/LDAPWriter.java
index 9663f45..b4c91e1 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/LDAPWriter.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/io/LDAPWriter.java
@@ -63,7 +63,7 @@
* The type of ASN.1 writer used for encoding elements.
*/
public final class LDAPWriter<W extends ASN1Writer> {
- // @Checkstyle:ignore AvoidNestedBlocks
+ /** @Checkstyle:ignore AvoidNestedBlocks */
private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
private final W writer;
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AVA.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AVA.java
index b4b3514..5ebefd7 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AVA.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AVA.java
@@ -585,10 +585,10 @@
private final ByteString attributeValue;
- // Cached normalized value using equality matching rule.
+ /** Cached normalized value using equality matching rule. */
private ByteString equalityNormalizedAttributeValue = null;
- // Cached normalized value using ordering matching rule.
+ /** Cached normalized value using ordering matching rule. */
private ByteString orderingNormalizedAttributeValue = null;
/**
@@ -637,9 +637,7 @@
this.attributeValue = ByteString.valueOf(attributeValue);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compareTo(final AVA ava) {
final int result = attributeType.compareTo(ava.attributeType);
@@ -658,9 +656,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean equals(final Object obj) {
if (this == obj) {
@@ -705,9 +701,7 @@
return attributeValue;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
return attributeType.hashCode() * 31 + getEqualityNormalizedValue().hashCode();
@@ -725,9 +719,7 @@
return new LinkedAttribute(ad, attributeValue);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractAsynchronousConnection.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractAsynchronousConnection.java
index 5d46ca2..31d8c67 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractAsynchronousConnection.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractAsynchronousConnection.java
@@ -112,7 +112,7 @@
}
}
- // Handle thread interruption.
+ /** Handle thread interruption. */
private LdapException interrupted(InterruptedException e) {
return newLdapException(ResultCode.CLIENT_SIDE_USER_CANCELLED, e);
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractAttribute.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractAttribute.java
index 17129fa..188daff 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractAttribute.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractAttribute.java
@@ -155,15 +155,11 @@
// No implementation required.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public abstract boolean add(ByteString value);
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean add(final Object... values) {
Reject.ifNull(values);
boolean modified = false;
@@ -173,17 +169,13 @@
return modified;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean addAll(final Collection<? extends ByteString> values) {
return addAll(values, null);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <T> boolean addAll(final Collection<T> values,
final Collection<? super T> duplicateValues) {
boolean modified = false;
@@ -197,15 +189,11 @@
return modified;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public abstract boolean contains(Object value);
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean containsAll(final Collection<?> values) {
for (final Object value : values) {
@@ -216,78 +204,56 @@
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean equals(final Object object) {
return equals(this, object);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString firstValue() {
return iterator().next();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String firstValueAsString() {
return firstValue().toString();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public abstract AttributeDescription getAttributeDescription();
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getAttributeDescriptionAsString() {
return getAttributeDescription().toString();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
return hashCode(this);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public AttributeParser parse() {
return AttributeParser.parseAttribute(this);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public abstract Iterator<ByteString> iterator();
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public abstract boolean remove(Object value);
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean removeAll(final Collection<?> values) {
return removeAll(values, null);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <T> boolean removeAll(final Collection<T> values,
final Collection<? super T> missingValues) {
boolean modified = false;
@@ -301,17 +267,13 @@
return modified;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean retainAll(final Collection<?> values) {
return retainAll(values, null);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <T> boolean retainAll(final Collection<T> values,
final Collection<? super T> missingValues) {
if (values.isEmpty()) {
@@ -355,23 +317,17 @@
return modified;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public abstract int size();
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ByteString[] toArray() {
return toArray(new ByteString[size()]);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
return toString(this);
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractEntry.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractEntry.java
index 9363d1e..56d7788 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractEntry.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractEntry.java
@@ -40,7 +40,7 @@
*/
public abstract class AbstractEntry implements Entry {
- // Predicate used for findAttributes.
+ /** Predicate used for findAttributes. */
private static final Predicate<Attribute, AttributeDescription> FIND_ATTRIBUTES_PREDICATE =
new Predicate<Attribute, AttributeDescription>() {
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractLoadBalancingAlgorithm.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractLoadBalancingAlgorithm.java
index be7d001..9372d6f 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractLoadBalancingAlgorithm.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractLoadBalancingAlgorithm.java
@@ -345,7 +345,7 @@
*/
abstract int getInitialConnectionFactoryIndex();
- // Return the first factory after index which is operational.
+ /** Return the first factory after index which is operational. */
private MonitoredConnectionFactory getMonitoredConnectionFactory(final int initialIndex) throws LdapException {
int index = initialIndex;
final int maxIndex = monitoredFactories.size();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractMapEntry.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractMapEntry.java
index b79c949..e88bbc9 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractMapEntry.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AbstractMapEntry.java
@@ -53,9 +53,7 @@
this.attributes = attributes;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final boolean addAttribute(final Attribute attribute,
final Collection<? super ByteString> duplicateValues) {
@@ -69,26 +67,20 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final Entry clearAttributes() {
attributes.clear();
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final Iterable<Attribute> getAllAttributes() {
return attributes.values();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final Attribute getAttribute(final AttributeDescription attributeDescription) {
final Attribute attribute = attributes.get(attributeDescription);
@@ -100,25 +92,19 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final int getAttributeCount() {
return attributes.size();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final DN getName() {
return name;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final boolean removeAttribute(final Attribute attribute,
final Collection<? super ByteString> missingValues) {
@@ -152,9 +138,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final Entry setName(final DN dn) {
Reject.ifNull(dn);
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AddressMask.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AddressMask.java
index 271123b..d486a48 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AddressMask.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AddressMask.java
@@ -52,11 +52,11 @@
ALLWILDCARD, HOST, HOSTPATTERN, IPv4, IPv6
}
- // IPv4 values for number of bytes and max CIDR prefix
+ /** IPv4 values for number of bytes and max CIDR prefix. */
private static final int IN4ADDRSZ = 4;
private static final int IPV4MAXPREFIX = 32;
- // IPv6 values for number of bytes and max CIDR prefix
+ /** IPv6 values for number of bytes and max CIDR prefix. */
private static final int IN6ADDRSZ = 16;
private static final int IPV6MAXPREFIX = 128;
@@ -95,22 +95,22 @@
return new AddressMask(mask);
}
- // Array that holds each component of a hostname.
+ /** Array that holds each component of a hostname. */
private String[] hostName;
- // Holds a hostname pattern (ie, rule that begins with '.');'
+ /** Holds a hostname pattern (ie, rule that begins with '.');'. */
private String hostPattern;
- // Holds binary representations of rule and mask respectively.
+ /** Holds binary representations of rule and mask respectively. */
private byte[] ruleMask, prefixMask;
- // Holds string passed into the constructor.
+ /** Holds string passed into the constructor. */
private final String ruleString;
- // Type of rule determined
+ /** Type of rule determined. */
private RuleType ruleType;
- // Bit array that holds wildcard info for above binary arrays.
+ /** Bit array that holds wildcard info for above binary arrays. */
private final BitSet wildCard = new BitSet();
private AddressMask(final String rule) {
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AttributeDescription.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AttributeDescription.java
index 0e2c1be..74dc0ef 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AttributeDescription.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AttributeDescription.java
@@ -350,9 +350,7 @@
private static final ThreadLocal<WeakHashMap<Schema, Map<String, AttributeDescription>>> CACHE =
new ThreadLocal<WeakHashMap<Schema, Map<String, AttributeDescription>>>() {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected WeakHashMap<Schema, Map<String, AttributeDescription>> initialValue() {
return new WeakHashMap<Schema, Map<String, AttributeDescription>>();
@@ -360,7 +358,7 @@
};
- // Object class attribute description.
+ /** Object class attribute description. */
private static final ZeroOptionImpl ZERO_OPTION_IMPL = new ZeroOptionImpl();
private static final AttributeDescription OBJECT_CLASS;
@@ -371,9 +369,11 @@
ZERO_OPTION_IMPL);
}
- // This is the size of the per-thread per-schema attribute description
- // cache. We should be conservative here in case there are many
- // threads.
+ /**
+ * This is the size of the per-thread per-schema attribute description
+ * cache. We should be conservative here in case there are many
+ * threads.
+ */
private static final int ATTRIBUTE_DESCRIPTION_CACHE_SIZE = 512;
/**
@@ -742,7 +742,7 @@
return i;
}
- // Uncached valueOf implementation.
+ /** Uncached valueOf implementation. */
private static AttributeDescription valueOf0(final String attributeDescription,
final Schema schema) {
final boolean allowMalformedNamesAndOptions = schema.allowMalformedNamesAndOptions();
@@ -991,7 +991,7 @@
private final Impl pimpl;
- // Private constructor.
+ /** Private constructor. */
private AttributeDescription(final String attributeDescription,
final AttributeType attributeType, final Impl pimpl) {
this.attributeDescription = attributeDescription;
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AttributeFilter.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AttributeFilter.java
index b394c6e..8c0d989 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AttributeFilter.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/AttributeFilter.java
@@ -61,7 +61,8 @@
public final class AttributeFilter {
// TODO: exclude specific attributes, matched values, custom predicates, etc.
private boolean includeAllOperationalAttributes = false;
- private boolean includeAllUserAttributes; // Depends on constructor.
+ /** Depends on constructor. */
+ private boolean includeAllUserAttributes;
private boolean typesOnly = false;
/**
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Attributes.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Attributes.java
index ee8db66..2248288 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Attributes.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Attributes.java
@@ -293,7 +293,7 @@
return 1;
}
- // Lazily computes the normalized single value.
+ /** Lazily computes the normalized single value. */
private ByteString normalizedSingleValue() {
if (normalizedValue == null) {
normalizedValue = normalizeValue(this, value);
@@ -599,7 +599,7 @@
}
}
- // Prevent instantiation.
+ /** Prevent instantiation. */
private Attributes() {
// Nothing to do.
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/ByteString.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/ByteString.java
index 2afaec4..d69dec2 100755
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/ByteString.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/ByteString.java
@@ -47,7 +47,7 @@
*/
public final class ByteString implements ByteSequence {
- // Singleton empty byte string.
+ /** Singleton empty byte string. */
private static final ByteString EMPTY = wrap(new byte[0]);
/**
@@ -536,14 +536,16 @@
// These are package private so that compression and crypto
// functionality may directly access the fields.
- // The buffer where data is stored.
+ /** The buffer where data is stored. */
final byte[] buffer;
- // The number of bytes to expose from the buffer.
+ /** The number of bytes to expose from the buffer. */
final int length;
- // The start index of the range of bytes to expose through this byte
- // string.
+ /**
+ * The start index of the range of bytes to expose through this byte
+ * string.
+ */
final int offset;
/**
@@ -580,9 +582,7 @@
return new ByteSequenceReader(this);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public byte byteAt(final int index) {
if (index >= length || index < 0) {
throw new IndexOutOfBoundsException();
@@ -590,17 +590,13 @@
return buffer[offset + index];
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int compareTo(final byte[] bytes, final int offset, final int length) {
checkArrayBounds(bytes, offset, length);
return compareTo(this.buffer, this.offset, this.length, bytes, offset, length);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int compareTo(final ByteSequence o) {
if (this == o) {
return 0;
@@ -608,17 +604,13 @@
return -o.compareTo(buffer, offset, length);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public byte[] copyTo(final byte[] bytes) {
copyTo(bytes, 0);
return bytes;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public byte[] copyTo(final byte[] bytes, final int offset) {
if (offset < 0) {
throw new IndexOutOfBoundsException();
@@ -627,25 +619,19 @@
return bytes;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteStringBuilder copyTo(final ByteStringBuilder builder) {
builder.append(buffer, offset, length);
return builder;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public OutputStream copyTo(final OutputStream stream) throws IOException {
stream.write(buffer, offset, length);
return stream;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean equals(final byte[] bytes, final int offset, final int length) {
checkArrayBounds(bytes, offset, length);
return equals(this.buffer, this.offset, this.length, bytes, offset, length);
@@ -690,16 +676,12 @@
return length == 0;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int length() {
return length;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString subSequence(final int start, final int end) {
if (start < 0 || start > end || end > length) {
throw new IndexOutOfBoundsException();
@@ -707,9 +689,7 @@
return new ByteString(buffer, offset + start, end - start);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String toBase64String() {
return Base64.encode(this);
}
@@ -812,16 +792,12 @@
return builder.toString();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public byte[] toByteArray() {
return copyTo(new byte[length]);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString toByteString() {
return this;
}
@@ -885,9 +861,7 @@
return v;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
return toString(buffer, offset, length);
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/CachedConnectionPool.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/CachedConnectionPool.java
index be10be2..94e0acb 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/CachedConnectionPool.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/CachedConnectionPool.java
@@ -563,7 +563,7 @@
return builder.toString();
}
- // Checks that this pooled connection has not been closed.
+ /** Checks that this pooled connection has not been closed. */
private Connection checkState() {
if (isClosed()) {
throw new IllegalStateException();
@@ -865,7 +865,7 @@
close();
}
- // Package private for unit testing.
+ /** Package private for unit testing. */
int currentPoolSize() {
return maxPoolSize - availableConnections.availablePermits();
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/CommonLDAPOptions.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/CommonLDAPOptions.java
index e1b68e7..cff3107 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/CommonLDAPOptions.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/CommonLDAPOptions.java
@@ -31,7 +31,7 @@
* Common options for LDAP clients and listeners.
*/
abstract class CommonLDAPOptions<T extends CommonLDAPOptions<T>> {
- // Default values for options taken from Java properties.
+ /** Default values for options taken from Java properties. */
private static final boolean DEFAULT_TCP_NO_DELAY;
private static final boolean DEFAULT_REUSE_ADDRESS;
private static final boolean DEFAULT_KEEPALIVE;
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/ConditionResult.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/ConditionResult.java
index 35d2251..af359b3 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/ConditionResult.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/ConditionResult.java
@@ -50,17 +50,17 @@
*/
TRUE("true");
- // Boolean -> ConditionResult map.
+ /** Boolean -> ConditionResult map. */
private static final boolean[] BOOLEAN_MAP = { false, false, true };
- // AND truth table.
+ /** AND truth table. */
private static final ConditionResult[][] LOGICAL_AND = { { FALSE, FALSE, FALSE },
{ FALSE, UNDEFINED, UNDEFINED }, { FALSE, UNDEFINED, TRUE }, };
- // NOT truth table.
+ /** NOT truth table. */
private static final ConditionResult[] LOGICAL_NOT = { TRUE, UNDEFINED, FALSE };
- // OR truth table.
+ /** OR truth table. */
private static final ConditionResult[][] LOGICAL_OR = { { FALSE, UNDEFINED, TRUE },
{ UNDEFINED, UNDEFINED, TRUE }, { TRUE, TRUE, TRUE }, };
@@ -214,10 +214,10 @@
return b ? TRUE : FALSE;
}
- // The human-readable name for this result.
+ /** The human-readable name for this result. */
private final String resultName;
- // Prevent instantiation.
+ /** Prevent instantiation. */
private ConditionResult(final String resultName) {
this.resultName = resultName;
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Connections.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Connections.java
index e4a5a1a..43fc6f1 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Connections.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Connections.java
@@ -724,7 +724,7 @@
}
}
- // Prevent instantiation.
+ /** Prevent instantiation. */
private Connections() {
// Do nothing.
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/DN.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/DN.java
index c0612ba..376dc84 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/DN.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/DN.java
@@ -67,17 +67,17 @@
public final class DN implements Iterable<RDN>, Comparable<DN> {
private static final DN ROOT_DN = new DN(null, null, "");
- // This is the size of the per-thread per-schema DN cache. We should
- // be conservative here in case there are many threads. We will only
- // cache parent DNs, so there's no need for it to be big.
+ /**
+ * This is the size of the per-thread per-schema DN cache. We should
+ * be conservative here in case there are many threads. We will only
+ * cache parent DNs, so there's no need for it to be big.
+ */
private static final int DN_CACHE_SIZE = 32;
private static final ThreadLocal<WeakHashMap<Schema, Map<String, DN>>> CACHE =
new ThreadLocal<WeakHashMap<Schema, Map<String, DN>>>() {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected WeakHashMap<Schema, Map<String, DN>> initialValue() {
return new WeakHashMap<Schema, Map<String, DN>>();
@@ -307,7 +307,7 @@
return 0;
}
- // Decodes a DN using the provided reader and schema.
+ /** Decodes a DN using the provided reader and schema. */
private static DN decode(final String dnString, final SubstringReader reader,
final Schema schema, final Map<String, DN> cache) {
reader.skipWhitespaces();
@@ -368,16 +368,18 @@
private final int size;
- // We need to store the original string value if provided in order to
- // preserve the original whitespace.
+ /**
+ * We need to store the original string value if provided in order to
+ * preserve the original whitespace.
+ */
private String stringValue;
- // Private constructor.
+ /** Private constructor. */
private DN(final DN parent, final RDN rdn, final String stringValue) {
this(parent, rdn, stringValue, parent != null ? parent.size + 1 : 0);
}
- // Private constructor.
+ /** Private constructor. */
private DN(final DN parent, final RDN rdn, final String stringValue, final int size) {
this.parent = parent;
this.rdn = rdn;
@@ -479,16 +481,12 @@
return child(new RDN(attributeType, attributeValue));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int compareTo(final DN dn) {
return compareTo(this, dn);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean equals(final Object obj) {
if (this == obj) {
@@ -509,9 +507,7 @@
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
if (size == 0) {
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/DecodeException.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/DecodeException.java
index bd70db8..0793917 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/DecodeException.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/DecodeException.java
@@ -93,7 +93,7 @@
private final boolean isFatal;
- // Construction is provided via factory methods.
+ /** Construction is provided via factory methods. */
private DecodeException(final LocalizableMessage message, final boolean isFatal,
final Throwable cause) {
super(message.toString(), cause);
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/DecodeOptions.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/DecodeOptions.java
index d85035a..1a4ae12 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/DecodeOptions.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/DecodeOptions.java
@@ -52,9 +52,7 @@
this.schema = schema;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Schema resolveSchema(final String dn) {
return schema;
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/DereferenceAliasesPolicy.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/DereferenceAliasesPolicy.java
index 3006a7b..de0302d 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/DereferenceAliasesPolicy.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/DereferenceAliasesPolicy.java
@@ -126,15 +126,13 @@
private final String name;
- // Prevent direct instantiation.
+ /** Prevent direct instantiation. */
private DereferenceAliasesPolicy(final int intValue, final String name) {
this.intValue = intValue;
this.name = name;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean equals(final Object obj) {
if (this == obj) {
@@ -146,9 +144,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
return intValue;
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Entries.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Entries.java
index dd5751d..5b58ad8 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Entries.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Entries.java
@@ -208,26 +208,20 @@
this.entry = entry;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean addAttribute(final Attribute attribute) {
throw new UnsupportedOperationException();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean addAttribute(final Attribute attribute,
final Collection<? super ByteString> duplicateValues) {
throw new UnsupportedOperationException();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Entry addAttribute(final String attributeDescription, final Object... values) {
throw new UnsupportedOperationException();
@@ -249,9 +243,7 @@
return entry.containsAttribute(attributeDescription, values);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean equals(final Object object) {
return (object == this || entry.equals(object));
@@ -269,9 +261,7 @@
.getAllAttributes(attributeDescription), UNMODIFIABLE_ATTRIBUTE_FUNCTION));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Iterable<Attribute> getAllAttributes(final String attributeDescription) {
return Iterables.unmodifiableIterable(Iterables.transformedIterable(entry
@@ -288,9 +278,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Attribute getAttribute(final String attributeDescription) {
final Attribute attribute = entry.getAttribute(attributeDescription);
@@ -306,41 +294,31 @@
return entry.getAttributeCount();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public DN getName() {
return entry.getName();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
return entry.hashCode();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public AttributeParser parseAttribute(final AttributeDescription attributeDescription) {
return entry.parseAttribute(attributeDescription);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public AttributeParser parseAttribute(final String attributeDescription) {
return entry.parseAttribute(attributeDescription);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean removeAttribute(final Attribute attribute,
final Collection<? super ByteString> missingValues) {
@@ -352,25 +330,19 @@
throw new UnsupportedOperationException();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Entry removeAttribute(final String attributeDescription, final Object... values) {
throw new UnsupportedOperationException();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean replaceAttribute(final Attribute attribute) {
throw new UnsupportedOperationException();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Entry replaceAttribute(final String attributeDescription, final Object... values) {
throw new UnsupportedOperationException();
@@ -381,17 +353,13 @@
throw new UnsupportedOperationException();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Entry setName(final String dn) {
throw new UnsupportedOperationException();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
return entry.toString();
@@ -1165,7 +1133,7 @@
}
}
- // Prevent instantiation.
+ /** Prevent instantiation. */
private Entries() {
// Nothing to do.
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/FailoverLoadBalancingAlgorithm.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/FailoverLoadBalancingAlgorithm.java
index 6a8da1e..2ce96b0 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/FailoverLoadBalancingAlgorithm.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/FailoverLoadBalancingAlgorithm.java
@@ -174,17 +174,13 @@
this(factories, null, interval, unit, scheduler);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
String getAlgorithmName() {
return "Failover";
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
int getInitialConnectionFactoryIndex() {
// Always start with the first connection factory.
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Filter.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Filter.java
index 3c3b2cb..5e2ac4a 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Filter.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Filter.java
@@ -284,10 +284,10 @@
}
- // RFC 4526 - FALSE filter.
+ /** RFC 4526 - FALSE filter. */
private static final Filter FALSE = new Filter(new OrImpl(Collections.<Filter> emptyList()));
- // Heavily used (objectClass=*) filter.
+ /** Heavily used (objectClass=*) filter. */
private static final Filter OBJECT_CLASS_PRESENT = new Filter(new PresentImpl("objectClass"));
private static final FilterVisitor<StringBuilder, StringBuilder> TO_STRING_VISITOR =
@@ -426,7 +426,7 @@
}
};
- // RFC 4526 - TRUE filter.
+ /** RFC 4526 - TRUE filter. */
private static final Filter TRUE = new Filter(new AndImpl(Collections.<Filter> emptyList()));
/**
@@ -955,7 +955,7 @@
return valueOf(filterString);
}
- // Converts an assertion value to a substring filter.
+ /** Converts an assertion value to a substring filter. */
private static Filter assertionValue2SubstringFilter(final String filterString,
final String attrType, final int equalPos, final int endPos) {
// Get a binary representation of the value.
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Functions.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Functions.java
index 304391b..a121007 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Functions.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Functions.java
@@ -409,7 +409,7 @@
return BYTESTRING_TO_STRING;
}
- // Prevent instantiation
+ /** Prevent instantiation. */
private Functions() {
// Do nothing.
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/GeneralizedTime.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/GeneralizedTime.java
index 6d00abf..7d08f0f 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/GeneralizedTime.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/GeneralizedTime.java
@@ -55,7 +55,7 @@
*/
public final class GeneralizedTime implements Comparable<GeneralizedTime> {
- // UTC TimeZone is assumed to never change over JVM lifetime
+ /** UTC TimeZone is assumed to never change over JVM lifetime. */
private static final TimeZone TIME_ZONE_UTC_OBJ = TimeZone.getTimeZone("UTC");
/**
@@ -793,7 +793,7 @@
return TimeZone.getTimeZone("GMT" + offSetStr);
}
- // Lazily constructed internal representations.
+ /** Lazily constructed internal representations. */
private volatile Calendar calendar;
private volatile Date date;
private volatile String stringValue;
@@ -807,9 +807,7 @@
this.stringValue = stringValue;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compareTo(final GeneralizedTime o) {
final Long timeMS1 = getTimeInMillis();
@@ -817,9 +815,7 @@
return timeMS1.compareTo(timeMS2);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean equals(final Object obj) {
if (this == obj) {
@@ -851,9 +847,7 @@
return tmpTimeMS;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
return ((Long) getTimeInMillis()).hashCode();
@@ -888,9 +882,7 @@
return (Date) tmpDate.clone();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
String tmpString = stringValue;
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/InternalConnection.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/InternalConnection.java
index 9e8dd16..dafd540 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/InternalConnection.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/InternalConnection.java
@@ -73,9 +73,7 @@
this.serverConnection = serverConnection;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LdapPromise<Void> abandonAsync(final AbandonRequest request) {
final int i = messageID.getAndIncrement();
@@ -83,9 +81,7 @@
return newSuccessfulLdapPromise((Void) null, i);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LdapPromise<Result> addAsync(final AddRequest request,
final IntermediateResponseHandler intermediateResponseHandler) {
@@ -96,18 +92,14 @@
return promise;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void addConnectionEventListener(final ConnectionEventListener listener) {
Reject.ifNull(listener);
listeners.add(listener);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LdapPromise<BindResult> bindAsync(final BindRequest request,
final IntermediateResponseHandler intermediateResponseHandler) {
@@ -118,18 +110,14 @@
return promise;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void close(final UnbindRequest request, final String reason) {
final int i = messageID.getAndIncrement();
serverConnection.handleConnectionClosed(i, request);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LdapPromise<CompareResult> compareAsync(final CompareRequest request,
final IntermediateResponseHandler intermediateResponseHandler) {
@@ -140,9 +128,7 @@
return promise;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LdapPromise<Result> deleteAsync(final DeleteRequest request,
final IntermediateResponseHandler intermediateResponseHandler) {
@@ -153,9 +139,7 @@
return promise;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R extends ExtendedResult> LdapPromise<R> extendedRequestAsync(final ExtendedRequest<R> request,
final IntermediateResponseHandler intermediateResponseHandler) {
@@ -166,27 +150,21 @@
return promise;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isClosed() {
// FIXME: this should be true after close has been called.
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isValid() {
// FIXME: this should be false if this connection is disconnected.
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LdapPromise<Result> modifyAsync(final ModifyRequest request,
final IntermediateResponseHandler intermediateResponseHandler) {
@@ -197,9 +175,7 @@
return promise;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LdapPromise<Result> modifyDNAsync(final ModifyDNRequest request,
final IntermediateResponseHandler intermediateResponseHandler) {
@@ -210,18 +186,14 @@
return promise;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void removeConnectionEventListener(final ConnectionEventListener listener) {
Reject.ifNull(listener);
listeners.remove(listener);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LdapPromise<Result> searchAsync(final SearchRequest request,
final IntermediateResponseHandler intermediateResponseHandler, final SearchResultHandler entryHandler) {
@@ -232,9 +204,7 @@
return promise;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/KeyManagers.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/KeyManagers.java
index d4e59fe..7504772 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/KeyManagers.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/KeyManagers.java
@@ -66,9 +66,7 @@
this.alias = alias;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String chooseClientAlias(final String[] keyType, final Principal[] issuers,
final Socket socket) {
for (final String type : keyType) {
@@ -85,9 +83,7 @@
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String chooseEngineClientAlias(final String[] keyType, final Principal[] issuers,
final SSLEngine engine) {
@@ -105,9 +101,7 @@
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String chooseEngineServerAlias(final String keyType, final Principal[] issuers,
final SSLEngine engine) {
@@ -123,9 +117,7 @@
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String chooseServerAlias(final String keyType, final Principal[] issuers,
final Socket socket) {
final String[] serverAliases = keyManager.getServerAliases(keyType, issuers);
@@ -140,30 +132,22 @@
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public X509Certificate[] getCertificateChain(final String alias) {
return keyManager.getCertificateChain(alias);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String[] getClientAliases(final String keyType, final Principal[] issuers) {
return keyManager.getClientAliases(keyType, issuers);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public PrivateKey getPrivateKey(final String alias) {
return keyManager.getPrivateKey(alias);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String[] getServerAliases(final String keyType, final Principal[] issuers) {
return keyManager.getServerAliases(keyType, issuers);
}
@@ -316,7 +300,7 @@
return new SelectCertificate(keyManager, alias);
}
- // Prevent insantiation.
+ /** Prevent insantiation. */
private KeyManagers() {
// Nothing to do.
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LDAPConnectionFactory.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LDAPConnectionFactory.java
index 24d26b0..2c9ce2b 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LDAPConnectionFactory.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LDAPConnectionFactory.java
@@ -39,13 +39,13 @@
* Server.
*/
public final class LDAPConnectionFactory implements ConnectionFactory {
- /*
+ /**
* We implement the factory using the pimpl idiom in order to avoid making
* too many implementation classes public.
*/
private final LDAPConnectionFactoryImpl impl;
- /*
+ /**
* Transport provider that provides the implementation of this factory.
*/
private final TransportProvider provider;
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LDAPListener.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LDAPListener.java
index c410a01..736de1d 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LDAPListener.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LDAPListener.java
@@ -94,11 +94,13 @@
*/
public final class LDAPListener implements Closeable {
- // We implement the factory using the pimpl idiom in order have
- // cleaner Javadoc which does not expose implementation methods.
+ /**
+ * We implement the factory using the pimpl idiom in order have
+ * cleaner Javadoc which does not expose implementation methods.
+ */
private final LDAPListenerImpl impl;
- /*
+ /**
* Transport provider that provides the implementation of this listener.
*/
private TransportProvider provider;
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LDAPOptions.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LDAPOptions.java
index c399e49..a3c5737 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LDAPOptions.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LDAPOptions.java
@@ -55,7 +55,7 @@
* </pre>
*/
public final class LDAPOptions extends CommonLDAPOptions<LDAPOptions> {
- // Default values for options taken from Java properties.
+ /** Default values for options taken from Java properties. */
private static final long DEFAULT_TIMEOUT;
private static final long DEFAULT_CONNECT_TIMEOUT;
static {
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LDAPUrl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LDAPUrl.java
index fc095bc..4dc93d6 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LDAPUrl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LDAPUrl.java
@@ -627,9 +627,7 @@
return request;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override()
public boolean equals(final Object o) {
if (o == this) {
@@ -706,9 +704,7 @@
return scope;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
final String s = toNormalizedString();
@@ -726,9 +722,7 @@
return isSecured;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
return urlString;
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LinkedAttribute.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LinkedAttribute.java
index b60b491..2ef73cf 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LinkedAttribute.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/LinkedAttribute.java
@@ -653,77 +653,59 @@
add(values);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean add(final ByteString value) {
Reject.ifNull(value);
return pimpl.add(this, value);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void clear() {
pimpl.clear(this);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean contains(final Object value) {
Reject.ifNull(value);
return pimpl.contains(this, ByteString.valueOf(value));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean containsAll(final Collection<?> values) {
Reject.ifNull(values);
return pimpl.containsAll(this, values);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ByteString firstValue() {
return pimpl.firstValue(this);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public AttributeDescription getAttributeDescription() {
return attributeDescription;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Iterator<ByteString> iterator() {
return pimpl.iterator(this);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean remove(final Object value) {
Reject.ifNull(value);
return pimpl.remove(this, ByteString.valueOf(value));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <T> boolean retainAll(final Collection<T> values,
final Collection<? super T> missingValues) {
@@ -731,15 +713,13 @@
return pimpl.retainAll(this, values, missingValues);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int size() {
return pimpl.size(this);
}
- // Lazily computes the normalized single value.
+ /** Lazily computes the normalized single value. */
private ByteString normalizedSingleValue() {
if (normalizedSingleValue == null) {
normalizedSingleValue = normalizeValue(this, singleValue);
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Modification.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Modification.java
index c701f4b..18cadc0 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Modification.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/Modification.java
@@ -76,9 +76,7 @@
return modificationType;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/ModificationType.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/ModificationType.java
index 331e05c..f125ff3 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/ModificationType.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/ModificationType.java
@@ -148,16 +148,14 @@
private final Enum modificationTypeEnum;
- // Prevent direct instantiation.
+ /** Prevent direct instantiation. */
private ModificationType(final int intValue, final String name, final Enum modificationTypeEnum) {
this.intValue = intValue;
this.name = name;
this.modificationTypeEnum = modificationTypeEnum;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean equals(final Object obj) {
if (this == obj) {
@@ -169,9 +167,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
return intValue;
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/RDN.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/RDN.java
index f9da8c3..cacedbf 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/RDN.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/RDN.java
@@ -73,8 +73,10 @@
*/
public final class RDN implements Iterable<AVA>, Comparable<RDN> {
- // A constant holding a special RDN having zero AVAs and which always
- // compares greater than any other RDN other than itself.
+ /**
+ * A constant holding a special RDN having zero AVAs and which always
+ * compares greater than any other RDN other than itself.
+ */
private static final RDN MAX_VALUE = new RDN(new AVA[0], "");
/**
@@ -172,11 +174,13 @@
}
}
- // In original order.
+ /** In original order. */
private final AVA[] avas;
- // We need to store the original string value if provided in order to
- // preserve the original whitespace.
+ /**
+ * We need to store the original string value if provided in order to
+ * preserve the original whitespace.
+ */
private String stringValue;
/**
@@ -248,9 +252,7 @@
this.stringValue = stringValue;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int compareTo(final RDN rdn) {
// Identity.
if (this == rdn) {
@@ -297,9 +299,7 @@
return 0;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean equals(final Object obj) {
if (this == obj) {
@@ -338,9 +338,7 @@
return avas[0];
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
// Avoid an algorithm that requires the AVAs to be sorted.
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/RequestHandlerFactoryAdapter.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/RequestHandlerFactoryAdapter.java
index 93dafbe..6ba3194 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/RequestHandlerFactoryAdapter.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/RequestHandlerFactoryAdapter.java
@@ -78,7 +78,7 @@
private static class RequestContextImpl<S extends Result, H extends ResultHandler<S>>
implements RequestContext, ResultHandler<S> {
- /*
+ /**
* Adapter class which invokes cancel result handlers with correct
* result type.
*/
@@ -108,30 +108,30 @@
}
private static enum RequestState {
- // Request active, cancel requested
+ /** Request active, cancel requested. */
CANCEL_REQUESTED,
- // Result sent, was cancelled
+ /** Result sent, was cancelled. */
CANCELLED,
- // Request active
+ /** Request active. */
PENDING,
- // Result sent, not cancelled
+ /** Result sent, not cancelled. */
RESULT_SENT,
- // Request active, too late to cancel
+ /** Request active, too late to cancel. */
TOO_LATE;
}
protected final H resultHandler;
- // These should be notified when a cancel request arrives, at most once.
+ /** These should be notified when a cancel request arrives, at most once. */
private List<CancelRequestListener> cancelRequestListeners = null;
private LocalizableMessage cancelRequestReason = null;
- // These should be notified when the result is set.
+ /** These should be notified when the result is set. */
private List<ExtendedResultHandlerHolder<?>> cancelResultHandlers = null;
private final ServerConnectionImpl clientConnection;
@@ -144,7 +144,7 @@
private RequestState state = RequestState.PENDING;
- // Cancellation state guarded by lock.
+ /** Cancellation state guarded by lock. */
private final Object stateLock = new Object();
protected RequestContextImpl(final ServerConnectionImpl clientConnection,
@@ -155,9 +155,7 @@
this.isCancelSupported = isCancelSupported;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void addCancelRequestListener(final CancelRequestListener listener) {
Reject.ifNull(listener);
@@ -191,9 +189,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void checkIfCancelled(final boolean signalTooLate) throws CancelledResultException {
synchronized (stateLock) {
@@ -226,17 +222,13 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int getMessageID() {
return messageID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleError(final LdapException error) {
if (clientConnection.removePendingRequest(this)) {
@@ -252,9 +244,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleResult(final S result) {
if (clientConnection.removePendingRequest(this)) {
@@ -270,9 +260,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void removeCancelRequestListener(final CancelRequestListener listener) {
Reject.ifNull(listener);
@@ -456,17 +444,13 @@
this.entryHandler = entryHandler;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean handleEntry(final SearchResultEntry entry) {
return entryHandler.handleEntry(entry);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean handleReference(final SearchResultReference reference) {
return entryHandler.handleReference(reference);
@@ -483,9 +467,7 @@
this.requestHandler = requestHandler;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleAbandon(final Integer messageID, final AbandonRequest request) {
final RequestContextImpl<?, ?> abandonedRequest =
@@ -497,9 +479,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleAdd(final Integer messageID, final AddRequest request,
final IntermediateResponseHandler intermediateResponseHandler,
@@ -513,9 +493,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleBind(final Integer messageID, final int version,
final BindRequest request,
@@ -530,9 +508,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleCompare(final Integer messageID, final CompareRequest request,
final IntermediateResponseHandler intermediateResponseHandler,
@@ -546,36 +522,28 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleConnectionClosed(final Integer messageID, final UnbindRequest request) {
final LocalizableMessage cancelReason = INFO_CANCELED_BY_CLIENT_DISCONNECT.get();
doClose(cancelReason);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleConnectionDisconnected(final ResultCode resultCode, final String message) {
final LocalizableMessage cancelReason = INFO_CANCELED_BY_SERVER_DISCONNECT.get();
doClose(cancelReason);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleConnectionError(final Throwable error) {
final LocalizableMessage cancelReason = INFO_CANCELED_BY_CLIENT_ERROR.get();
doClose(cancelReason);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleDelete(final Integer messageID, final DeleteRequest request,
final IntermediateResponseHandler intermediateResponseHandler,
@@ -589,9 +557,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R extends ExtendedResult> void handleExtendedRequest(final Integer messageID,
final ExtendedRequest<R> request,
@@ -655,9 +621,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleModify(final Integer messageID, final ModifyRequest request,
final IntermediateResponseHandler intermediateResponseHandler,
@@ -671,9 +635,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleModifyDN(final Integer messageID, final ModifyDNRequest request,
final IntermediateResponseHandler intermediateResponseHandler,
@@ -687,9 +649,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleSearch(final Integer messageID, final SearchRequest request,
final IntermediateResponseHandler intermediateResponseHandler, final SearchResultHandler entryHandler,
@@ -802,9 +762,7 @@
this.factory = factory;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ServerConnection<Integer> handleAccept(final C clientContext) throws LdapException {
return adaptRequestHandler(factory.handleAccept(clientContext));
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/ResultCode.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/ResultCode.java
index 37b6010..fa24936 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/ResultCode.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/ResultCode.java
@@ -924,7 +924,7 @@
private final Enum resultCodeEnum;
- // Prevent direct instantiation.
+ /** Prevent direct instantiation. */
private ResultCode(final int intValue, final LocalizableMessage name, final boolean exceptional,
final Enum resultCodeEnum) {
this.intValue = intValue;
@@ -933,9 +933,7 @@
this.resultCodeEnum = resultCodeEnum;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean equals(final Object obj) {
if (this == obj) {
@@ -956,9 +954,7 @@
return name;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
return intValue;
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/RoundRobinLoadBalancingAlgorithm.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/RoundRobinLoadBalancingAlgorithm.java
index 2ec126e..d51d51c 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/RoundRobinLoadBalancingAlgorithm.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/RoundRobinLoadBalancingAlgorithm.java
@@ -176,17 +176,13 @@
this(factories, null, interval, unit, scheduler);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
String getAlgorithmName() {
return "RoundRobin";
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
int getInitialConnectionFactoryIndex() {
// A round robin pool of one connection factories is unlikely in
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/SSLContextBuilder.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/SSLContextBuilder.java
index 2a32f13..ff8f26e 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/SSLContextBuilder.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/SSLContextBuilder.java
@@ -99,7 +99,7 @@
private String protocol = PROTOCOL_TLS1;
private SecureRandom random = null;
- // These are mutually exclusive.
+ /** These are mutually exclusive. */
private Provider provider = null;
private String providerName = null;
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/SearchScope.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/SearchScope.java
index 94fc522..94e8b4c 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/SearchScope.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/SearchScope.java
@@ -167,16 +167,14 @@
private final Enum searchScopeEnum;
- // Prevent direct instantiation.
+ /** Prevent direct instantiation. */
private SearchScope(final int intValue, final String name, Enum searchScopeEnum) {
this.intValue = intValue;
this.name = name;
this.searchScopeEnum = searchScopeEnum;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean equals(final Object obj) {
if (this == obj) {
@@ -188,9 +186,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
return intValue;
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/TrustManagers.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/TrustManagers.java
index 300de7e..a2e2a83 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/TrustManagers.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/TrustManagers.java
@@ -68,27 +68,21 @@
this.hostNamePattern = hostNamePattern;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void checkClientTrusted(final X509Certificate[] chain, final String authType)
throws CertificateException {
verifyHostName(chain);
trustManager.checkClientTrusted(chain, authType);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void checkServerTrusted(final X509Certificate[] chain, final String authType)
throws CertificateException {
verifyHostName(chain);
trustManager.checkServerTrusted(chain, authType);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public X509Certificate[] getAcceptedIssuers() {
return trustManager.getAcceptedIssuers();
}
@@ -152,27 +146,21 @@
this.trustManager = trustManager;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void checkClientTrusted(final X509Certificate[] chain, final String authType)
throws CertificateException {
verifyExpiration(chain);
trustManager.checkClientTrusted(chain, authType);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void checkServerTrusted(final X509Certificate[] chain, final String authType)
throws CertificateException {
verifyExpiration(chain);
trustManager.checkServerTrusted(chain, authType);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public X509Certificate[] getAcceptedIssuers() {
return trustManager.getAcceptedIssuers();
}
@@ -203,33 +191,27 @@
* An X509TrustManager which does not trust any certificates.
*/
private static final class DistrustAll implements X509TrustManager {
- // Single instance.
+ /** Single instance. */
private static final DistrustAll INSTANCE = new DistrustAll();
- // Prevent instantiation.
+ /** Prevent instantiation. */
private DistrustAll() {
// Nothing to do.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void checkClientTrusted(final X509Certificate[] chain, final String authType)
throws CertificateException {
throw new CertificateException();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void checkServerTrusted(final X509Certificate[] chain, final String authType)
throws CertificateException {
throw new CertificateException();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public X509Certificate[] getAcceptedIssuers() {
return new X509Certificate[0];
}
@@ -240,31 +222,25 @@
*/
private static final class TrustAll implements X509TrustManager {
- // Single instance.
+ /** Single instance. */
private static final TrustAll INSTANCE = new TrustAll();
- // Prevent instantiation.
+ /** Prevent instantiation. */
private TrustAll() {
// Nothing to do.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void checkClientTrusted(final X509Certificate[] chain, final String authType)
throws CertificateException {
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void checkServerTrusted(final X509Certificate[] chain, final String authType)
throws CertificateException {
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public X509Certificate[] getAcceptedIssuers() {
return new X509Certificate[0];
}
@@ -420,7 +396,7 @@
return TrustAll.INSTANCE;
}
- // Prevent insantiation.
+ /** Prevent insantiation. */
private TrustManagers() {
// Nothing to do.
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ADNotificationRequestControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ADNotificationRequestControl.java
index 1a43255..9f5a06d 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ADNotificationRequestControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ADNotificationRequestControl.java
@@ -134,41 +134,31 @@
return new ADNotificationRequestControl(isCritical);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ByteString getValue() {
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean hasValue() {
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/AssertionRequestControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/AssertionRequestControl.java
index 1bf6fe5..f75cbac 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/AssertionRequestControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/AssertionRequestControl.java
@@ -142,12 +142,12 @@
return new AssertionRequestControl(isCritical, filter);
}
- // The assertion filter.
+ /** The assertion filter. */
private final Filter filter;
private final boolean isCritical;
- // Prevent direct instantiation.
+ /** Prevent direct instantiation. */
private AssertionRequestControl(final boolean isCritical, final Filter filter) {
Reject.ifNull(filter);
this.isCritical = isCritical;
@@ -163,16 +163,12 @@
return filter;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
final ByteStringBuilder buffer = new ByteStringBuilder();
final ASN1Writer writer = ASN1.getWriter(buffer);
@@ -185,23 +181,17 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/AuthorizationIdentityRequestControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/AuthorizationIdentityRequestControl.java
index 35053be..bd1dd4d 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/AuthorizationIdentityRequestControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/AuthorizationIdentityRequestControl.java
@@ -131,42 +131,32 @@
return isCritical ? CRITICAL_INSTANCE : NONCRITICAL_INSTANCE;
}
- // Prevent direct instantiation.
+ /** Prevent direct instantiation. */
private AuthorizationIdentityRequestControl(final boolean isCritical) {
this.isCritical = isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/AuthorizationIdentityResponseControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/AuthorizationIdentityResponseControl.java
index c60cd80..bd0d774 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/AuthorizationIdentityResponseControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/AuthorizationIdentityResponseControl.java
@@ -96,7 +96,7 @@
return new AuthorizationIdentityResponseControl(false, authorizationID);
}
- // The authorization ID for this control.
+ /** The authorization ID for this control. */
private final String authorizationID;
private final boolean isCritical;
@@ -137,7 +137,7 @@
}
};
- // Prevent direct instantiation.
+ /** Prevent direct instantiation. */
private AuthorizationIdentityResponseControl(final boolean isCritical,
final String authorizationID) {
Reject.ifNull(authorizationID);
@@ -157,37 +157,27 @@
return authorizationID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
return ByteString.valueOf(authorizationID);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/EntryChangeNotificationResponseControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/EntryChangeNotificationResponseControl.java
index 447cfa7..84c4409 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/EntryChangeNotificationResponseControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/EntryChangeNotificationResponseControl.java
@@ -249,13 +249,13 @@
changeNumber);
}
- // The previous DN for this change notification control.
+ /** The previous DN for this change notification control. */
private final DN previousName;
- // The change number for this change notification control.
+ /** The change number for this change notification control. */
private final long changeNumber;
- // The change type for this change notification control.
+ /** The change type for this change notification control. */
private final PersistentSearchChangeType changeType;
private final boolean isCritical;
@@ -289,9 +289,7 @@
return changeType;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
@@ -307,9 +305,7 @@
return previousName;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
final ByteStringBuilder buffer = new ByteStringBuilder();
final ASN1Writer writer = ASN1.getWriter(buffer);
@@ -332,23 +328,17 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/GenericControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/GenericControl.java
index 7329289..81856dc 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/GenericControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/GenericControl.java
@@ -119,7 +119,7 @@
private final ByteString value;
- // Prevent direct instantiation.
+ /** Prevent direct instantiation. */
private GenericControl(final String oid, final boolean isCritical, final ByteString value) {
Reject.ifNull(oid);
this.oid = oid;
@@ -127,37 +127,27 @@
this.value = value;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return oid;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
return value;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return value != null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/GetEffectiveRightsRequestControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/GetEffectiveRightsRequestControl.java
index 52df26f..2a11679 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/GetEffectiveRightsRequestControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/GetEffectiveRightsRequestControl.java
@@ -285,11 +285,10 @@
return new GetEffectiveRightsRequestControl(isCritical, dn, copyOfAttributes);
}
- // The DN representing the authzId (may be null meaning use the client's
- // DN).
+ /** The DN representing the authzId (may be null meaning use the client's DN). */
private final DN authorizationName;
- // The unmodifiable list of attributes to be queried (may be empty).
+ /** The unmodifiable list of attributes to be queried (may be empty). */
private final Collection<AttributeType> attributes;
private final boolean isCritical;
@@ -325,16 +324,12 @@
return authorizationName;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
final ByteStringBuilder buffer = new ByteStringBuilder();
final ASN1Writer writer = ASN1.getWriter(buffer);
@@ -359,23 +354,17 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return authorizationName != null || !attributes.isEmpty();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ManageDsaITRequestControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ManageDsaITRequestControl.java
index 266d2a2..41b62dd 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ManageDsaITRequestControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ManageDsaITRequestControl.java
@@ -138,37 +138,27 @@
this.isCritical = isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/MatchedValuesRequestControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/MatchedValuesRequestControl.java
index 872982e..591fd60 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/MatchedValuesRequestControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/MatchedValuesRequestControl.java
@@ -321,16 +321,12 @@
return filters;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ByteString getValue() {
final ByteStringBuilder buffer = new ByteStringBuilder();
@@ -348,23 +344,17 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordExpiredResponseControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordExpiredResponseControl.java
index d607850..b768e62 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordExpiredResponseControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordExpiredResponseControl.java
@@ -135,37 +135,27 @@
this.isCritical = isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
return CONTROL_VALUE;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordExpiringResponseControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordExpiringResponseControl.java
index eb45134..00753c8 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordExpiringResponseControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordExpiringResponseControl.java
@@ -133,7 +133,7 @@
return new PasswordExpiringResponseControl(false, secondsUntilExpiration);
}
- // The length of time in seconds until the password actually expires.
+ /** The length of time in seconds until the password actually expires. */
private final int secondsUntilExpiration;
private final boolean isCritical;
@@ -144,9 +144,7 @@
this.secondsUntilExpiration = secondsUntilExpiration;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
@@ -162,30 +160,22 @@
return secondsUntilExpiration;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
return ByteString.valueOf(String.valueOf(secondsUntilExpiration));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordPolicyErrorType.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordPolicyErrorType.java
index b31a9c2..acbeaf5 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordPolicyErrorType.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordPolicyErrorType.java
@@ -96,9 +96,7 @@
this.name = name;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
return name;
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordPolicyRequestControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordPolicyRequestControl.java
index f2b0210..5b10e70 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordPolicyRequestControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordPolicyRequestControl.java
@@ -151,37 +151,27 @@
this.isCritical = isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordPolicyResponseControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordPolicyResponseControl.java
index 33814df..be9cbe2 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordPolicyResponseControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordPolicyResponseControl.java
@@ -289,16 +289,12 @@
return errorType;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
final ByteStringBuilder buffer = new ByteStringBuilder();
final ASN1Writer writer = ASN1.getWriter(buffer);
@@ -343,23 +339,17 @@
return warningValue;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordPolicyWarningType.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordPolicyWarningType.java
index f499247..6cabb11 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordPolicyWarningType.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PasswordPolicyWarningType.java
@@ -60,9 +60,7 @@
this.name = name;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
return name;
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PermissiveModifyRequestControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PermissiveModifyRequestControl.java
index 6141782..25e45cf 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PermissiveModifyRequestControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PermissiveModifyRequestControl.java
@@ -136,37 +136,27 @@
this.isCritical = isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PersistentSearchChangeType.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PersistentSearchChangeType.java
index 07cbe7c..b4e7068 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PersistentSearchChangeType.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PersistentSearchChangeType.java
@@ -69,9 +69,7 @@
this.intValue = intValue;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
return name;
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PersistentSearchRequestControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PersistentSearchRequestControl.java
index 8cd4eaf..4f51e35 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PersistentSearchRequestControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PersistentSearchRequestControl.java
@@ -253,15 +253,19 @@
return newControl(isCritical, changesOnly, returnECs, Arrays.asList(changeTypes));
}
- // Indicates whether to only return entries that have been updated
- // since the beginning of the search.
+ /**
+ * Indicates whether to only return entries that have been updated
+ * since the beginning of the search.
+ */
private final boolean changesOnly;
- // Indicates whether entries returned as a result of changes to
- // directory data should include the entry change notification control.
+ /**
+ * Indicates whether entries returned as a result of changes to
+ * directory data should include the entry change notification control.
+ */
private final boolean returnECs;
- // The logical OR of change types associated with this control.
+ /** The logical OR of change types associated with this control. */
private final Set<PersistentSearchChangeType> changeTypes;
private final boolean isCritical;
@@ -285,16 +289,12 @@
return changeTypes;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
final ByteStringBuilder buffer = new ByteStringBuilder();
final ASN1Writer writer = ASN1.getWriter(buffer);
@@ -317,9 +317,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return true;
}
@@ -339,9 +337,7 @@
return changesOnly;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
@@ -358,9 +354,7 @@
return returnECs;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PostReadRequestControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PostReadRequestControl.java
index 3f4e4a4..c33ab16 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PostReadRequestControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PostReadRequestControl.java
@@ -87,7 +87,7 @@
*/
public static final String OID = "1.3.6.1.1.13.2";
- // The list of raw attributes to return in the entry.
+ /** The list of raw attributes to return in the entry. */
private final List<String> attributes;
private final boolean isCritical;
@@ -244,16 +244,12 @@
return attributes;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
final ByteStringBuilder buffer = new ByteStringBuilder();
final ASN1Writer writer = ASN1.getWriter(buffer);
@@ -272,23 +268,17 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PostReadResponseControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PostReadResponseControl.java
index fe3af72..817b6d7 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PostReadResponseControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PostReadResponseControl.java
@@ -121,7 +121,7 @@
throw DecodeException.error(message, le);
}
- /**
+ /*
* FIXME: the RFC states that the control contains a
* SearchResultEntry rather than an Entry. Can we assume
* that the response will not contain a nested set of
@@ -147,7 +147,7 @@
* If {@code entry} was {@code null}.
*/
public static PostReadResponseControl newControl(final Entry entry) {
- /**
+ /*
* FIXME: all other control implementations are fully immutable. We
* should really do a defensive copy here in order to be consistent,
* rather than just wrap it. Also, the RFC states that the control
@@ -178,16 +178,12 @@
return entry;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
try {
final ByteStringBuilder buffer = new ByteStringBuilder();
@@ -199,23 +195,17 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PreReadRequestControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PreReadRequestControl.java
index aeea58e..09e086e 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PreReadRequestControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PreReadRequestControl.java
@@ -88,7 +88,7 @@
*/
public static final String OID = "1.3.6.1.1.13.1";
- // The list of raw attributes to return in the entry.
+ /** The list of raw attributes to return in the entry. */
private final List<String> attributes;
private final boolean isCritical;
@@ -245,16 +245,12 @@
return attributes;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
final ByteStringBuilder buffer = new ByteStringBuilder();
final ASN1Writer writer = ASN1.getWriter(buffer);
@@ -273,23 +269,17 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PreReadResponseControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PreReadResponseControl.java
index 09e8b68..3b47400 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PreReadResponseControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/PreReadResponseControl.java
@@ -120,7 +120,7 @@
throw DecodeException.error(message, le);
}
- /**
+ /*
* FIXME: the RFC states that the control contains a
* SearchResultEntry rather than an Entry. Can we assume
* that the response will not contain a nested set of
@@ -146,7 +146,7 @@
* If {@code entry} was {@code null}.
*/
public static PreReadResponseControl newControl(final Entry entry) {
- /**
+ /*
* FIXME: all other control implementations are fully immutable. We
* should really do a defensive copy here in order to be consistent,
* rather than just wrap it. Also, the RFC states that the control
@@ -177,16 +177,12 @@
return entry;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
try {
final ByteStringBuilder buffer = new ByteStringBuilder();
@@ -198,23 +194,17 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ProxiedAuthV1RequestControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ProxiedAuthV1RequestControl.java
index 06e7c68..04b0d77 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ProxiedAuthV1RequestControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ProxiedAuthV1RequestControl.java
@@ -188,16 +188,12 @@
return authorizationName;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
final ByteStringBuilder buffer = new ByteStringBuilder();
final ASN1Writer writer = ASN1.getWriter(buffer);
@@ -212,23 +208,17 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder buffer = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ProxiedAuthV2RequestControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ProxiedAuthV2RequestControl.java
index d3023cd..789b88b 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ProxiedAuthV2RequestControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ProxiedAuthV2RequestControl.java
@@ -189,7 +189,7 @@
return new ProxiedAuthV2RequestControl(authorizationID);
}
- // The authorization ID from the control value.
+ /** The authorization ID from the control value. */
private final String authorizationID;
private ProxiedAuthV2RequestControl(final String authorizationID) {
@@ -209,37 +209,27 @@
return authorizationID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
return ByteString.valueOf(authorizationID);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ServerSideSortRequestControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ServerSideSortRequestControl.java
index ea0217b..a5a5662 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ServerSideSortRequestControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ServerSideSortRequestControl.java
@@ -268,9 +268,7 @@
this.sortKeys = keys;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
@@ -287,9 +285,7 @@
return sortKeys;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
final ByteStringBuilder buffer = new ByteStringBuilder();
final ASN1Writer writer = ASN1.getWriter(buffer);
@@ -318,23 +314,17 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder buffer = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ServerSideSortResponseControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ServerSideSortResponseControl.java
index ccd816d..130a4ef 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ServerSideSortResponseControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/ServerSideSortResponseControl.java
@@ -264,9 +264,7 @@
return attributeDescription;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
@@ -286,9 +284,7 @@
return result;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
final ByteStringBuilder buffer = new ByteStringBuilder();
final ASN1Writer writer = ASN1.getWriter(buffer);
@@ -306,23 +302,17 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/SimplePagedResultsControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/SimplePagedResultsControl.java
index f79c2c9..e3d7a47 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/SimplePagedResultsControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/SimplePagedResultsControl.java
@@ -269,9 +269,7 @@
return cookie;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
@@ -290,9 +288,7 @@
return size;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
final ByteStringBuilder buffer = new ByteStringBuilder();
final ASN1Writer writer = ASN1.getWriter(buffer);
@@ -308,23 +304,17 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/SubentriesRequestControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/SubentriesRequestControl.java
index 1029fc3..d45ce3d 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/SubentriesRequestControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/SubentriesRequestControl.java
@@ -184,16 +184,12 @@
this.visibility = visibility;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
final ByteStringBuilder buffer = new ByteStringBuilder();
final ASN1Writer writer = ASN1.getWriter(buffer);
@@ -218,23 +214,17 @@
return visibility;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/SubtreeDeleteRequestControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/SubtreeDeleteRequestControl.java
index b8cf6ed..6db2cdf 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/SubtreeDeleteRequestControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/SubtreeDeleteRequestControl.java
@@ -121,37 +121,27 @@
this.isCritical = isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/VirtualListViewRequestControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/VirtualListViewRequestControl.java
index cabfdf6..dc39d9e 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/VirtualListViewRequestControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/VirtualListViewRequestControl.java
@@ -417,16 +417,12 @@
return offset;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
final ByteStringBuilder buffer = new ByteStringBuilder();
final ASN1Writer writer = ASN1.getWriter(buffer);
@@ -464,23 +460,17 @@
return assertionValue != null ? false : true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/VirtualListViewResponseControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/VirtualListViewResponseControl.java
index f6f203f..8cc26d4 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/VirtualListViewResponseControl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/VirtualListViewResponseControl.java
@@ -256,9 +256,7 @@
return contextID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getOID() {
return OID;
}
@@ -283,9 +281,7 @@
return targetPosition;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString getValue() {
final ByteStringBuilder buffer = new ByteStringBuilder();
final ASN1Writer writer = ASN1.getWriter(buffer);
@@ -305,23 +301,17 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasValue() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/AbstractRequestImpl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/AbstractRequestImpl.java
index fbeae81..9a5268e 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/AbstractRequestImpl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/AbstractRequestImpl.java
@@ -45,7 +45,7 @@
*/
abstract class AbstractRequestImpl<R extends Request> implements Request {
- // Used by unmodifiable implementations as well.
+ /** Used by unmodifiable implementations as well. */
static Control getControl(final List<Control> controls, final String oid) {
// Avoid creating an iterator if possible.
if (!controls.isEmpty()) {
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/CancelExtendedRequestImpl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/CancelExtendedRequestImpl.java
index 03afa44..cef5737 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/CancelExtendedRequestImpl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/CancelExtendedRequestImpl.java
@@ -101,7 +101,7 @@
}
}
- // No need to expose this.
+ /** No need to expose this. */
private static final ExtendedResultDecoder<ExtendedResult> RESULT_DECODER = new ResultDecoder();
private int requestID;
@@ -111,7 +111,7 @@
this.requestID = cancelExtendedRequest.getRequestID();
}
- // Instantiation via factory.
+ /** Instantiation via factory. */
CancelExtendedRequestImpl(final int requestID) {
this.requestID = requestID;
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/DigestMD5SASLBindRequestImpl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/DigestMD5SASLBindRequestImpl.java
index a1e1a84..ba6228d 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/DigestMD5SASLBindRequestImpl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/DigestMD5SASLBindRequestImpl.java
@@ -228,8 +228,8 @@
private byte[] password;
private final List<String> qopValues = new LinkedList<String>();
private String realm = null;
- /*
- * Don't use primitives for these so that we can distinguish between default
+ /**
+ * Do not use primitives for these so that we can distinguish between default
* settings (null) and values set by the caller.
*/
private Boolean serverAuth = null;
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/GSSAPISASLBindRequestImpl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/GSSAPISASLBindRequestImpl.java
index 33ced89..c4b8407 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/GSSAPISASLBindRequestImpl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/GSSAPISASLBindRequestImpl.java
@@ -295,9 +295,9 @@
private final Map<String, String> additionalAuthParams = new LinkedHashMap<String, String>();
- // Ignored if subject is non-null.
+ /** Ignored if subject is non-null. */
private String authenticationID = null;
- // Optional authorization ID.
+ /** Optional authorization ID. */
private String authorizationID = null;
private String kdcAddress = null;
@@ -309,10 +309,12 @@
private final List<String> qopValues = new LinkedList<String>();
private String realm = null;
- // Don't use primitives for these so that we can distinguish between default
- // settings (null) and values set by the caller.
+ /**
+ * Don't use primitives for these so that we can distinguish between default
+ * settings (null) and values set by the caller.
+ */
private Boolean serverAuth = null;
- // If null then authenticationID and password must be present.
+ /** If null then authenticationID and password must be present. */
private Subject subject = null;
GSSAPISASLBindRequestImpl(final GSSAPISASLBindRequest gssapiSASLBindRequest) {
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/PasswordModifyExtendedRequestImpl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/PasswordModifyExtendedRequestImpl.java
index 8f6b0c8..dfde77b 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/PasswordModifyExtendedRequestImpl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/PasswordModifyExtendedRequestImpl.java
@@ -176,7 +176,7 @@
private ByteString userIdentity = null;
- // Instantiation via factory.
+ /** Instantiation via factory. */
PasswordModifyExtendedRequestImpl() {
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/StartTLSExtendedRequestImpl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/StartTLSExtendedRequestImpl.java
index 3261817..dde1d94 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/StartTLSExtendedRequestImpl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/StartTLSExtendedRequestImpl.java
@@ -83,17 +83,13 @@
}
}
- // No need to expose this.
+ /** No need to expose this. */
private static final ExtendedResultDecoder<ExtendedResult> RESULT_DECODER = new ResultDecoder();
- /**
- * The list of cipher suite.
- */
+ /** The list of cipher suite. */
private final List<String> enabledCipherSuites = new LinkedList<String>();
- /**
- * the list of protocols.
- */
+ /** The list of protocols. */
private final List<String> enabledProtocols = new LinkedList<String>();
private SSLContext sslContext;
@@ -110,7 +106,7 @@
this.enabledProtocols.addAll(startTLSExtendedRequest.getEnabledProtocols());
}
- // Prevent instantiation.
+ /** Prevent instantiation. */
private StartTLSExtendedRequestImpl() {
// Nothing to do.
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/WhoAmIExtendedRequestImpl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/WhoAmIExtendedRequestImpl.java
index bcd8bef..b748d7b 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/WhoAmIExtendedRequestImpl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/WhoAmIExtendedRequestImpl.java
@@ -99,11 +99,11 @@
}
}
- // No need to expose this.
+ /** No need to expose this. */
private static final ExtendedResultDecoder<WhoAmIExtendedResult> RESULT_DECODER =
new ResultDecoder();
- // Prevent instantiation.
+ /** Prevent instantiation. */
WhoAmIExtendedRequestImpl() {
// Nothing to do.
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/AbstractResponseImpl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/AbstractResponseImpl.java
index 3c225e2..9503968 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/AbstractResponseImpl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/AbstractResponseImpl.java
@@ -44,7 +44,7 @@
* The type of response.
*/
abstract class AbstractResponseImpl<S extends Response> implements Response {
- // Used by unmodifiable implementations as well.
+ /** Used by unmodifiable implementations as well. */
static Control getControl(final List<Control> controls, final String oid) {
// Avoid creating an iterator if possible.
if (!controls.isEmpty()) {
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/AbstractResultImpl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/AbstractResultImpl.java
index febadbc..a1054f5 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/AbstractResultImpl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/AbstractResultImpl.java
@@ -42,7 +42,7 @@
*/
abstract class AbstractResultImpl<S extends Result> extends AbstractResponseImpl<S> implements
Result {
- // For local errors caused by internal exceptions.
+ /** For local errors caused by internal exceptions. */
private Throwable cause = null;
private String diagnosticMessage = "";
private String matchedDN = "";
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/PasswordModifyExtendedResultImpl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/PasswordModifyExtendedResultImpl.java
index ed99db9..5751d7e 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/PasswordModifyExtendedResultImpl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/PasswordModifyExtendedResultImpl.java
@@ -56,7 +56,7 @@
this.password = passwordModifyExtendedResult.getGeneratedPassword();
}
- // Instantiation via factory.
+ /** Instantiation via factory. */
PasswordModifyExtendedResultImpl(final ResultCode resultCode) {
super(resultCode);
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/Responses.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/Responses.java
index 04f6abc..a7b5e9f 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/Responses.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/Responses.java
@@ -540,7 +540,7 @@
return new UnmodifiableWhoAmIExtendedResultImpl(result);
}
- // Private constructor.
+ /** Private constructor. */
private Responses() {
// Prevent instantiation.
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/WhoAmIExtendedResultImpl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/WhoAmIExtendedResultImpl.java
index 0a60c5b..34ae1c7 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/WhoAmIExtendedResultImpl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/responses/WhoAmIExtendedResultImpl.java
@@ -40,10 +40,10 @@
final class WhoAmIExtendedResultImpl extends AbstractExtendedResult<WhoAmIExtendedResult> implements
WhoAmIExtendedResult {
- // The authorization ID.
+ /** The authorization ID. */
private String authorizationID = null;
- // Instantiation via factory.
+ /** Instantiation via factory. */
WhoAmIExtendedResultImpl(final ResultCode resultCode) {
super(resultCode);
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/AttributeType.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/AttributeType.java
index 5b00efb..0995497 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/AttributeType.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/AttributeType.java
@@ -52,79 +52,78 @@
*/
public final class AttributeType extends SchemaElement implements Comparable<AttributeType> {
- // The approximate matching rule for this attribute type.
+ /** The approximate matching rule for this attribute type. */
private final String approximateMatchingRuleOID;
- // The attribute usage for this attribute type.
+ /** The attribute usage for this attribute type. */
private final AttributeUsage attributeUsage;
- // The equality matching rule for this attribute type.
+ /** The equality matching rule for this attribute type. */
private final String equalityMatchingRuleOID;
- // Indicates whether this attribute type is declared "collective".
+ /** Indicates whether this attribute type is declared "collective". */
private final boolean isCollective;
- // Indicates whether this attribute type is declared
- // "no-user-modification".
+ /**
+ * Indicates whether this attribute type is declared "no-user-modification".
+ */
private final boolean isNoUserModification;
- // Indicates whether this definition is declared "obsolete".
+ /** Indicates whether this definition is declared "obsolete". */
private final boolean isObsolete;
- // Indicates whether this definition is a temporary place-holder.
+ /** Indicates whether this definition is a temporary place-holder. */
private final boolean isPlaceHolder;
- // Indicates whether this attribute type is declared "single-value".
+ /** Indicates whether this attribute type is declared "single-value". */
private final boolean isSingleValue;
- // The set of user defined names for this definition.
+ /** The set of user defined names for this definition. */
private final List<String> names;
- // The OID that may be used to reference this definition.
+ /** The OID that may be used to reference this definition. */
private final String oid;
- // The ordering matching rule for this attribute type.
+ /** The ordering matching rule for this attribute type. */
private final String orderingMatchingRuleOID;
- // The substring matching rule for this attribute type.
+ /** The substring matching rule for this attribute type. */
private final String substringMatchingRuleOID;
- // The superior attribute type from which this attribute type
- // inherits.
+ /** The superior attribute type from which this attribute type inherits. */
private final String superiorTypeOID;
- // The syntax for this attribute type.
+ /** The syntax for this attribute type. */
private final String syntaxOID;
- // True if this type has OID 2.5.4.0.
+ /** True if this type has OID 2.5.4.0. */
private final boolean isObjectClassType;
- // The normalized name of this attribute type.
+ /** The normalized name of this attribute type. */
private final String normalizedName;
- // The superior attribute type from which this attribute type
- // inherits.
+ /** The superior attribute type from which this attribute type inherits. */
private AttributeType superiorType;
- // The equality matching rule for this attribute type.
+ /** The equality matching rule for this attribute type. */
private MatchingRule equalityMatchingRule;
- // The ordering matching rule for this attribute type.
+ /** The ordering matching rule for this attribute type. */
private MatchingRule orderingMatchingRule;
- // The substring matching rule for this attribute type.
+ /** The substring matching rule for this attribute type. */
private MatchingRule substringMatchingRule;
- // The approximate matching rule for this attribute type.
+ /** The approximate matching rule for this attribute type. */
private MatchingRule approximateMatchingRule;
- // The syntax for this attribute type.
+ /** The syntax for this attribute type. */
private Syntax syntax;
- // Indicates whether or not validation has been performed.
+ /** Indicates whether or not validation has been performed. */
private boolean needsValidating = true;
- // The indicates whether or not validation failed.
+ /** The indicates whether or not validation failed. */
private boolean isValid = false;
AttributeType(final String oid, final List<String> names, final String description,
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/AttributeUsage.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/AttributeUsage.java
index 99403fe..e19f280 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/AttributeUsage.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/AttributeUsage.java
@@ -56,11 +56,13 @@
*/
DSA_OPERATION("dSAOperation", true);
- // The string representation of this attribute usage.
+ /** The string representation of this attribute usage. */
private final String usageString;
- // Flag indicating whether or not the usage should be categorized as
- // operational.
+ /**
+ * Flag indicating whether or not the usage should be categorized as
+ * operational.
+ */
private final boolean isOperational;
/**
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/CertificateExactAssertionSyntaxImpl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/CertificateExactAssertionSyntaxImpl.java
index c86fa56..c161799 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/CertificateExactAssertionSyntaxImpl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/CertificateExactAssertionSyntaxImpl.java
@@ -37,31 +37,23 @@
*/
final class CertificateExactAssertionSyntaxImpl extends AbstractSyntaxImpl {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getName() {
return SYNTAX_CERTIFICATE_EXACT_ASSERTION_NAME;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isBEREncodingRequired() {
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean isHumanReadable() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean valueIsAcceptable(final Schema schema, final ByteSequence value,
final LocalizableMessageBuilder invalidReason) {
// This method will never be called because this syntax is only used
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/CertificateExactMatchingRuleImpl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/CertificateExactMatchingRuleImpl.java
index 8b50915..af27b44 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/CertificateExactMatchingRuleImpl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/CertificateExactMatchingRuleImpl.java
@@ -114,9 +114,7 @@
return createEncodedValue(serialNumber, certificateIssuer);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public Assertion getAssertion(final Schema schema, final ByteSequence value)
throws DecodeException {
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/CertificateSyntaxImpl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/CertificateSyntaxImpl.java
index 26e8af1..765575d 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/CertificateSyntaxImpl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/CertificateSyntaxImpl.java
@@ -54,49 +54,37 @@
* accept only X.509 certificates.
*/
final class CertificateSyntaxImpl extends AbstractSyntaxImpl {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getEqualityMatchingRule() {
return EMR_CERTIFICATE_EXACT_OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getName() {
return SYNTAX_CERTIFICATE_NAME;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getOrderingMatchingRule() {
return OMR_OCTET_STRING_OID;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isBEREncodingRequired() {
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isHumanReadable() {
return false;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean valueIsAcceptable(final Schema schema, final ByteSequence value,
final LocalizableMessageBuilder invalidReason) {
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/CollationMatchingRulesImpl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/CollationMatchingRulesImpl.java
index f8afddb..4783028 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/CollationMatchingRulesImpl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/CollationMatchingRulesImpl.java
@@ -265,9 +265,7 @@
return substringMatchingRule.getSubstringAssertion(schema, subInitial, subAnyElements, subFinal);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final Collection<? extends Indexer> getIndexers() {
return Arrays.asList(subIndexer, indexer);
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DITContentRule.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DITContentRule.java
index 0ce8719..36a8d79 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DITContentRule.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DITContentRule.java
@@ -46,27 +46,30 @@
* the entry.
*/
public final class DITContentRule extends SchemaElement {
- // The structural objectclass for this DIT content rule.
+
+ /** The structural objectclass for this DIT content rule. */
private final String structuralClassOID;
- // The set of user defined names for this definition.
+ /** The set of user defined names for this definition. */
private final List<String> names;
- // Indicates whether this definition is declared "obsolete".
+ /** Indicates whether this definition is declared "obsolete". */
private final boolean isObsolete;
- // The set of auxiliary objectclasses that entries with this content
- // rule may contain, in a mapping between the objectclass and the
- // user-defined name for that class.
+ /**
+ * The set of auxiliary objectclasses that entries with this content
+ * rule may contain, in a mapping between the objectclass and the
+ * user-defined name for that class.
+ */
private final Set<String> auxiliaryClassOIDs;
- // The set of optional attribute types for this DIT content rule.
+ /** The set of optional attribute types for this DIT content rule. */
private final Set<String> optionalAttributeOIDs;
- // The set of prohibited attribute types for this DIT content rule.
+ /** The set of prohibited attribute types for this DIT content rule. */
private final Set<String> prohibitedAttributeOIDs;
- // The set of required attribute types for this DIT content rule.
+ /** The set of required attribute types for this DIT content rule. */
private final Set<String> requiredAttributeOIDs;
private ObjectClass structuralClass;
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DITContentRuleSyntaxImpl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DITContentRuleSyntaxImpl.java
index 9d7695d..e5d67f0 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DITContentRuleSyntaxImpl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DITContentRuleSyntaxImpl.java
@@ -59,9 +59,7 @@
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean valueIsAcceptable(final Schema schema, final ByteSequence value,
final LocalizableMessageBuilder invalidReason) {
// We'll use the decodeDITContentRule method to determine if the
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DITStructureRule.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DITStructureRule.java
index 13e7cd1..4ec8fe8 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DITStructureRule.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DITStructureRule.java
@@ -45,28 +45,28 @@
* of children that entries may have.
*/
public final class DITStructureRule extends SchemaElement {
- // The rule ID for this DIT structure rule.
+ /** The rule ID for this DIT structure rule. */
private final Integer ruleID;
- // The set of user defined names for this definition.
+ /** The set of user defined names for this definition. */
private final List<String> names;
- // Indicates whether this definition is declared "obsolete".
+ /** Indicates whether this definition is declared "obsolete". */
private final boolean isObsolete;
- // The name form for this DIT structure rule.
+ /** The name form for this DIT structure rule. */
private final String nameFormOID;
- // The set of superior DIT structure rules.
+ /** The set of superior DIT structure rules. */
private final Set<Integer> superiorRuleIDs;
private NameForm nameForm;
private Set<DITStructureRule> superiorRules = Collections.emptySet();
- // Indicates whether or not validation has been performed.
+ /** Indicates whether or not validation has been performed. */
private boolean needsValidating = true;
- // The indicates whether or not validation failed.
+ /** The indicates whether or not validation failed. */
private boolean isValid = false;
DITStructureRule(final Integer ruleID, final List<String> names, final String description,
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DistinguishedNameEqualityMatchingRuleImpl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DistinguishedNameEqualityMatchingRuleImpl.java
index 19a7e27..ad87cce 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DistinguishedNameEqualityMatchingRuleImpl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DistinguishedNameEqualityMatchingRuleImpl.java
@@ -38,9 +38,7 @@
*/
final class DistinguishedNameEqualityMatchingRuleImpl extends AbstractEqualityMatchingRuleImpl {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString normalizeAttributeValue(final Schema schema, final ByteSequence value)
throws DecodeException {
try {
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DoubleMetaphoneApproximateMatchingRuleImpl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DoubleMetaphoneApproximateMatchingRuleImpl.java
index 3a97d89..cb16d6a 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DoubleMetaphoneApproximateMatchingRuleImpl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/DoubleMetaphoneApproximateMatchingRuleImpl.java
@@ -53,9 +53,7 @@
private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString normalizeAttributeValue(final Schema schema, final ByteSequence value) {
String valueString = value.toString();
final int length = valueString.length();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/EnumSyntaxImpl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/EnumSyntaxImpl.java
index 27814fd..d314735 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/EnumSyntaxImpl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/EnumSyntaxImpl.java
@@ -52,7 +52,7 @@
*/
final class EnumSyntaxImpl extends AbstractSyntaxImpl {
private final String oid;
- // Set of read-only enum entries.
+ /** Set of read-only enum entries. */
private final List<String> entries;
EnumSyntaxImpl(final String oid, final List<String> entries) {
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/EqualLengthApproximateMatchingRuleImpl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/EqualLengthApproximateMatchingRuleImpl.java
index 9583da2..894b7ef 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/EqualLengthApproximateMatchingRuleImpl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/EqualLengthApproximateMatchingRuleImpl.java
@@ -55,9 +55,7 @@
};
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ByteString normalizeAttributeValue(final Schema schema, final ByteSequence value) {
return value.toByteString();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/MatchingRuleUse.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/MatchingRuleUse.java
index 32116dc..4bf12d4 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/MatchingRuleUse.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/MatchingRuleUse.java
@@ -45,18 +45,22 @@
* attribute types that may be used for a given matching rule.
*/
public final class MatchingRuleUse extends SchemaElement {
- // The OID of the matching rule associated with this matching rule
- // use definition.
+ /**
+ * The OID of the matching rule associated with this matching rule
+ * use definition.
+ */
private final String oid;
- // The set of user defined names for this definition.
+ /** The set of user defined names for this definition. */
private final List<String> names;
- // Indicates whether this definition is declared "obsolete".
+ /** Indicates whether this definition is declared "obsolete". */
private final boolean isObsolete;
- // The set of attribute types with which this matching rule use is
- // associated.
+ /**
+ * The set of attribute types with which this matching rule use is
+ * associated.
+ */
private final Set<String> attributeOIDs;
private MatchingRule matchingRule;
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/NameForm.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/NameForm.java
index 3d91229..a8dc63d 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/NameForm.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/NameForm.java
@@ -305,24 +305,24 @@
}
}
- // Indicates whether this definition is declared "obsolete".
+ /** Indicates whether this definition is declared "obsolete". */
private final boolean isObsolete;
- // The set of user defined names for this definition.
+ /** The set of user defined names for this definition. */
private final List<String> names;
- // The OID that may be used to reference this definition.
+ /** The OID that may be used to reference this definition. */
private final String oid;
- // The set of optional attribute types for this name form.
+ /** The set of optional attribute types for this name form. */
private final Set<String> optionalAttributeOIDs;
private Set<AttributeType> optionalAttributes = Collections.emptySet();
- // The set of required attribute types for this name form.
+ /** The set of required attribute types for this name form. */
private final Set<String> requiredAttributeOIDs;
private Set<AttributeType> requiredAttributes = Collections.emptySet();
- // The reference to the structural objectclass for this name form.
+ /** The reference to the structural objectclass for this name form. */
private ObjectClass structuralClass;
private final String structuralClassOID;
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/ObjectClass.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/ObjectClass.java
index 89e46d4..e089015 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/ObjectClass.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/ObjectClass.java
@@ -51,25 +51,25 @@
* accessed via their getters or via the {@link #toString()} methods.
*/
public final class ObjectClass extends SchemaElement {
- // The OID that may be used to reference this definition.
+ /** The OID that may be used to reference this definition. */
private final String oid;
- // The set of user defined names for this definition.
+ /** The set of user defined names for this definition. */
private final List<String> names;
- // Indicates whether this definition is declared "obsolete".
+ /** Indicates whether this definition is declared "obsolete". */
private final boolean isObsolete;
- // The reference to the superior objectclasses.
+ /** The reference to the superior objectclasses. */
private final Set<String> superiorClassOIDs;
- // The objectclass type for this objectclass.
+ /** The objectclass type for this objectclass. */
private final ObjectClassType objectClassType;
- // The set of required attribute types for this objectclass.
+ /** The set of required attribute types for this objectclass. */
private final Set<String> requiredAttributeOIDs;
- // The set of optional attribute types for this objectclass.
+ /** The set of optional attribute types for this objectclass. */
private final Set<String> optionalAttributeOIDs;
private Set<ObjectClass> superiorClasses = Collections.emptySet();
@@ -78,10 +78,10 @@
private Set<AttributeType> declaredOptionalAttributes = Collections.emptySet();
private Set<AttributeType> optionalAttributes = Collections.emptySet();
- // Indicates whether or not validation has been performed.
+ /** Indicates whether or not validation has been performed. */
private boolean needsValidating = true;
- // The indicates whether or not validation failed.
+ /** The indicates whether or not validation failed. */
private boolean isValid = false;
ObjectClass(final String oid, final List<String> names, final String description,
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/ObjectClassType.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/ObjectClassType.java
index d178778..1ecbd50 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/ObjectClassType.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/ObjectClassType.java
@@ -49,7 +49,7 @@
*/
AUXILIARY("AUXILIARY");
- // The string representation of this objectclass type.
+ /** The string representation of this objectclass type. */
private final String typeString;
/**
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/RegexSyntaxImpl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/RegexSyntaxImpl.java
index 1bab52b..c60b5eb 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/RegexSyntaxImpl.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/RegexSyntaxImpl.java
@@ -46,7 +46,7 @@
* LDAPSyntaxDescriptionSyntax with X-PATTERN extension.
*/
final class RegexSyntaxImpl extends AbstractSyntaxImpl {
- // The Pattern associated with the regex.
+ /** The Pattern associated with the regex. */
private final Pattern pattern;
RegexSyntaxImpl(final Pattern pattern) {
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaConstants.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaConstants.java
index 879d778..2df0812 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaConstants.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaConstants.java
@@ -1502,7 +1502,7 @@
*/
public static final String DATE_FORMAT_UTC_TIME = "yyMMddHHmmss'Z'";
- // Prevent instantiation.
+ /** Prevent instantiation. */
private SchemaConstants() {
// Nothing to do.
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaElement.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaElement.java
index 80661b1..23c6729 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaElement.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaElement.java
@@ -190,10 +190,10 @@
*/
private String definition;
- // The description for this definition.
+ /** The description for this definition. */
private final String description;
- // The set of additional name-value pairs.
+ /** The set of additional name-value pairs. */
private final Map<String, List<String>> extraProperties;
SchemaElement() {
@@ -216,9 +216,7 @@
this.definition = definition;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public abstract boolean equals(Object obj);
@@ -244,9 +242,7 @@
return extraProperties;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public abstract int hashCode();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaException.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaException.java
index 9d45f97..44de6ea 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaException.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaException.java
@@ -34,7 +34,7 @@
*/
@SuppressWarnings("serial")
final class SchemaException extends Exception implements LocalizableException {
- // The I18N message associated with this exception.
+ /** The I18N message associated with this exception. */
private final LocalizableMessage message;
/**
@@ -63,9 +63,7 @@
this.message = message;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public LocalizableMessage getMessageObject() {
return this.message;
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaUtils.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaUtils.java
index 66b80de..a4d9a40 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaUtils.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaUtils.java
@@ -672,7 +672,7 @@
}
}
- // Prevent instantiation.
+ /** Prevent instantiation. */
private SchemaUtils() {
// Nothing to do.
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaValidationPolicy.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaValidationPolicy.java
index 176ee7a..734a2a2 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaValidationPolicy.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/schema/SchemaValidationPolicy.java
@@ -165,7 +165,7 @@
private Action checkAttributeValues = Action.REJECT;
private EntryResolver checkDITStructureRulesEntryResolver = null;
- // Prevent direct instantiation.
+ /** Prevent direct instantiation. */
private SchemaValidationPolicy() {
// Nothing to do.
}
@@ -420,7 +420,7 @@
.asNonStrictSchema();
}
- // Assigns the provided options to this set of options.
+ /** Assigns the provided options to this set of options. */
SchemaValidationPolicy assign(final SchemaValidationPolicy policy) {
this.checkAttributeValues = policy.checkAttributeValues;
this.checkNameForms = policy.checkNameForms;
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/AbstractLDIFReader.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/AbstractLDIFReader.java
index 40bc6a5..d58d539 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/AbstractLDIFReader.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/AbstractLDIFReader.java
@@ -704,8 +704,8 @@
return ldifLine;
}
- /*
- * Determine whether the provided line is a continuation line. Note that
+ /**
+ * Determines whether the provided line is a continuation line. Note that
* while RFC 2849 technically only allows a space in this position, both
* OpenLDAP and the Sun Java System Directory Server allow a tab as well, so
* we will too for compatibility reasons. See issue #852 for details.
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/AbstractLDIFWriter.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/AbstractLDIFWriter.java
index 04c9878..b4dca81 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/AbstractLDIFWriter.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/AbstractLDIFWriter.java
@@ -163,9 +163,7 @@
}
}
- /*
- * Regular expression used for splitting comments on line-breaks.
- */
+ /** Regular expression used for splitting comments on line-breaks. */
private static final Pattern SPLIT_NEWLINE = Pattern.compile("\\r?\\n");
boolean addUserFriendlyComments = false;
final LDIFWriterImpl impl;
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/ChangeRecord.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/ChangeRecord.java
index dd65dda..d532d77 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/ChangeRecord.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/ChangeRecord.java
@@ -114,19 +114,13 @@
*/
// ChangeRecord setName(String dn);
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
Request addControl(Control control);
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
<C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options)
throws DecodeException;
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
List<Control> getControls();
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/ChangeRecordVisitorWriter.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/ChangeRecordVisitorWriter.java
index 26a96ce..46b7af4 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/ChangeRecordVisitorWriter.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/ChangeRecordVisitorWriter.java
@@ -38,7 +38,7 @@
*/
final class ChangeRecordVisitorWriter implements
ChangeRecordVisitor<IOException, ChangeRecordWriter> {
- // Visitor used for writing generic change records.
+ /** Visitor used for writing generic change records. */
private static final ChangeRecordVisitorWriter VISITOR = new ChangeRecordVisitorWriter();
/**
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/ConnectionEntryReader.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/ConnectionEntryReader.java
index c405edb..2255f73 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/ConnectionEntryReader.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/ConnectionEntryReader.java
@@ -224,9 +224,7 @@
promise.cancel(true);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean hasNext() throws LdapException {
// Poll for the next response if needed.
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIF.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIF.java
index dd24274..93fd181 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIF.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIF.java
@@ -854,7 +854,7 @@
}
}
- // Prevent instantiation.
+ /** Prevent instantiation. */
private LDIF() {
// Do nothing.
}
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIFChangeRecordReader.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIFChangeRecordReader.java
index 541e13c..a5ae02f 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIFChangeRecordReader.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIFChangeRecordReader.java
@@ -95,7 +95,7 @@
private static final Pattern CONTROL_REGEX = Pattern
.compile("^\\s*(\\d+(.\\d+)*)(\\s+((true)|(false)))?\\s*(:(:)?\\s*?\\S+)?\\s*$");
- // Poison used to indicate end of LDIF.
+ /** Poison used to indicate end of LDIF. */
private static final ChangeRecord EOF = Requests.newAddRequest(DN.rootDN());
/**
@@ -200,9 +200,7 @@
super(Arrays.asList(ldifLines));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void close() throws IOException {
close0();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIFChangeRecordWriter.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIFChangeRecordWriter.java
index fb7c36a..fe64f74 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIFChangeRecordWriter.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIFChangeRecordWriter.java
@@ -125,17 +125,13 @@
super(writer);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void close() throws IOException {
close0();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void flush() throws IOException {
flush0();
@@ -261,9 +257,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LDIFChangeRecordWriter writeChangeRecord(final AddRequest change) throws IOException {
Reject.ifNull(change);
@@ -294,9 +288,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LDIFChangeRecordWriter writeChangeRecord(final ChangeRecord change) throws IOException {
Reject.ifNull(change);
@@ -309,14 +301,11 @@
final IOException e = change.accept(ChangeRecordVisitorWriter.getInstance(), this);
if (e != null) {
throw e;
- } else {
- return this;
}
+ return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LDIFChangeRecordWriter writeChangeRecord(final DeleteRequest change) throws IOException {
Reject.ifNull(change);
@@ -336,9 +325,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LDIFChangeRecordWriter writeChangeRecord(final ModifyDNRequest change)
throws IOException {
@@ -375,9 +362,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LDIFChangeRecordWriter writeChangeRecord(final ModifyRequest change) throws IOException {
Reject.ifNull(change);
@@ -419,9 +404,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LDIFChangeRecordWriter writeComment(final CharSequence comment) throws IOException {
writeComment0(comment);
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIFEntryReader.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIFEntryReader.java
index 843256d..a93db4f 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIFEntryReader.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIFEntryReader.java
@@ -58,7 +58,7 @@
* Interchange Format (LDIF) - Technical Specification </a>
*/
public final class LDIFEntryReader extends AbstractLDIFReader implements EntryReader {
- // Poison used to indicate end of LDIF.
+ /** Poison used to indicate end of LDIF. */
private static final Entry EOF = new LinkedHashMapEntry();
/**
@@ -161,9 +161,7 @@
super(Arrays.asList(ldifLines));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void close() throws IOException {
close0();
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIFEntryWriter.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIFEntryWriter.java
index 2cc06fb..f64c8a4 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIFEntryWriter.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/LDIFEntryWriter.java
@@ -102,17 +102,13 @@
super(writer);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void close() throws IOException {
close0();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void flush() throws IOException {
flush0();
@@ -265,18 +261,14 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LDIFEntryWriter writeComment(final CharSequence comment) throws IOException {
writeComment0(comment);
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public LDIFEntryWriter writeEntry(final Entry entry) throws IOException {
Reject.ifNull(entry);
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/TemplateFile.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/TemplateFile.java
index cc20e2d..1ef83d0 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/TemplateFile.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/TemplateFile.java
@@ -1691,7 +1691,7 @@
return false;
}
- /** parent DN of entries to generate for this template. */
+ /** Parent DN of entries to generate for this template. */
private DN parentDN;
/**
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/TemplateTag.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/TemplateTag.java
index 288a9ae..8085fe0 100644
--- a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/TemplateTag.java
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldif/TemplateTag.java
@@ -950,8 +950,7 @@
/** The decimal format used to format numeric values. */
private DecimalFormat decimalFormat;
- /** The number of characters between the minimum and maximum length */
- /** (inclusive). */
+ /** The number of characters between the minimum and maximum length (inclusive). */
private int lengthRange = 1;
/** The maximum number of characters to include in the value. */
diff --git a/opendj-sdk/opendj-core/src/test/java/com/forgerock/opendj/util/StringPrepProfileTestCase.java b/opendj-sdk/opendj-core/src/test/java/com/forgerock/opendj/util/StringPrepProfileTestCase.java
index 4123969..7f01955 100644
--- a/opendj-sdk/opendj-core/src/test/java/com/forgerock/opendj/util/StringPrepProfileTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/com/forgerock/opendj/util/StringPrepProfileTestCase.java
@@ -74,7 +74,7 @@
assertEquals(result, liveResult);
}
- // Generates data for case exact matching rules.
+ /** Generates data for case exact matching rules. */
@DataProvider(name = "exactRuleData")
public Object[][] createExactRuleData() {
return new Object[][] { { "12345678", "12345678", ConditionResult.TRUE },
@@ -86,7 +86,7 @@
{ "foo\u070Fbar", "foobar", ConditionResult.TRUE }, };
}
- // Generates data for case ignore matching rules.
+ /** Generates data for case ignore matching rules. */
@DataProvider(name = "caseFoldRuleData")
public Object[][] createIgnoreRuleData() {
return new Object[][] { { "12345678", "12345678", ConditionResult.TRUE },
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/ASN1ByteSequenceReaderTestCase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/ASN1ByteSequenceReaderTestCase.java
index a44e4c4..30f416e 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/ASN1ByteSequenceReaderTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/ASN1ByteSequenceReaderTestCase.java
@@ -31,7 +31,7 @@
import org.forgerock.opendj.ldap.ByteString;
/**
- * Test class for ASN1ByteSequenceReaderTestCase
+ * Test class for ASN1ByteSequenceReaderTestCase.
*/
public class ASN1ByteSequenceReaderTestCase extends ASN1ReaderTestCase {
@Override
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/ASN1InputStreamReaderTestCase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/ASN1InputStreamReaderTestCase.java
index e397745..406819b 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/ASN1InputStreamReaderTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/ASN1InputStreamReaderTestCase.java
@@ -29,7 +29,7 @@
import java.io.ByteArrayInputStream;
/**
- * Test class for ASN1InputStreamReader
+ * Test class for ASN1InputStreamReader.
*/
public class ASN1InputStreamReaderTestCase extends ASN1ReaderTestCase {
@Override
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/ASN1OutputStreamWriterTestCase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/ASN1OutputStreamWriterTestCase.java
index df33e57..8b260de 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/ASN1OutputStreamWriterTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/ASN1OutputStreamWriterTestCase.java
@@ -30,7 +30,7 @@
import java.io.ByteArrayOutputStream;
/**
- * Test class for ASN1OutputStreamWriter
+ * Test class for ASN1OutputStreamWriter.
*/
public class ASN1OutputStreamWriterTestCase extends ASN1WriterTestCase {
private final ByteArrayOutputStream outStream = new ByteArrayOutputStream();
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/ASN1WriterTestCase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/ASN1WriterTestCase.java
index cdc3789..6993339 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/ASN1WriterTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/ASN1WriterTestCase.java
@@ -46,8 +46,10 @@
@SuppressWarnings("javadoc")
public abstract class ASN1WriterTestCase extends ForgeRockTestCase {
- // Create an array with a selection of the valid single-byte types. We don't
- // support multi-byte types, so this should be a comprehensive data set.
+ /**
+ * Create an array with a selection of the valid single-byte types. We don't
+ * support multi-byte types, so this should be a comprehensive data set.
+ */
private final byte[] testTypes = { 0x00, 0x7f, (byte) 0x80, (byte) 0xff };
/**
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/LDAPReaderWriterTestCase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/LDAPReaderWriterTestCase.java
index 768e9d8..36edfd8 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/LDAPReaderWriterTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/io/LDAPReaderWriterTestCase.java
@@ -77,10 +77,10 @@
@SuppressWarnings("javadoc")
public abstract class LDAPReaderWriterTestCase extends SdkTestCase {
- // message ID is used in all tests
+ /** Message ID is used in all tests. */
private static final int MESSAGE_ID = 0;
- // DN used is several tests
+ /** DN used is several tests. */
private static final String TEST_DN = "cn=test";
interface LDAPWrite {
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/AddressMaskTestCase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/AddressMaskTestCase.java
index de5d493..0c9d7f5 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/AddressMaskTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/AddressMaskTestCase.java
@@ -43,7 +43,7 @@
@SuppressWarnings("javadoc")
public class AddressMaskTestCase extends SdkTestCase {
- /* These are all valid rules -- should all pass. */
+ /** These are all valid rules -- should all pass. */
@DataProvider(name = "validRules")
public Object[][] validData() {
return new Object[][] { { "129.34.55.67" }, { "129.*.78.55" }, { ".central.sun.com" },
@@ -197,7 +197,7 @@
* IPV6 data and tests.
*/
- //Invalid IPv6 expressions.
+ /** Invalid IPv6 expressions. */
@DataProvider(name = "invalid6Rules")
public Object[][] inValid6Data() {
return new Object[][] { { "2001:feca:ba23:cd1f:dcb1:1010:9234:4088///124" },
@@ -208,7 +208,7 @@
{ "1080::8:800:*:417A/66" }, { "2001:fecd:ba23:cd1ff:dcb1:1010:202.45.66.20" }, };
}
- //Valid IPv6 expressions.
+ /** Valid IPv6 expressions. */
@DataProvider(name = "valid6Rules")
public Object[][] valid6Data() {
return new Object[][] { { "2001:fecd:ba23:cd1f:dcb1:1010:9234:4088/124" },
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/AttributeDescriptionTestCase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/AttributeDescriptionTestCase.java
index 619c7a2..7772b10 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/AttributeDescriptionTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/AttributeDescriptionTestCase.java
@@ -225,7 +225,7 @@
assertFalse(iterator.hasNext());
}
- // FIXME: none of these pass! The valueOf method is far to lenient.
+ /** FIXME: none of these pass! The valueOf method is far to lenient. */
@Test(dataProvider = "dataForValueOfInvalidAttributeDescriptions",
expectedExceptions = LocalizedIllegalArgumentException.class)
public void testValueOfInvalidAttributeDescriptions(final String ad) {
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/AttributeParserTestCase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/AttributeParserTestCase.java
index ce524df..6b67122 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/AttributeParserTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/AttributeParserTestCase.java
@@ -307,8 +307,10 @@
e.parseAttribute("type").requireValue().asByteString();
}
- // Smoke test for set of methods: use one type only since the code is common
- // and we've already tested the parsing.
+ /**
+ * Smoke test for set of methods: use one type only since the code is common
+ * and we've already tested the parsing.
+ */
@Test
public void testAsSetOfDN() {
Entry e =
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/AttributesTestCase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/AttributesTestCase.java
index 836cd6b..79d8421 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/AttributesTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/AttributesTestCase.java
@@ -48,11 +48,7 @@
{ "cn;bar" }, { "cn;BAR" }, { "cn;foo;bar" }, { "cn;FOO;bar" }, };
}
- /**
- * Data provider for old and new attributes
- *
- * @return
- */
+ /** Data provider for old and new attributes. */
@DataProvider(name = "dataForAttributeRename")
public Object[][] dataForAttributeRename() {
return new Object[][] { { "cn", "cn", true }, { "CN", "cn", true },
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/ByteSequenceReaderTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/ByteSequenceReaderTest.java
index 3de1d9a..aeec4b9 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/ByteSequenceReaderTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/ByteSequenceReaderTest.java
@@ -33,7 +33,7 @@
import org.testng.annotations.Test;
/**
- * Test class for ByteSequenceReader
+ * Test class for ByteSequenceReader.
*/
@SuppressWarnings("javadoc")
public class ByteSequenceReaderTest extends SdkTestCase {
@@ -189,7 +189,7 @@
@Test(expectedExceptions = IndexOutOfBoundsException.class)
public void testUndersizedGetBERLength() {
- ByteSequenceReader reader = ByteString.wrap(new byte[0]).asReader();
+ ByteSequenceReader reader = ByteString.empty().asReader();
// Shouldn't be able to reader over a 4 byte length.
reader.getBERLength();
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/DNTestCase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/DNTestCase.java
index 1c542b6..7df63f2 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/DNTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/DNTestCase.java
@@ -42,7 +42,7 @@
@SuppressWarnings("javadoc")
public class DNTestCase extends SdkTestCase {
/**
- * child DN test data provider.
+ * Child DN test data provider.
*
* @return The array of test data.
*/
@@ -146,7 +146,7 @@
{ "cn=hello world\\ ,dc=com", "cn=hello world,dc=com", 0 },
{ "cn=HELLO WORLD,dc=com", "cn=hello world,dc=com", 0 },
{ "cn=HELLO+sn=WORLD,dc=com", "sn=world+cn=hello,dc=com", 0 },
- /**
+ /*
* { "x-test-integer-type=10,dc=com",
* "x-test-integer-type=9,dc=com", 1 }, {
* "x-test-integer-type=999,dc=com",
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/LDAPServer.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/LDAPServer.java
index 334bad3..5a5aeef 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/LDAPServer.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/LDAPServer.java
@@ -87,15 +87,15 @@
*/
@SuppressWarnings("javadoc")
public class LDAPServer implements ServerConnectionFactory<LDAPClientContext, Integer> {
- // Creates an abandonable request from the ordinary requests.
+ /** Creates an abandonable request from the ordinary requests. */
private static class AbandonableRequest implements Request {
- // the request.
+ /** The request. */
private final Request request;
- // whether is has been cancelled.
+ /** Whether is has been cancelled. */
private final AtomicBoolean isCanceled;
- // Ctor.
+ /** Ctor. */
AbandonableRequest(final Request request) {
this.request = request;
this.isCanceled = new AtomicBoolean(false);
@@ -131,7 +131,7 @@
}
}
- // The singleton instance.
+ /** The singleton instance. */
private static final LDAPServer INSTANCE = new LDAPServer();
/**
@@ -491,17 +491,19 @@
}
}
- // The mapping between entry DNs and the corresponding entries.
+ /** The mapping between entry DNs and the corresponding entries. */
private final ConcurrentHashMap<DN, Entry> entryMap = new ConcurrentHashMap<DN, Entry>();
- // The LDAP listener.
+ /** The LDAP listener. */
private LDAPListener listener = null;
- // whether the server is running.
+ /** Whether the server is running. */
private volatile boolean isRunning;
- // The mapping between the message id and the requests the server is
- // currently handling.
+ /**
+ * The mapping between the message id and the requests the server is
+ * currently handling.
+ */
private final ConcurrentHashMap<Integer, AbandonableRequest> requestsInProgress =
new ConcurrentHashMap<Integer, AbandonableRequest>();
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/MockConnectionEventListener.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/MockConnectionEventListener.java
index d3c26c7..1d562e9 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/MockConnectionEventListener.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/MockConnectionEventListener.java
@@ -47,18 +47,14 @@
private ExtendedResult notification = null;
private final AtomicInteger invocationCount = new AtomicInteger();
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleConnectionClosed() {
invocationCount.incrementAndGet();
closedLatch.countDown();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleConnectionError(boolean isDisconnectNotification, LdapException error) {
this.isDisconnectNotification = isDisconnectNotification;
@@ -67,9 +63,7 @@
errorLatch.countDown();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleUnsolicitedNotification(ExtendedResult notification) {
this.notification = notification;
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/MockScheduler.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/MockScheduler.java
index 605711c..18d47a0 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/MockScheduler.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/MockScheduler.java
@@ -113,7 +113,7 @@
}
- // Saved scheduled tasks.
+ /** Saved scheduled tasks. */
private final List<Callable<?>> tasks = new CopyOnWriteArrayList<Callable<?>>();
MockScheduler() {
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/RDNTestCase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/RDNTestCase.java
index dd6a9ff..ff3f7e7 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/RDNTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/RDNTestCase.java
@@ -47,13 +47,13 @@
@SuppressWarnings("javadoc")
public final class RDNTestCase extends SdkTestCase {
- // Domain component attribute type.
+ /** Domain component attribute type. */
private static final AttributeType ATTR_TYPE_DC;
- // Common name attribute type.
+ /** Common name attribute type. */
private static final AttributeType ATTR_TYPE_CN;
- // Test attribute value.
+ /** Test attribute value. */
private static final AVA ATTR_VALUE_DC_ORG;
static {
@@ -63,7 +63,7 @@
ATTR_VALUE_DC_ORG = new AVA(ATTR_TYPE_DC, ByteString.valueOf("org"));
}
- // org bytestring.
+ /** "org" bytestring. */
private static final ByteString ORG = ByteString.valueOf("org");
/**
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/requests/RequestsTestCase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/requests/RequestsTestCase.java
index 8bddca8..2a444b8 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/requests/RequestsTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/requests/RequestsTestCase.java
@@ -54,7 +54,7 @@
private static final GenericControl NEW_CONTROL3 = GenericControl.newControl("6.7.8".intern());
private static final GenericControl NEW_CONTROL4 = GenericControl.newControl("8.9.0".intern());
- // Dummy decoder which does nothing.
+ /** Dummy decoder which does nothing. */
private static class MyDecoder implements ControlDecoder<Control> {
public Control decodeControl(final Control control, final DecodeOptions options) throws DecodeException {
// do nothing.
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/AttributeTypeSyntaxTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/AttributeTypeSyntaxTest.java
index ed2367b..f61728e 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/AttributeTypeSyntaxTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/AttributeTypeSyntaxTest.java
@@ -34,9 +34,7 @@
* Attribute type syntax tests.
*/
public class AttributeTypeSyntaxTest extends AbstractSyntaxTestCase {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "acceptableValues")
public Object[][] createAcceptableValues() {
@@ -82,9 +80,7 @@
+ " NO-USER-MODIFICATION USAGE userApplications", false }, };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected Syntax getRule() {
return Schema.getCoreSchema().getSyntax(SYNTAX_ATTRIBUTE_TYPE_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/BitStringEqualityMatchingRuleTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/BitStringEqualityMatchingRuleTest.java
index 62f8eb9..59a3edc 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/BitStringEqualityMatchingRuleTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/BitStringEqualityMatchingRuleTest.java
@@ -34,9 +34,7 @@
* Test the BitStringEqualityMatchingRule.
*/
public class BitStringEqualityMatchingRuleTest extends MatchingRuleTest {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingRuleInvalidAttributeValues")
public Object[][] createMatchingRuleInvalidAttributeValues() {
@@ -44,9 +42,7 @@
{ "\'1010\'A" }, };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingrules")
public Object[][] createMatchingRuleTest() {
@@ -55,9 +51,7 @@
{ "\'0\'B", "\'1\'B", ConditionResult.FALSE }, };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected MatchingRule getRule() {
return Schema.getCoreSchema().getMatchingRule(EMR_BIT_STRING_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/BitStringSyntaxTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/BitStringSyntaxTest.java
index 6b4f0ea..ef31632 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/BitStringSyntaxTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/BitStringSyntaxTest.java
@@ -34,9 +34,7 @@
* Bit string syntax tests.
*/
public class BitStringSyntaxTest extends AbstractSyntaxTestCase {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "acceptableValues")
public Object[][] createAcceptableValues() {
@@ -44,9 +42,7 @@
{ "invalid", false }, { "1", false }, { "'010100000111111010101000'B", true }, };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected Syntax getRule() {
return Schema.getCoreSchema().getSyntax(SYNTAX_BIT_STRING_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/BooleanEqualityMatchingRuleTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/BooleanEqualityMatchingRuleTest.java
index fe5200d..6806cb7 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/BooleanEqualityMatchingRuleTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/BooleanEqualityMatchingRuleTest.java
@@ -35,18 +35,14 @@
*/
public class BooleanEqualityMatchingRuleTest extends MatchingRuleTest {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingRuleInvalidAttributeValues")
public Object[][] createMatchingRuleInvalidAttributeValues() {
return new Object[][] { { "garbage" }, };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingrules")
public Object[][] createMatchingRuleTest() {
@@ -57,9 +53,7 @@
{ "0", "false", ConditionResult.TRUE }, { "TRUE", "false", ConditionResult.FALSE }, };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected MatchingRule getRule() {
return Schema.getCoreSchema().getMatchingRule(EMR_BOOLEAN_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseExactEqualityMatchingRuleTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseExactEqualityMatchingRuleTest.java
index 5bb9b32..2e5ba4e 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseExactEqualityMatchingRuleTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseExactEqualityMatchingRuleTest.java
@@ -35,18 +35,14 @@
*/
public class CaseExactEqualityMatchingRuleTest extends MatchingRuleTest {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingRuleInvalidAttributeValues")
public Object[][] createMatchingRuleInvalidAttributeValues() {
return new Object[][] {};
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingrules")
public Object[][] createMatchingRuleTest() {
@@ -59,9 +55,7 @@
{ "ABC45678", "abc45678", ConditionResult.FALSE }, };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected MatchingRule getRule() {
return Schema.getCoreSchema().getMatchingRule(EMR_CASE_EXACT_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseExactIA5EqualityMatchingRuleTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseExactIA5EqualityMatchingRuleTest.java
index 08d6c11..09f2e2b 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseExactIA5EqualityMatchingRuleTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseExactIA5EqualityMatchingRuleTest.java
@@ -35,18 +35,14 @@
*/
public class CaseExactIA5EqualityMatchingRuleTest extends MatchingRuleTest {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingRuleInvalidAttributeValues")
public Object[][] createMatchingRuleInvalidAttributeValues() {
return new Object[][] { { "12345678\uFFFD" }, };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingrules")
public Object[][] createMatchingRuleTest() {
@@ -61,9 +57,7 @@
};
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected MatchingRule getRule() {
return Schema.getCoreSchema().getMatchingRule(EMR_CASE_EXACT_IA5_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseExactOrderingMatchingRuleTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseExactOrderingMatchingRuleTest.java
index ad2f43b..93d6b30 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseExactOrderingMatchingRuleTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseExactOrderingMatchingRuleTest.java
@@ -34,18 +34,14 @@
*/
public class CaseExactOrderingMatchingRuleTest extends OrderingMatchingRuleTest {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "OrderingMatchingRuleInvalidValues")
public Object[][] createOrderingMatchingRuleInvalidValues() {
return new Object[][] {};
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "Orderingmatchingrules")
public Object[][] createOrderingMatchingRuleTestData() {
@@ -53,9 +49,7 @@
{ "abcdef", "abcdef", 0 }, };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected MatchingRule getRule() {
return Schema.getCoreSchema().getMatchingRule(OMR_CASE_EXACT_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseIgnoreEqualityMatchingRuleTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseIgnoreEqualityMatchingRuleTest.java
index 2246d72..7998f33 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseIgnoreEqualityMatchingRuleTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseIgnoreEqualityMatchingRuleTest.java
@@ -34,18 +34,14 @@
* Test the CaseIgnoreEqualityMatchingRule.
*/
public class CaseIgnoreEqualityMatchingRuleTest extends MatchingRuleTest {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingRuleInvalidAttributeValues")
public Object[][] createMatchingRuleInvalidAttributeValues() {
return new Object[][] {};
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingrules")
public Object[][] createMatchingRuleTest() {
@@ -67,9 +63,7 @@
};
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected MatchingRule getRule() {
return Schema.getCoreSchema().getMatchingRule(EMR_CASE_IGNORE_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseIgnoreIA5EqualityMatchingRuleTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseIgnoreIA5EqualityMatchingRuleTest.java
index d4c593c..2119f78 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseIgnoreIA5EqualityMatchingRuleTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseIgnoreIA5EqualityMatchingRuleTest.java
@@ -35,18 +35,14 @@
*/
public class CaseIgnoreIA5EqualityMatchingRuleTest extends MatchingRuleTest {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingRuleInvalidAttributeValues")
public Object[][] createMatchingRuleInvalidAttributeValues() {
return new Object[][] { { "12345678\uFFFD" }, };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingrules")
public Object[][] createMatchingRuleTest() {
@@ -55,9 +51,7 @@
{ "ABC45678", "abc45678", ConditionResult.TRUE }, };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected MatchingRule getRule() {
return Schema.getCoreSchema().getMatchingRule(EMR_CASE_IGNORE_IA5_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseIgnoreOrderingMatchingRuleTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseIgnoreOrderingMatchingRuleTest.java
index 2477520..81d3a42 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseIgnoreOrderingMatchingRuleTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CaseIgnoreOrderingMatchingRuleTest.java
@@ -34,18 +34,14 @@
*/
public class CaseIgnoreOrderingMatchingRuleTest extends OrderingMatchingRuleTest {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "OrderingMatchingRuleInvalidValues")
public Object[][] createOrderingMatchingRuleInvalidValues() {
return new Object[][] {};
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "Orderingmatchingrules")
public Object[][] createOrderingMatchingRuleTestData() {
@@ -60,9 +56,7 @@
{ "a", "\u00f8", -1 }, };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected MatchingRule getRule() {
return Schema.getCoreSchema().getMatchingRule(OMR_CASE_IGNORE_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationEqualityMatchingRuleTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationEqualityMatchingRuleTest.java
index 37abf89..a5c0659 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationEqualityMatchingRuleTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationEqualityMatchingRuleTest.java
@@ -41,18 +41,14 @@
@Test
public class CollationEqualityMatchingRuleTest extends MatchingRuleTest {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingRuleInvalidAttributeValues")
public Object[][] createMatchingRuleInvalidAttributeValues() {
return new Object[][] { };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingrules")
public Object[][] createMatchingRuleTest() {
@@ -87,9 +83,7 @@
};
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected MatchingRule getRule() {
// Note that oid and names are not used by the test (ie, they could be any value, test should pass anyway)
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationGreaterThanMatchingRuleTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationGreaterThanMatchingRuleTest.java
index f9abe1f..42c2554 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationGreaterThanMatchingRuleTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationGreaterThanMatchingRuleTest.java
@@ -41,18 +41,14 @@
@Test
public class CollationGreaterThanMatchingRuleTest extends MatchingRuleTest {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingRuleInvalidAttributeValues")
public Object[][] createMatchingRuleInvalidAttributeValues() {
return new Object[][] { };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingrules")
public Object[][] createMatchingRuleTest() {
@@ -87,9 +83,7 @@
};
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected MatchingRule getRule() {
// Note that oid and names are not used by the test (ie, they could be any value, test should pass anyway)
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationGreaterThanOrEqualMatchingRuleTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationGreaterThanOrEqualMatchingRuleTest.java
index c70d0ce..0b345d5 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationGreaterThanOrEqualMatchingRuleTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationGreaterThanOrEqualMatchingRuleTest.java
@@ -41,18 +41,14 @@
@Test
public class CollationGreaterThanOrEqualMatchingRuleTest extends MatchingRuleTest {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingRuleInvalidAttributeValues")
public Object[][] createMatchingRuleInvalidAttributeValues() {
return new Object[][] { };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingrules")
public Object[][] createMatchingRuleTest() {
@@ -87,9 +83,7 @@
};
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected MatchingRule getRule() {
// Note that oid and names are not used by the test (ie, they could be any value, test should pass anyway)
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationLessThanMatchingRuleTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationLessThanMatchingRuleTest.java
index 1d9dc7d..eda0ccf 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationLessThanMatchingRuleTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationLessThanMatchingRuleTest.java
@@ -41,18 +41,14 @@
@Test
public class CollationLessThanMatchingRuleTest extends MatchingRuleTest {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingRuleInvalidAttributeValues")
public Object[][] createMatchingRuleInvalidAttributeValues() {
return new Object[][] { };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingrules")
public Object[][] createMatchingRuleTest() {
@@ -87,9 +83,7 @@
};
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected MatchingRule getRule() {
// Note that oid and names are not used by the test (ie, they could be any value, test should pass anyway)
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationLessThanOrEqualMatchingRuleTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationLessThanOrEqualMatchingRuleTest.java
index 9dde742..1e36a5b 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationLessThanOrEqualMatchingRuleTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationLessThanOrEqualMatchingRuleTest.java
@@ -41,18 +41,14 @@
@Test
public class CollationLessThanOrEqualMatchingRuleTest extends MatchingRuleTest {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingRuleInvalidAttributeValues")
public Object[][] createMatchingRuleInvalidAttributeValues() {
return new Object[][] { };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "matchingrules")
public Object[][] createMatchingRuleTest() {
@@ -87,9 +83,7 @@
};
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected MatchingRule getRule() {
// Note that oid and names are not used by the test (ie, they could be any value, test should pass anyway)
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationSubstringMatchingRuleTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationSubstringMatchingRuleTest.java
index 3244d22..585c40f 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationSubstringMatchingRuleTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CollationSubstringMatchingRuleTest.java
@@ -51,9 +51,7 @@
return new Object[][] { };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "substringFinalMatchData")
public Object[][] createSubstringFinalMatchData() {
@@ -84,9 +82,7 @@
};
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "substringInitialMatchData")
public Object[][] createSubstringInitialMatchData() {
@@ -113,9 +109,7 @@
};
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "substringMiddleMatchData")
public Object[][] createSubstringMiddleMatchData() {
@@ -149,9 +143,7 @@
};
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected MatchingRule getRule() {
// Note that oid and names are not used by the test (ie, they could be any value, test should pass anyway)
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CoreSchemaTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CoreSchemaTest.java
index 93fc95a..0f6ae19 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CoreSchemaTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CoreSchemaTest.java
@@ -29,7 +29,7 @@
import org.testng.annotations.Test;
/**
- * Core schema tests
+ * Core schema tests.
*/
@SuppressWarnings("javadoc")
public class CoreSchemaTest extends AbstractSchemaTestCase {
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CountryStringSyntaxTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CountryStringSyntaxTest.java
index 1680147..9df00f7 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CountryStringSyntaxTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/CountryStringSyntaxTest.java
@@ -51,9 +51,7 @@
};
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected Syntax getRule() {
return Schema.getCoreSchema().getSyntax(SYNTAX_COUNTRY_STRING_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/DITContentRuleSyntaxTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/DITContentRuleSyntaxTest.java
index 7b44e53..ef90695 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/DITContentRuleSyntaxTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/DITContentRuleSyntaxTest.java
@@ -70,9 +70,7 @@
};
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected Syntax getRule() {
return Schema.getCoreSchema().getSyntax(SYNTAX_DIT_CONTENT_RULE_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/DistinguishedNameEqualityMatchingRuleTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/DistinguishedNameEqualityMatchingRuleTest.java
index c7d3bbf..ced2d91 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/DistinguishedNameEqualityMatchingRuleTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/DistinguishedNameEqualityMatchingRuleTest.java
@@ -36,7 +36,7 @@
import org.testng.annotations.Test;
/**
- * Test the DistinguishedNameEqualityMatchingRule
+ * Test the DistinguishedNameEqualityMatchingRule.
*/
@SuppressWarnings("javadoc")
public class DistinguishedNameEqualityMatchingRuleTest extends MatchingRuleTest {
@@ -192,7 +192,7 @@
}
/**
- * Test the normalized values
+ * Test the normalized values.
*/
@Test(dataProvider = "testDNs")
public void testNormalization(final String value1, final String value2) throws Exception {
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/EnumSyntaxTestCase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/EnumSyntaxTestCase.java
index 552e637..767c8c6 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/EnumSyntaxTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/EnumSyntaxTestCase.java
@@ -40,9 +40,7 @@
*/
@SuppressWarnings("javadoc")
public class EnumSyntaxTestCase extends AbstractSyntaxTestCase {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "acceptableValues")
public Object[][] createAcceptableValues() {
@@ -85,9 +83,7 @@
builder.toSchema();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected Syntax getRule() throws SchemaException, DecodeException {
final SchemaBuilder builder = new SchemaBuilder(Schema.getCoreSchema());
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/GeneralizedTimeSyntaxTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/GeneralizedTimeSyntaxTest.java
index 4d04511..3ada8fd 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/GeneralizedTimeSyntaxTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/GeneralizedTimeSyntaxTest.java
@@ -52,9 +52,7 @@
{ "200612-1235959Z", false }, { "20061231#35959Z", false }, { "2006", false }, };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected Syntax getRule() {
return Schema.getCoreSchema().getSyntax(SYNTAX_GENERALIZED_TIME_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/GuideSyntaxTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/GuideSyntaxTest.java
index 453b18f..c46802c 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/GuideSyntaxTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/GuideSyntaxTest.java
@@ -34,9 +34,7 @@
* Guide syntax tests.
*/
public class GuideSyntaxTest extends AbstractSyntaxTestCase {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "acceptableValues")
public Object[][] createAcceptableValues() {
@@ -48,9 +46,7 @@
{ "sn$EQ|(cn$APPROX&?false)", true }, { "sn$EQ|(cn$APPROX&|?false)", false }, };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected Syntax getRule() {
return Schema.getCoreSchema().getSyntax(SYNTAX_GUIDE_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/IA5StringSyntaxTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/IA5StringSyntaxTest.java
index 485beb8..732e9ad 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/IA5StringSyntaxTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/IA5StringSyntaxTest.java
@@ -34,18 +34,14 @@
* IA5 string syntax tests.
*/
public class IA5StringSyntaxTest extends AbstractSyntaxTestCase {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "acceptableValues")
public Object[][] createAcceptableValues() {
return new Object[][] { { "12345678", true }, { "12345678\u2163", false }, };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected Syntax getRule() {
return Schema.getCoreSchema().getSyntax(SYNTAX_IA5_STRING_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/LDAPSyntaxTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/LDAPSyntaxTest.java
index f285d79..e5050ba 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/LDAPSyntaxTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/LDAPSyntaxTest.java
@@ -34,9 +34,7 @@
* LDAP syntax tests.
*/
public class LDAPSyntaxTest extends AbstractSyntaxTestCase {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "acceptableValues")
public Object[][] createAcceptableValues() {
@@ -84,9 +82,7 @@
{ "(2.5.4.3 DESC 'syntax description' ", false }, };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected Syntax getRule() {
return Schema.getCoreSchema().getSyntax(SYNTAX_LDAP_SYNTAX_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/MatchingRuleSyntaxTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/MatchingRuleSyntaxTest.java
index 47cf6fe..74d0356 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/MatchingRuleSyntaxTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/MatchingRuleSyntaxTest.java
@@ -34,9 +34,7 @@
* Matching rule syntax tests.
*/
public class MatchingRuleSyntaxTest extends AbstractSyntaxTestCase {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "acceptableValues")
public Object[][] createAcceptableValues() {
@@ -53,9 +51,7 @@
+ " X-name ( 'this is an extension' ) ", false }, };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected Syntax getRule() {
return Schema.getCoreSchema().getSyntax(SYNTAX_MATCHING_RULE_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/MatchingRuleTestCase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/MatchingRuleTestCase.java
index 463be4f..36ccb4d 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/MatchingRuleTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/MatchingRuleTestCase.java
@@ -365,7 +365,7 @@
}
/**
- * Removes all the extra properties
+ * Removes all the extra properties.
*/
@Test()
public final void testBuilderRemoveExtraProperties() {
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/MatchingRuleUseSyntaxTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/MatchingRuleUseSyntaxTest.java
index 1859a7b..d9838dc 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/MatchingRuleUseSyntaxTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/MatchingRuleUseSyntaxTest.java
@@ -34,9 +34,7 @@
* Matching rule use syntax tests.
*/
public class MatchingRuleUseSyntaxTest extends AbstractSyntaxTestCase {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "acceptableValues")
public Object[][] createAcceptableValues() {
@@ -51,9 +49,7 @@
+ " X-name ( 'this is an extension' ) ", false }, };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected Syntax getRule() {
return Schema.getCoreSchema().getSyntax(SYNTAX_MATCHING_RULE_USE_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/NameFormTestCase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/NameFormTestCase.java
index e03411c..6fbe373 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/NameFormTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/NameFormTestCase.java
@@ -830,7 +830,7 @@
}
/**
- * Remove functions uses on names / required attribute /
+ * Remove functions uses on names / required attribute.
*
* @throws SchemaException
*/
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/OtherMailboxSyntaxTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/OtherMailboxSyntaxTest.java
index c68a34b..9d2b659 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/OtherMailboxSyntaxTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/OtherMailboxSyntaxTest.java
@@ -34,18 +34,14 @@
* Other mailbox syntax tests.
*/
public class OtherMailboxSyntaxTest extends AbstractSyntaxTestCase {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "acceptableValues")
public Object[][] createAcceptableValues() {
return new Object[][] { { "MyMail$Mymailbox", true }, { "MyMailMymailbox", false }, };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected Syntax getRule() {
return Schema.getCoreSchema().getSyntax(SYNTAX_OTHER_MAILBOX_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/RegexSyntaxTestCase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/RegexSyntaxTestCase.java
index fbd4f3d..01552ae 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/RegexSyntaxTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/RegexSyntaxTestCase.java
@@ -37,9 +37,7 @@
*/
@SuppressWarnings("javadoc")
public class RegexSyntaxTestCase extends AbstractSyntaxTestCase {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "acceptableValues")
public Object[][] createAcceptableValues() {
@@ -64,9 +62,7 @@
Assert.assertFalse(builder.toSchema().getWarnings().isEmpty());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected Syntax getRule() {
final SchemaBuilder builder = new SchemaBuilder(Schema.getCoreSchema());
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/SubstitutionSyntaxTestCase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/SubstitutionSyntaxTestCase.java
index f5e7155..8d166f7 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/SubstitutionSyntaxTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/SubstitutionSyntaxTestCase.java
@@ -37,9 +37,7 @@
*/
@SuppressWarnings("javadoc")
public class SubstitutionSyntaxTestCase extends AbstractSyntaxTestCase {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "acceptableValues")
public Object[][] createAcceptableValues() {
@@ -107,9 +105,7 @@
Assert.assertFalse(builder.toSchema().getWarnings().isEmpty());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected Syntax getRule() {
// Use IA5String syntax as our substitute.
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/TelexSyntaxTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/TelexSyntaxTest.java
index 0a9f1fb..fa35935 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/TelexSyntaxTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/TelexSyntaxTest.java
@@ -34,9 +34,7 @@
* Telex syntax tests.
*/
public class TelexSyntaxTest extends AbstractSyntaxTestCase {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "acceptableValues")
public Object[][] createAcceptableValues() {
@@ -44,9 +42,7 @@
{ "abcdefghijk$lmnopqr$stuvwxyz", true }, { "12345$67890$()+,-./:? ", true }, };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected Syntax getRule() {
return Schema.getCoreSchema().getSyntax(SYNTAX_TELEX_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/UTCTimeSyntaxTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/UTCTimeSyntaxTest.java
index 959805e..6ecb9f0 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/UTCTimeSyntaxTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/UTCTimeSyntaxTest.java
@@ -178,9 +178,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected Syntax getRule() {
return Schema.getCoreSchema().getSyntax(SYNTAX_UTC_TIME_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/UUIDSyntaxTest.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/UUIDSyntaxTest.java
index 2bc38cc..8fb10a1 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/UUIDSyntaxTest.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldap/schema/UUIDSyntaxTest.java
@@ -34,9 +34,7 @@
* UUID syntax tests.
*/
public class UUIDSyntaxTest extends AbstractSyntaxTestCase {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@DataProvider(name = "acceptableValues")
public Object[][] createAcceptableValues() {
@@ -54,9 +52,7 @@
{ "12345678-9abc-def0-1234-1234567890a", false }, };
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected Syntax getRule() {
return Schema.getCoreSchema().getSyntax(SYNTAX_UUID_OID);
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/ConnectionChangeRecordWriterTestCase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/ConnectionChangeRecordWriterTestCase.java
index 62de09f..08b0aee 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/ConnectionChangeRecordWriterTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/ConnectionChangeRecordWriterTestCase.java
@@ -120,7 +120,7 @@
/**
* ConnectionChangeRecordWriter write a change record (in this example the
- * ChangeRecord is an AddRequest)
+ * ChangeRecord is an AddRequest).
*
* @throws Exception
*/
@@ -141,7 +141,7 @@
/**
* ConnectionChangeRecordWriter write a change record (in this example the
- * ChangeRecord is a DeleteRequest)
+ * ChangeRecord is a DeleteRequest).
*
* @throws Exception
*/
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/EntryGeneratorTestCase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/EntryGeneratorTestCase.java
index d9de9d2..5b3b79e 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/EntryGeneratorTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/EntryGeneratorTestCase.java
@@ -424,9 +424,7 @@
};
}
- /**
- * Test for parsing escaped character in templates
- */
+ /** Test for parsing escaped character in templates. */
@Test(dataProvider = "validTemplates")
public void testParsingEscapeCharInTemplate(String testName, String[] lines) throws Exception {
TemplateFile templateFile = new TemplateFile(schema, null, resourcePath);
@@ -573,7 +571,7 @@
}
/**
- * Test for escaped characters in templates
+ * Test for escaped characters in templates.
*/
@Test(dataProvider = "templatesToTestEscapeChars", dependsOnMethods = { "testParsingEscapeCharInTemplate" })
public void testEscapeCharsFromTemplate(String testName, String[] lines, String attrName, String expectedValue)
@@ -593,7 +591,7 @@
}
/**
- * Test template that combines escaped characters and variables
+ * Test template that combines escaped characters and variables.
*/
@Test(dependsOnMethods = { "testParsingEscapeCharInTemplate" })
public void testCombineEscapeCharInTemplate() throws Exception {
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/LDIFChangeRecordReaderTestCase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/LDIFChangeRecordReaderTestCase.java
index ae8338e..bf079b9 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/LDIFChangeRecordReaderTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/LDIFChangeRecordReaderTestCase.java
@@ -28,15 +28,6 @@
package org.forgerock.opendj.ldif;
-import static org.fest.assertions.Assertions.assertThat;
-import static org.mockito.Matchers.any;
-import static org.mockito.Matchers.anyListOf;
-import static org.mockito.Matchers.eq;
-import static org.mockito.Mockito.doThrow;
-import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.times;
-import static org.mockito.Mockito.verify;
-
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
@@ -65,6 +56,10 @@
import org.forgerock.opendj.ldap.schema.SchemaValidationPolicy.Action;
import org.testng.annotations.Test;
+import static org.fest.assertions.Assertions.*;
+import static org.mockito.Matchers.*;
+import static org.mockito.Mockito.*;
+
/**
* This class tests the LDIFChangeRecordReader functionality.
*/
@@ -2420,10 +2415,8 @@
}
/**
- * valueOfLDIFChangeRecord cause an exception due to the presence of
- * multiple change record.
- *
- * @throws Exception
+ * {@link LDIFChangeRecordReader#valueOfLDIFChangeRecord(String...)} cause
+ * an exception due to the presence of multiple change record.
*/
@Test(expectedExceptions = LocalizedIllegalArgumentException.class)
public void testValueOfLDIFChangeRecordDoesntAllowMultipleChangeRecords() throws Exception {
@@ -2454,10 +2447,8 @@
}
/**
- * valueOfLDIFChangeRecord cause an exception due to badly formed ldif. In
- * this case, DN is missing.
- *
- * @throws Exception
+ * {@link LDIFChangeRecordReader#valueOfLDIFChangeRecord(String...)} cause
+ * an exception due to badly formed ldif. In this case, DN is missing.
*/
@Test(expectedExceptions = LocalizedIllegalArgumentException.class)
public void testValueOfLDIFChangeRecordMalformedLDIFDNIsMissing() throws Exception {
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/LDIFEntryReaderTestCase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/LDIFEntryReaderTestCase.java
index 4aacd9a..328e1f4 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/LDIFEntryReaderTestCase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/LDIFEntryReaderTestCase.java
@@ -257,7 +257,8 @@
}
/**
- * setExcludeAttributeDoesn't allow null.
+ * {@link LDIFEntryReader#setExcludeAttribute(AttributeDescription)}
+ * does not allow null.
*
* @throws Exception
*/
@@ -294,7 +295,7 @@
/**
* Test to read an entry excluding all operational attributes
- * setExcludeAllOperationalAttributes is forced to true
+ * setExcludeAllOperationalAttributes is forced to true.
*
* @throws Exception
*/
@@ -959,9 +960,7 @@
}
/**
- * Test to read an entry containing spaces before the attribute
- *
- * @throws Exception
+ * Test to read an entry containing spaces before the attribute.
*/
@Test()
public void testReadEntryWithAttributesSpacesAtStart() throws Exception {
@@ -1063,7 +1062,7 @@
/**
* Test to read an entry containing duplicates values
* ERR_LDIF_MULTI_VALUED_SINGLE_VALUED_ATTRIBUTE &&
- * WARN_LDIF_DUPLICATE_ATTRIBUTE_VALUE
+ * WARN_LDIF_DUPLICATE_ATTRIBUTE_VALUE.
*
* @throws Exception
*/
diff --git a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/TemplateTagTestcase.java b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/TemplateTagTestcase.java
index d838a2d..777d297 100644
--- a/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/TemplateTagTestcase.java
+++ b/opendj-sdk/opendj-core/src/test/java/org/forgerock/opendj/ldif/TemplateTagTestcase.java
@@ -240,12 +240,12 @@
tagWithArguments(new AttributeValueTag(), templateWithNoAttribute(), "dc");
}
- /** Helper method to initialize tags with template having any attribute and some arguments*/
+ /** Helper method to initialize tags with template having any attribute and some arguments. */
private void tagWithArguments(TemplateTag tag, String... arguments) throws DecodeException {
tagWithArguments(tag, templateWithAnyAttribute(), arguments);
}
- /** Helper method to initialize tags with template and some arguments*/
+ /** Helper method to initialize tags with template and some arguments. */
private void tagWithArguments(TemplateTag tag, Template template, String... arguments)
throws DecodeException {
tag.initializeForTemplate(Schema.getDefaultSchema(), NULL_TEMPLATE_FILE, template,
@@ -277,14 +277,14 @@
return templateVal;
}
- /** Helper method to build a template that always return true on attribute type check */
+ /** Helper method to build a template that always return true on attribute type check. */
private Template templateWithAnyAttribute() {
Template template = mock(Template.class);
when(template.hasAttribute(any(AttributeType.class))).thenReturn(true);
return template;
}
- /** Helper method to build a template that always return false on attribute type check */
+ /** Helper method to build a template that always return false on attribute type check. */
private Template templateWithNoAttribute() {
Template template = mock(Template.class);
when(template.hasAttribute(any(AttributeType.class))).thenReturn(false);
diff --git a/opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/ASN1BufferReader.java b/opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/ASN1BufferReader.java
index 187eec7..c7a250b 100644
--- a/opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/ASN1BufferReader.java
+++ b/opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/ASN1BufferReader.java
@@ -201,9 +201,7 @@
return (state != ASN1.ELEMENT_READ_STATE_NEED_TYPE) || needTypeState(true);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int peekLength() throws IOException {
peekType();
@@ -219,9 +217,7 @@
return peekLength;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public byte peekType() throws IOException {
if (state == ASN1.ELEMENT_READ_STATE_NEED_TYPE) {
needTypeState(false);
@@ -230,9 +226,7 @@
return peekType;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean readBoolean() throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -251,9 +245,7 @@
return readByte != 0x00;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void readEndSequence() throws IOException {
readLimiter = readLimiter.endSequence();
@@ -269,18 +261,14 @@
readEndSequence();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void readEndSet() throws IOException {
// From an implementation point of view, a set is equivalent to a
// sequence.
readEndSequence();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int readEnumerated() throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -295,9 +283,7 @@
return (int) readInteger();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public long readInteger() throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -337,9 +323,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void readNull() throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -355,9 +339,7 @@
state = ASN1.ELEMENT_READ_STATE_NEED_TYPE;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteString readOctetString() throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -378,9 +360,7 @@
return ByteString.wrap(value);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ByteStringBuilder readOctetString(final ByteStringBuilder builder) throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -403,9 +383,7 @@
return builder;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String readOctetStringAsString() throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -442,9 +420,7 @@
return str;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void readStartSequence() throws IOException {
// Read the header if haven't done so already
peekLength();
@@ -463,18 +439,14 @@
readStartSequence();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void readStartSet() throws IOException {
// From an implementation point of view, a set is equivalent to a
// sequence.
readStartSequence();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Reader skipElement() throws IOException {
// Read the header if haven't done so already
peekLength();
diff --git a/opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/ASN1BufferWriter.java b/opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/ASN1BufferWriter.java
index 47e6edc..598031a 100644
--- a/opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/ASN1BufferWriter.java
+++ b/opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/ASN1BufferWriter.java
@@ -217,9 +217,7 @@
outBuffer.clear();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeBoolean(final byte type, final boolean booleanValue) throws IOException {
sequenceBuffer.writeByte(type);
writeLength(sequenceBuffer, 1);
@@ -229,32 +227,24 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeEndSequence() throws IOException {
sequenceBuffer = sequenceBuffer.endSequence();
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeEndSet() throws IOException {
return writeEndSequence();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeEnumerated(final byte type, final int intValue) throws IOException {
return writeInteger(type, intValue);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeInteger(final byte type, final int intValue) throws IOException {
sequenceBuffer.writeByte(type);
if (((intValue < 0) && ((intValue & 0xFFFFFF80) == 0xFFFFFF80))
@@ -286,9 +276,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeInteger(final byte type, final long longValue) throws IOException {
sequenceBuffer.writeByte(type);
if (((longValue < 0) && ((longValue & 0xFFFFFFFFFFFFFF80L) == 0xFFFFFFFFFFFFFF80L))
@@ -362,9 +350,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeNull(final byte type) throws IOException {
sequenceBuffer.writeByte(type);
writeLength(sequenceBuffer, 0);
@@ -373,9 +359,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeOctetString(final byte type, final byte[] value, final int offset,
final int length) throws IOException {
sequenceBuffer.writeByte(type);
@@ -386,9 +370,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeOctetString(final byte type, final ByteSequence value)
throws IOException {
sequenceBuffer.writeByte(type);
@@ -402,9 +384,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeOctetString(final byte type, final String value) throws IOException {
sequenceBuffer.writeByte(type);
@@ -421,9 +401,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeStartSequence(final byte type) throws IOException {
// Get a child sequence buffer
sequenceBuffer = sequenceBuffer.startSequence(type);
@@ -432,9 +410,7 @@
return this;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public ASN1Writer writeStartSet(final byte type) throws IOException {
// From an implementation point of view, a set is equivalent to a
// sequence.
diff --git a/opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/GrizzlyUtils.java b/opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/GrizzlyUtils.java
index 28b2485..6b37b0f 100644
--- a/opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/GrizzlyUtils.java
+++ b/opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/GrizzlyUtils.java
@@ -225,7 +225,7 @@
}
}
- // Prevent instantiation.
+ /** Prevent instantiation. */
private GrizzlyUtils() {
// No implementation required.
}
diff --git a/opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/LDAPClientFilter.java b/opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/LDAPClientFilter.java
index e90e5ef..267bd1d 100644
--- a/opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/LDAPClientFilter.java
+++ b/opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/LDAPClientFilter.java
@@ -363,7 +363,7 @@
}
}
- // Needed in order to expose type information.
+ /** Needed in order to expose type information. */
private <R extends ExtendedResult> void handleExtendedResult0(
final GrizzlyLDAPConnection conn, final ExtendedResultLdapPromiseImpl<R> promise,
final ExtendedResult result) throws DecodeException {
diff --git a/opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/LDAPServerFilter.java b/opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/LDAPServerFilter.java
index da3c425..0a080fd 100644
--- a/opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/LDAPServerFilter.java
+++ b/opendj-sdk/opendj-grizzly/src/main/java/org/forgerock/opendj/grizzly/LDAPServerFilter.java
@@ -27,8 +27,6 @@
package org.forgerock.opendj.grizzly;
-import static org.forgerock.opendj.grizzly.GrizzlyUtils.configureConnection;
-
import java.io.IOException;
import java.net.InetSocketAddress;
import java.security.GeneralSecurityException;
@@ -46,10 +44,10 @@
import org.forgerock.opendj.ldap.ByteString;
import org.forgerock.opendj.ldap.ConnectionSecurityLayer;
import org.forgerock.opendj.ldap.DecodeOptions;
-import org.forgerock.opendj.ldap.LdapException;
import org.forgerock.opendj.ldap.IntermediateResponseHandler;
import org.forgerock.opendj.ldap.LDAPClientContext;
import org.forgerock.opendj.ldap.LDAPListenerOptions;
+import org.forgerock.opendj.ldap.LdapException;
import org.forgerock.opendj.ldap.ResultCode;
import org.forgerock.opendj.ldap.ResultHandler;
import org.forgerock.opendj.ldap.SSLContextBuilder;
@@ -76,6 +74,7 @@
import org.forgerock.opendj.ldap.responses.Result;
import org.forgerock.opendj.ldap.responses.SearchResultEntry;
import org.forgerock.opendj.ldap.responses.SearchResultReference;
+import org.forgerock.util.Reject;
import org.glassfish.grizzly.Connection;
import org.glassfish.grizzly.Grizzly;
import org.glassfish.grizzly.attributes.Attribute;
@@ -86,7 +85,8 @@
import org.glassfish.grizzly.ssl.SSLEngineConfigurator;
import org.glassfish.grizzly.ssl.SSLFilter;
import org.glassfish.grizzly.ssl.SSLUtils;
-import org.forgerock.util.Reject;
+
+import static org.forgerock.opendj.grizzly.GrizzlyUtils.*;
/**
* Grizzly filter implementation for decoding LDAP requests and handling server
@@ -107,6 +107,7 @@
*/
private static final LDAPWrite<IntermediateResponse> INTERMEDIATE =
new LDAPWrite<IntermediateResponse>() {
+ @Override
public void perform(LDAPWriter<ASN1BufferWriter> writer, int messageID,
IntermediateResponse resp) throws IOException {
writer.writeIntermediateResponse(messageID, resp);
@@ -140,6 +141,7 @@
*/
private void defaultHandleResult(final R result) {
writeMessage(new LDAPWrite<R>() {
+ @Override
public void perform(LDAPWriter<ASN1BufferWriter> writer, int messageID, R res)
throws IOException {
writeResult(writer, res);
@@ -341,9 +343,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
@@ -520,6 +520,7 @@
@Override
public void handleResult(final ExtendedResult result) {
writeMessage(new LDAPWrite<ExtendedResult>() {
+ @Override
public void perform(LDAPWriter<ASN1BufferWriter> writer, int messageID,
ExtendedResult message) throws IOException {
writer.writeExtendedResult(messageID, message);
@@ -577,6 +578,7 @@
@Override
public boolean handleEntry(final SearchResultEntry entry) {
writeMessage(new LDAPWrite<SearchResultEntry>() {
+ @Override
public void perform(LDAPWriter<ASN1BufferWriter> writer, int messageID,
SearchResultEntry sre) throws IOException {
writer.writeSearchResultEntry(messageID, sre);
@@ -593,6 +595,7 @@
@Override
public boolean handleReference(final SearchResultReference reference) {
writeMessage(new LDAPWrite<SearchResultReference>() {
+ @Override
public void perform(LDAPWriter<ASN1BufferWriter> writer, int messageID,
SearchResultReference ref) throws IOException {
writer.writeSearchResultReference(messageID, ref);
@@ -607,10 +610,12 @@
writer.writeSearchResult(messageID, result);
}
}
-
- // Map of cipher phrases to effective key size (bits). Taken from the
- // following RFCs: 5289, 4346, 3268,4132 and 4162.
// @formatter:off
+
+ /**
+ * Map of cipher phrases to effective key size (bits). Taken from the
+ * following RFCs: 5289, 4346, 3268,4132 and 4162.
+ */
private static final Object[][] CIPHER_KEY_SIZES = {
{ "_WITH_AES_256_CBC_", 256 },
{ "_WITH_CAMELLIA_256_CBC_", 256 },
@@ -631,9 +636,11 @@
{ "_WITH_DES40_CBC_", 40 },
{ "_WITH_NULL_", 0 },
};
- // @formatter:on
- // Default maximum request size for incoming requests.
+ // @formatter:on
+ /**
+ * Default maximum request size for incoming requests.
+ */
private static final int DEFAULT_MAX_REQUEST_SIZE = 5 * 1024 * 1024;
private static final Attribute<ClientContextImpl> LDAP_CONNECTION_ATTR =
@@ -687,6 +694,7 @@
*
* @return the reader to read incoming LDAP messages
*/
+ @Override
public LDAPReader<ASN1BufferReader> getReader() {
return reader;
}
diff --git a/opendj-sdk/opendj-grizzly/src/test/java/org/forgerock/opendj/grizzly/GrizzlyLDAPConnectionFactoryTestCase.java b/opendj-sdk/opendj-grizzly/src/test/java/org/forgerock/opendj/grizzly/GrizzlyLDAPConnectionFactoryTestCase.java
index bb5d9ae..8886b23 100644
--- a/opendj-sdk/opendj-grizzly/src/test/java/org/forgerock/opendj/grizzly/GrizzlyLDAPConnectionFactoryTestCase.java
+++ b/opendj-sdk/opendj-grizzly/src/test/java/org/forgerock/opendj/grizzly/GrizzlyLDAPConnectionFactoryTestCase.java
@@ -81,14 +81,14 @@
*/
@SuppressWarnings({ "javadoc", "unchecked" })
public class GrizzlyLDAPConnectionFactoryTestCase extends SdkTestCase {
- /*
+ /**
* The number of test iterations for unit tests which attempt to expose
* potential race conditions. Manual testing has gone up to 10000
* iterations.
*/
private static final int ITERATIONS = 100;
- // Test timeout for tests which need to wait for network events.
+ /** Test timeout for tests which need to wait for network events. */
private static final long TEST_TIMEOUT = 30L;
/*
diff --git a/opendj-sdk/opendj-grizzly/src/test/java/org/forgerock/opendj/grizzly/GrizzlyLDAPListenerTestCase.java b/opendj-sdk/opendj-grizzly/src/test/java/org/forgerock/opendj/grizzly/GrizzlyLDAPListenerTestCase.java
index 5a9b2a9..05cc7a8 100644
--- a/opendj-sdk/opendj-grizzly/src/test/java/org/forgerock/opendj/grizzly/GrizzlyLDAPListenerTestCase.java
+++ b/opendj-sdk/opendj-grizzly/src/test/java/org/forgerock/opendj/grizzly/GrizzlyLDAPListenerTestCase.java
@@ -93,18 +93,14 @@
// Do nothing.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleAbandon(final Integer requestContext, final AbandonRequest request)
throws UnsupportedOperationException {
// Do nothing.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleAdd(final Integer requestContext, final AddRequest request,
final IntermediateResponseHandler intermediateResponseHandler,
@@ -112,9 +108,7 @@
resultHandler.handleResult(Responses.newResult(ResultCode.SUCCESS));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleBind(final Integer requestContext, final int version,
final BindRequest request,
@@ -123,9 +117,7 @@
resultHandler.handleResult(Responses.newBindResult(ResultCode.SUCCESS));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleCompare(final Integer requestContext, final CompareRequest request,
final IntermediateResponseHandler intermediateResponseHandler,
@@ -134,33 +126,25 @@
resultHandler.handleResult(Responses.newCompareResult(ResultCode.SUCCESS));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleConnectionClosed(final Integer requestContext, final UnbindRequest request) {
isClosed.countDown();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleConnectionDisconnected(final ResultCode resultCode, final String message) {
// Do nothing.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleConnectionError(final Throwable error) {
connectionError.handleResult(error);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleDelete(final Integer requestContext, final DeleteRequest request,
final IntermediateResponseHandler intermediateResponseHandler,
@@ -168,9 +152,7 @@
resultHandler.handleResult(Responses.newResult(ResultCode.SUCCESS));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public <R extends ExtendedResult> void handleExtendedRequest(final Integer requestContext,
final ExtendedRequest<R> request,
@@ -181,9 +163,7 @@
"Extended operation " + request.getOID() + " not supported")));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleModify(final Integer requestContext, final ModifyRequest request,
final IntermediateResponseHandler intermediateResponseHandler,
@@ -191,9 +171,7 @@
resultHandler.handleResult(Responses.newResult(ResultCode.SUCCESS));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleModifyDN(final Integer requestContext, final ModifyDNRequest request,
final IntermediateResponseHandler intermediateResponseHandler,
@@ -201,9 +179,7 @@
resultHandler.handleResult(Responses.newResult(ResultCode.SUCCESS));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleSearch(final Integer requestContext, final SearchRequest request,
final IntermediateResponseHandler intermediateResponseHandler, final SearchResultHandler entryHandler,
@@ -222,9 +198,7 @@
this.serverConnection = serverConnection;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ServerConnection<Integer> handleAccept(final LDAPClientContext clientContext) throws LdapException {
serverConnection.context.handleResult(clientContext);
@@ -438,9 +412,7 @@
final MockServerConnection proxyServerConnection = new MockServerConnection() {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleBind(final Integer requestContext, final int version,
final BindRequest request,
@@ -592,9 +564,7 @@
try {
final MockServerConnection proxyServerConnection = new MockServerConnection() {
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void handleBind(final Integer requestContext, final int version,
final BindRequest request,
diff --git a/opendj-sdk/opendj-ldap-sdk-examples/src/main/java/org/forgerock/opendj/examples/GetInfo.java b/opendj-sdk/opendj-ldap-sdk-examples/src/main/java/org/forgerock/opendj/examples/GetInfo.java
index 4432544..d082ab6 100644
--- a/opendj-sdk/opendj-ldap-sdk-examples/src/main/java/org/forgerock/opendj/examples/GetInfo.java
+++ b/opendj-sdk/opendj-ldap-sdk-examples/src/main/java/org/forgerock/opendj/examples/GetInfo.java
@@ -39,10 +39,10 @@
* Demonstrates accessing server information about capabilities and schema.
*/
public final class GetInfo {
- // Connection information
+ /** Connection information. */
private static String host;
private static int port;
- // The kind of server information to request (all, controls, extops)
+ /** The kind of server information to request (all, controls, extops). */
private static String infoType;
/**
diff --git a/opendj-sdk/opendj-ldap-toolkit/src/test/java/com/forgerock/opendj/ldap/tools/ConnectionFactoryProviderTest.java b/opendj-sdk/opendj-ldap-toolkit/src/test/java/com/forgerock/opendj/ldap/tools/ConnectionFactoryProviderTest.java
index eaade11..fc7bfc7 100644
--- a/opendj-sdk/opendj-ldap-toolkit/src/test/java/com/forgerock/opendj/ldap/tools/ConnectionFactoryProviderTest.java
+++ b/opendj-sdk/opendj-ldap-toolkit/src/test/java/com/forgerock/opendj/ldap/tools/ConnectionFactoryProviderTest.java
@@ -57,8 +57,8 @@
connectionFactoryProvider = new ConnectionFactoryProvider(argParser, app);
}
+ /** Issue OPENDJ-734. */
@Test
- /** Issue OPENDJ-734 */
public void getConnectionFactoryShouldAllowNullTrustStorePassword() throws Exception {
// provide a trustStorePath but no password
String trustStorePath = new File(getClass().getClassLoader().getResource("dummy-truststore").toURI())
diff --git a/opendj-sdk/opendj-ldap-toolkit/src/test/java/com/forgerock/opendj/ldap/tools/LDAPSearchITCase.java b/opendj-sdk/opendj-ldap-toolkit/src/test/java/com/forgerock/opendj/ldap/tools/LDAPSearchITCase.java
index 3a26592..d6ee882 100644
--- a/opendj-sdk/opendj-ldap-toolkit/src/test/java/com/forgerock/opendj/ldap/tools/LDAPSearchITCase.java
+++ b/opendj-sdk/opendj-ldap-toolkit/src/test/java/com/forgerock/opendj/ldap/tools/LDAPSearchITCase.java
@@ -42,7 +42,7 @@
import org.testng.annotations.Test;
/**
- * Simple integration tests to check the ldapsearch command
+ * Simple integration tests to check the ldapsearch command.
*/
@SuppressWarnings("javadoc")
public class LDAPSearchITCase extends ToolsITCase {
diff --git a/opendj-sdk/opendj-ldap-toolkit/src/test/java/com/forgerock/opendj/ldap/tools/MakeLDIFTestCase.java b/opendj-sdk/opendj-ldap-toolkit/src/test/java/com/forgerock/opendj/ldap/tools/MakeLDIFTestCase.java
index 3672dd1..e7be097 100644
--- a/opendj-sdk/opendj-ldap-toolkit/src/test/java/com/forgerock/opendj/ldap/tools/MakeLDIFTestCase.java
+++ b/opendj-sdk/opendj-ldap-toolkit/src/test/java/com/forgerock/opendj/ldap/tools/MakeLDIFTestCase.java
@@ -115,7 +115,7 @@
}
}
- /** Arguments passed to the command */
+ /** Arguments passed to the command. */
private String[] args(String...arguments) {
return arguments;
}
diff --git a/opendj-sdk/opendj-ldap-toolkit/src/test/java/com/forgerock/opendj/ldap/tools/ToolsITCase.java b/opendj-sdk/opendj-ldap-toolkit/src/test/java/com/forgerock/opendj/ldap/tools/ToolsITCase.java
index ec20d54..faf7e1e 100644
--- a/opendj-sdk/opendj-ldap-toolkit/src/test/java/com/forgerock/opendj/ldap/tools/ToolsITCase.java
+++ b/opendj-sdk/opendj-ldap-toolkit/src/test/java/com/forgerock/opendj/ldap/tools/ToolsITCase.java
@@ -29,8 +29,6 @@
import static com.forgerock.opendj.cli.Utils.wrapText;
import static org.fest.assertions.Assertions.assertThat;
-import java.io.UnsupportedEncodingException;
-
import org.forgerock.i18n.LocalizableMessage;
import org.forgerock.opendj.ldap.ByteStringBuilder;
import org.forgerock.opendj.ldap.TestCaseUtils;
@@ -39,8 +37,9 @@
import org.testng.annotations.BeforeClass;
/**
- * Class used for the toolkit integration tests
+ * Class used for the toolkit integration tests.
*/
+@SuppressWarnings("javadoc")
public abstract class ToolsITCase extends ForgeRockTestCase {
@BeforeClass
@@ -54,7 +53,7 @@
}
/**
- * Check both out and err outputs streams
+ * Check both out and err outputs streams.
*
* @param out
* output stream from the toolkit application
@@ -64,7 +63,7 @@
* String or LocalizedMessage expected on output
* @param expectedError
* String or LocalizedMessage expected on error output
- * @throws UnsupportedEncodingException
+ * @throws Exception
*/
protected void checkOuputStreams(ByteStringBuilder out, ByteStringBuilder err, Object expectedOutput,
Object expectedError) throws Exception {
@@ -91,7 +90,7 @@
}
- /** Arguments passed to the command */
+ /** Arguments passed to the command. */
protected String[] args(String... arguments) {
return arguments;
}
diff --git a/opendj-sdk/opendj-rest2ldap-servlet/src/main/java/org/forgerock/opendj/rest2ldap/servlet/Rest2LDAPAuthnFilter.java b/opendj-sdk/opendj-rest2ldap-servlet/src/main/java/org/forgerock/opendj/rest2ldap/servlet/Rest2LDAPAuthnFilter.java
index a212d74..ef3e239 100644
--- a/opendj-sdk/opendj-rest2ldap-servlet/src/main/java/org/forgerock/opendj/rest2ldap/servlet/Rest2LDAPAuthnFilter.java
+++ b/opendj-sdk/opendj-rest2ldap-servlet/src/main/java/org/forgerock/opendj/rest2ldap/servlet/Rest2LDAPAuthnFilter.java
@@ -386,7 +386,7 @@
}
}
- /*
+ /**
* Get a bind connection and then perform the bind operation, setting the
* cached connection and authorization credentials on completion.
*/
diff --git a/opendj-sdk/opendj-rest2ldap-servlet/src/main/java/org/forgerock/opendj/rest2ldap/servlet/Rest2LDAPConnectionFactoryProvider.java b/opendj-sdk/opendj-rest2ldap-servlet/src/main/java/org/forgerock/opendj/rest2ldap/servlet/Rest2LDAPConnectionFactoryProvider.java
index f7d426a..4658711 100644
--- a/opendj-sdk/opendj-rest2ldap-servlet/src/main/java/org/forgerock/opendj/rest2ldap/servlet/Rest2LDAPConnectionFactoryProvider.java
+++ b/opendj-sdk/opendj-rest2ldap-servlet/src/main/java/org/forgerock/opendj/rest2ldap/servlet/Rest2LDAPConnectionFactoryProvider.java
@@ -152,7 +152,7 @@
}
}
- // Prevent instantiation.
+ /** Prevent instantiation. */
private Rest2LDAPConnectionFactoryProvider() {
// Nothing to do.
}
diff --git a/opendj-sdk/opendj-rest2ldap-servlet/src/main/java/org/forgerock/opendj/rest2ldap/servlet/Rest2LDAPContextFactory.java b/opendj-sdk/opendj-rest2ldap-servlet/src/main/java/org/forgerock/opendj/rest2ldap/servlet/Rest2LDAPContextFactory.java
index 92ed701..d16dc3d 100644
--- a/opendj-sdk/opendj-rest2ldap-servlet/src/main/java/org/forgerock/opendj/rest2ldap/servlet/Rest2LDAPContextFactory.java
+++ b/opendj-sdk/opendj-rest2ldap-servlet/src/main/java/org/forgerock/opendj/rest2ldap/servlet/Rest2LDAPContextFactory.java
@@ -80,7 +80,7 @@
public static final String ATTRIBUTE_AUTHN_CONNECTION =
"org.forgerock.opendj.rest2ldap.authn-connection";
- // Singleton instance.
+ /** Singleton instance. */
private static final Rest2LDAPContextFactory INSTANCE = new Rest2LDAPContextFactory();
/**
diff --git a/opendj-sdk/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/AuthenticatedConnectionContext.java b/opendj-sdk/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/AuthenticatedConnectionContext.java
index 84e67c6..19a5f93 100644
--- a/opendj-sdk/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/AuthenticatedConnectionContext.java
+++ b/opendj-sdk/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/AuthenticatedConnectionContext.java
@@ -92,9 +92,7 @@
throw new InternalServerErrorException(i18n("Cached LDAP connections cannot be restored"));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected void saveToJson(final JsonValue savedContext, final PersistenceConfig config)
throws ResourceException {
diff --git a/opendj-sdk/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/Context.java b/opendj-sdk/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/Context.java
index aefadc6..9ba7cc4 100644
--- a/opendj-sdk/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/Context.java
+++ b/opendj-sdk/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/Context.java
@@ -66,7 +66,7 @@
*/
final class Context implements Closeable {
- /*
+ /**
* A cached read request - see cachedReads for more information.
*/
private static final class CachedRead implements SearchResultHandler, ResultHandler<Result> {
@@ -181,7 +181,7 @@
}
- /*
+ /**
* An LRU cache of recent reads requests. This is used in order to reduce
* the number of repeated read operations performed when resolving DN
* references.
@@ -217,9 +217,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void close() {
connection.close();
@@ -305,7 +303,7 @@
}
}
- /*
+ /**
* Adds read caching support to the provided connection as well
* functionality which automatically adds the proxied authorization control
* if needed.
@@ -406,9 +404,7 @@
connection.removeConnectionEventListener(listener);
}
- /*
- * Try and re-use a cached result if possible.
- */
+ /** Try and re-use a cached result if possible. */
@Override
public LdapPromise<Result> searchAsync(final SearchRequest request,
final IntermediateResponseHandler intermediateResponseHandler, final SearchResultHandler entryHandler) {
diff --git a/opendj-sdk/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/ObjectAttributeMapper.java b/opendj-sdk/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/ObjectAttributeMapper.java
index 214b66d..8cc1ff7 100644
--- a/opendj-sdk/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/ObjectAttributeMapper.java
+++ b/opendj-sdk/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/ObjectAttributeMapper.java
@@ -307,7 +307,7 @@
}, h));
}
- /*
+ /**
* Fail immediately if the JSON value has the wrong type or contains unknown
* attributes.
*/
diff --git a/opendj-sdk/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/Utils.java b/opendj-sdk/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/Utils.java
index c67cba4..df07809 100644
--- a/opendj-sdk/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/Utils.java
+++ b/opendj-sdk/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/Utils.java
@@ -58,7 +58,8 @@
* The type of result.
*/
private static final class AccumulatingResultHandler<V> implements ResultHandler<V> {
- private ResourceException exception; // Guarded by latch.
+ /** Guarded by latch. */
+ private ResourceException exception;
private final ResultHandler<List<V>> handler;
private final AtomicInteger latch;
private final List<V> results;
@@ -353,7 +354,7 @@
}
}
- // Prevent instantiation.
+ /** Prevent instantiation. */
private Utils() {
// No implementation required.
}
diff --git a/opendj-sdk/opendj-rest2ldap/src/test/java/org/forgerock/opendj/rest2ldap/BasicRequestsTest.java b/opendj-sdk/opendj-rest2ldap/src/test/java/org/forgerock/opendj/rest2ldap/BasicRequestsTest.java
index 16b4f14..bf631bf 100644
--- a/opendj-sdk/opendj-rest2ldap/src/test/java/org/forgerock/opendj/rest2ldap/BasicRequestsTest.java
+++ b/opendj-sdk/opendj-rest2ldap/src/test/java/org/forgerock/opendj/rest2ldap/BasicRequestsTest.java
@@ -467,7 +467,7 @@
assertThat(resource.getContent().get("_rev").asString()).isNull();
}
- // Disabled - see CREST-86 (Should JSON resource fields be case insensitive?)
+ /** Disabled - see CREST-86 (Should JSON resource fields be case insensitive?) */
@Test(enabled = false)
public void testReadSelectPartialInsensitive() throws Exception {
final Resource resource =
diff --git a/opendj-sdk/opendj-server-example-plugin/src/main/java/com/example/opendj/ExamplePlugin.java b/opendj-sdk/opendj-server-example-plugin/src/main/java/com/example/opendj/ExamplePlugin.java
index b4d795c..b728d98 100644
--- a/opendj-sdk/opendj-server-example-plugin/src/main/java/com/example/opendj/ExamplePlugin.java
+++ b/opendj-sdk/opendj-server-example-plugin/src/main/java/com/example/opendj/ExamplePlugin.java
@@ -49,9 +49,7 @@
// No implementation required.
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public ConfigChangeResult applyConfigurationChange(final ExamplePluginCfg config) {
// The new configuration has already been validated.
@@ -60,9 +58,7 @@
return new ConfigChangeResult(ResultCode.SUCCESS, false);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean isConfigurationChangeAcceptable(final ExamplePluginCfg config,
final List<LocalizableMessage> messages) {
diff --git a/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/core/AbstractDataProvider.java b/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/core/AbstractDataProvider.java
index 6afcfb1..41457a1 100644
--- a/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/core/AbstractDataProvider.java
+++ b/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/core/AbstractDataProvider.java
@@ -43,7 +43,7 @@
public abstract class AbstractDataProvider implements DataProvider {
private static final Logger debugLogger = LoggerFactory.getLogger(AbstractDataProvider.class);
- // The list of event listeners associated with this data provider.
+ /** The list of event listeners associated with this data provider. */
private final List<DataProviderEventListener> eventListeners =
new CopyOnWriteArrayList<DataProviderEventListener>();
@@ -65,17 +65,13 @@
return getEntry(dn) != null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final void deregisterEventListener(final DataProviderEventListener listener) {
eventListeners.remove(listener);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public final void registerEventListener(final DataProviderEventListener listener) {
eventListeners.add(listener);
diff --git a/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/core/DataProviderEvent.java b/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/core/DataProviderEvent.java
index 434d13d..8fa74f6 100644
--- a/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/core/DataProviderEvent.java
+++ b/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/core/DataProviderEvent.java
@@ -68,10 +68,10 @@
SUPPORTED_FEATURES;
}
- // A message describing this event.
+ /** A message describing this event. */
private final LocalizableMessage reason;
- // the types of event that have occurred in the data provider.
+ /** The types of event that have occurred in the data provider. */
private final Set<Type> types;
/**
diff --git a/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/core/DataProviderID.java b/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/core/DataProviderID.java
index ae6d661..d188a2e 100644
--- a/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/core/DataProviderID.java
+++ b/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/core/DataProviderID.java
@@ -63,26 +63,26 @@
return new DataProviderID(name, false /* user */);
}
- // Flag indicating whether or not this ID represents an internal
- // data provider.
+ /**
+ * Flag indicating whether or not this ID represents an internal
+ * data provider.
+ */
private final boolean isInternal;
- // The data provider name.
+ /** The data provider name. */
private final String name;
- // The normalized name.
+ /** The normalized name. */
private final String normalizedName;
- // Prevent direct instantiation.
+ /** Prevent direct instantiation. */
private DataProviderID(final String name, final boolean isInternal) {
this.name = name;
this.normalizedName = name.trim().toLowerCase(Locale.ENGLISH);
this.isInternal = isInternal;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compareTo(final DataProviderID o) {
if (isInternal != o.isInternal) {
@@ -93,9 +93,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean equals(final Object obj) {
if (this == obj) {
@@ -121,9 +119,7 @@
return name;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
return normalizedName.hashCode();
@@ -139,9 +135,7 @@
return isInternal;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
if (isInternal) {
diff --git a/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/core/DataProviderStatus.java b/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/core/DataProviderStatus.java
index fc2ae6e..5d69822 100644
--- a/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/core/DataProviderStatus.java
+++ b/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/core/DataProviderStatus.java
@@ -54,7 +54,7 @@
*/
WRITE_INTERNAL_ONLY("write-internal-only");
- // The human-readable name for this status.
+ /** The human-readable name for this status. */
private String name;
/**
diff --git a/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/setup/cli/SetupCli.java b/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/setup/cli/SetupCli.java
index 98e61dc..5144f43 100644
--- a/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/setup/cli/SetupCli.java
+++ b/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/setup/cli/SetupCli.java
@@ -116,11 +116,11 @@
private IntegerArgument connectTimeout;
private BooleanArgument acceptLicense;
- // Sub-commands
+ /** Sub-commands. */
private SubCommand createDirectoryServer;
private SubCommand createProxy;
- // Register the global arguments.
+ /** Register the global arguments. */
private BooleanArgument noPrompt;
private BooleanArgument quietMode;
private BooleanArgument verbose;
@@ -132,7 +132,7 @@
// Nothing to do.
}
- // To allow tests
+ /** To allow tests. */
SetupCli(PrintStream out, PrintStream err) {
super(out, err);
}
@@ -343,7 +343,7 @@
* execution of the checking.
*/
private void checkProvidedPorts(final Collection<LocalizableMessage> errorMessages) {
- /**
+ /*
* Check that the provided ports do not match.
*/
try {
diff --git a/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/setup/model/ReplicationConfiguration.java b/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/setup/model/ReplicationConfiguration.java
index e71955a..cba6f55 100644
--- a/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/setup/model/ReplicationConfiguration.java
+++ b/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/setup/model/ReplicationConfiguration.java
@@ -35,11 +35,11 @@
/** Default port number for the replication port. */
static final int DEFAULT_REPLICATION_PORT = 389;
- // First in topology
+ /** First in topology. */
private int replicationPort;
private boolean isSecure;
- // Part of topology
+ /** Part of topology. */
private String hostName;
private int hostPort;
private String administrator;
diff --git a/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/setup/model/RuntimeOptions.java b/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/setup/model/RuntimeOptions.java
index 0fbd88d..05224b0 100644
--- a/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/setup/model/RuntimeOptions.java
+++ b/opendj-sdk/opendj-server/src/main/java/org/forgerock/opendj/server/setup/model/RuntimeOptions.java
@@ -104,9 +104,7 @@
this.additionalArguments = additionalArguments;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override()
public boolean equals(Object o) {
if (o == this) {
@@ -129,9 +127,7 @@
return true;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override()
public int hashCode() {
int hashCode = 44 + initialMemory + maximumMemory;
@@ -141,9 +137,7 @@
return hashCode;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override()
public String toString() {
final StringBuilder sb = new StringBuilder();
diff --git a/opendj-sdk/opendj-server/src/test/java/org/forgerock/opendj/server/core/ProductInformationTest.java b/opendj-sdk/opendj-server/src/test/java/org/forgerock/opendj/server/core/ProductInformationTest.java
index a9c9472..08aa2ec 100644
--- a/opendj-sdk/opendj-server/src/test/java/org/forgerock/opendj/server/core/ProductInformationTest.java
+++ b/opendj-sdk/opendj-server/src/test/java/org/forgerock/opendj/server/core/ProductInformationTest.java
@@ -31,14 +31,14 @@
import org.forgerock.testng.ForgeRockTestCase;
import org.testng.annotations.Test;
+/**
+ * This test class verifies that the product information has been generated
+ * and can be loaded at runtime. It does not attempt to exhaustively check
+ * all methods.
+ */
@SuppressWarnings("javadoc")
@Test
public class ProductInformationTest extends ForgeRockTestCase {
- /*
- * This test class verifies that the product information has been generated
- * and can be loaded at runtime. It does not attempt to exhaustively check
- * all methods.
- */
@Test
public void testProductName() {
diff --git a/opendj-sdk/opendj-server/src/test/java/org/forgerock/opendj/server/setup/cli/SetupCliTestCase.java b/opendj-sdk/opendj-server/src/test/java/org/forgerock/opendj/server/setup/cli/SetupCliTestCase.java
index 9455abb..e82faf7 100644
--- a/opendj-sdk/opendj-server/src/test/java/org/forgerock/opendj/server/setup/cli/SetupCliTestCase.java
+++ b/opendj-sdk/opendj-server/src/test/java/org/forgerock/opendj/server/setup/cli/SetupCliTestCase.java
@@ -160,7 +160,7 @@
assertThat(resultCode).isEqualTo(ReturnCode.SUCCESS.get());
} else {
assertThat(resultCode).isNotEqualTo(ReturnCode.SUCCESS.get());
- /**
+ /*
* If an application is interactive, all messages should be redirect to the stdout. (info, warnings,
* errors). Otherwise, standard messages should be displayed in the stdout(info) and errors to the
* stderr (warnings, errors).
@@ -176,7 +176,7 @@
}
}
- /** Arguments passed to the command */
+ /** Arguments passed to the command. */
private String[] args(String... arguments) {
return arguments;
}
diff --git a/opendj-sdk/opendj-server2x-adapter/src/main/java/org/forgerock/opendj/adapter/server2x/Converters.java b/opendj-sdk/opendj-server2x-adapter/src/main/java/org/forgerock/opendj/adapter/server2x/Converters.java
index 00b8882..20e6a13 100644
--- a/opendj-sdk/opendj-server2x-adapter/src/main/java/org/forgerock/opendj/adapter/server2x/Converters.java
+++ b/opendj-sdk/opendj-server2x-adapter/src/main/java/org/forgerock/opendj/adapter/server2x/Converters.java
@@ -68,7 +68,7 @@
*/
public final class Converters {
- // Prevent instantiation.
+ /** Prevent instantiation. */
private Converters() {
throw new AssertionError();
}
--
Gitblit v1.10.0