From e7cac727a9231ff3602e61a4ea678e0463eb0e39 Mon Sep 17 00:00:00 2001
From: Jean-Noel Rouvignac <jean-noel.rouvignac@forgerock.com>
Date: Tue, 24 Mar 2015 09:41:42 +0000
Subject: [PATCH] Autorefactored javadocs
---
opendj-server-legacy/src/main/java/org/opends/server/admin/ManagedObjectPath.java | 144 +++++++++++++++++------------------------------
1 files changed, 53 insertions(+), 91 deletions(-)
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/admin/ManagedObjectPath.java b/opendj-server-legacy/src/main/java/org/opends/server/admin/ManagedObjectPath.java
index 46ddeb5..4b1dc9b 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/admin/ManagedObjectPath.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/admin/ManagedObjectPath.java
@@ -124,15 +124,15 @@
private static final class DNSerializer implements
ManagedObjectPathSerializer {
- // The current DN.
+ /** The current DN. */
private DN dn;
- // The LDAP profile.
+ /** The LDAP profile. */
private final LDAPProfile profile;
- // Create a new DN builder.
+ /** Create a new DN builder. */
private DNSerializer() {
this.dn = DN.rootDN();
this.profile = LDAPProfile.getInstance();
@@ -140,9 +140,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration>
void appendManagedObjectPathElement(
InstantiableRelationDefinition<? super C, ? super S> r,
@@ -160,9 +158,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration>
void appendManagedObjectPathElement(
SetRelationDefinition<? super C, ? super S> r,
@@ -180,9 +176,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration>
void appendManagedObjectPathElement(
OptionalRelationDefinition<? super C, ? super S> r,
@@ -193,9 +187,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <C extends ConfigurationClient, S extends Configuration>
void appendManagedObjectPathElement(
SingletonRelationDefinition<? super C, ? super S> r,
@@ -206,7 +198,7 @@
- // Appends the RDN sequence representing the provided relation.
+ /** Appends the RDN sequence representing the provided relation. */
private void appendManagedObjectPathElement(RelationDefinition<?, ?> r) {
// Add the RDN sequence representing the relation.
try {
@@ -219,7 +211,7 @@
- // Gets the serialized DN value.
+ /** Gets the serialized DN value. */
private DN toDN() {
return dn;
}
@@ -233,7 +225,7 @@
private static abstract class Element<C extends ConfigurationClient,
S extends Configuration> {
- // The type of managed object referenced by this element.
+ /** The type of managed object referenced by this element. */
private final AbstractManagedObjectDefinition<C, S> definition;
@@ -305,7 +297,7 @@
<C extends ConfigurationClient, S extends Configuration>
extends Element<C, S> {
- // Factory method.
+ /** Factory method. */
private static <C extends ConfigurationClient,
S extends Configuration>
InstantiableElement<C, S> create(
@@ -314,15 +306,15 @@
return new InstantiableElement<C, S>(r, d, name);
}
- // The name of the managed object.
+ /** The name of the managed object. */
private final String name;
- // The instantiable relation.
+ /** The instantiable relation. */
private final InstantiableRelationDefinition<? super C, ? super S> r;
- // Private constructor.
+ /** Private constructor. */
private InstantiableElement(
InstantiableRelationDefinition<? super C, ? super S> r,
AbstractManagedObjectDefinition<C, S> d, String name) {
@@ -333,9 +325,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String getName() {
return name;
@@ -343,9 +333,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public InstantiableRelationDefinition<? super C, ? super S>
getRelationDefinition() {
@@ -354,9 +342,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void serialize(ManagedObjectPathSerializer serializer) {
serializer.appendManagedObjectPathElement(r,
@@ -373,7 +359,7 @@
<C extends ConfigurationClient, S extends Configuration>
extends Element<C, S> {
- // Factory method.
+ /** Factory method. */
private static <C extends ConfigurationClient,
S extends Configuration> OptionalElement<C, S> create(
OptionalRelationDefinition<? super C, ? super S> r,
@@ -381,12 +367,12 @@
return new OptionalElement<C, S>(r, d);
}
- // The optional relation.
+ /** The optional relation. */
private final OptionalRelationDefinition<? super C, ? super S> r;
- // Private constructor.
+ /** Private constructor. */
private OptionalElement(OptionalRelationDefinition<? super C, ? super S> r,
AbstractManagedObjectDefinition<C, S> d) {
super(d);
@@ -395,9 +381,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public OptionalRelationDefinition<? super C, ? super S>
getRelationDefinition() {
@@ -406,9 +390,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void serialize(ManagedObjectPathSerializer serializer) {
serializer
@@ -425,7 +407,7 @@
<C extends ConfigurationClient, S extends Configuration>
extends Element<C, S> {
- // Factory method.
+ /** Factory method. */
private static <C extends ConfigurationClient,
S extends Configuration>
SetElement<C, S> create(
@@ -434,12 +416,12 @@
return new SetElement<C, S>(r, d);
}
- // The set relation.
+ /** The set relation. */
private final SetRelationDefinition<? super C, ? super S> r;
- // Private constructor.
+ /** Private constructor. */
private SetElement(
SetRelationDefinition<? super C, ? super S> r,
AbstractManagedObjectDefinition<C, S> d) {
@@ -449,9 +431,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public SetRelationDefinition<? super C, ? super S>
getRelationDefinition() {
@@ -460,9 +440,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void serialize(ManagedObjectPathSerializer serializer) {
serializer.appendManagedObjectPathElement(r,
@@ -479,7 +457,7 @@
<C extends ConfigurationClient, S extends Configuration>
extends Element<C, S> {
- // Factory method.
+ /** Factory method. */
private static <C extends ConfigurationClient,
S extends Configuration> SingletonElement<C, S> create(
SingletonRelationDefinition<? super C, ? super S> r,
@@ -487,12 +465,12 @@
return new SingletonElement<C, S>(r, d);
}
- // The singleton relation.
+ /** The singleton relation. */
private final SingletonRelationDefinition<? super C, ? super S> r;
- // Private constructor.
+ /** Private constructor. */
private SingletonElement(
SingletonRelationDefinition<? super C, ? super S> r,
AbstractManagedObjectDefinition<C, S> d) {
@@ -502,9 +480,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public SingletonRelationDefinition<? super C, ? super S>
getRelationDefinition() {
@@ -513,9 +489,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void serialize(ManagedObjectPathSerializer serializer) {
serializer
@@ -532,21 +506,19 @@
private static final class StringSerializer implements
ManagedObjectPathSerializer {
- // Serialize to this string builder.
+ /** Serialize to this string builder. */
private final StringBuilder builder;
- // Private constructor.
+ /** Private constructor. */
private StringSerializer(StringBuilder builder) {
this.builder = builder;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <M extends ConfigurationClient, N extends Configuration>
void appendManagedObjectPathElement(
InstantiableRelationDefinition<? super M, ? super N> r,
@@ -560,9 +532,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <M extends ConfigurationClient, N extends Configuration>
void appendManagedObjectPathElement(
OptionalRelationDefinition<? super M, ? super N> r,
@@ -572,9 +542,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <M extends ConfigurationClient, N extends Configuration>
void appendManagedObjectPathElement(
SingletonRelationDefinition<? super M, ? super N> r,
@@ -584,9 +552,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public <M extends ConfigurationClient, N extends Configuration>
void appendManagedObjectPathElement(
SetRelationDefinition<? super M, ? super N> r,
@@ -596,7 +562,7 @@
- // Common element serialization.
+ /** Common element serialization. */
private <M, N> void serializeElement(RelationDefinition<?, ?> r,
AbstractManagedObjectDefinition<?, ?> d) {
// Always specify the relation name.
@@ -612,12 +578,12 @@
}
}
- // Single instance of a root path.
+ /** Single instance of a root path. */
private static final ManagedObjectPath<RootCfgClient, RootCfg> EMPTY_PATH =
new ManagedObjectPath<RootCfgClient, RootCfg>(
new LinkedList<Element<?, ?>>(), null, RootCfgDefn.getInstance());
- // A regular expression used to parse path elements.
+ /** A regular expression used to parse path elements. */
private static final Pattern PE_REGEXP = Pattern
.compile("^\\s*relation=\\s*([^+]+)\\s*"
+ "(\\+\\s*type=\\s*([^+]+)\\s*)?"
@@ -740,8 +706,10 @@
- // Factory method required in order to allow generic wild-card
- // construction of new paths.
+ /**
+ * Factory method required in order to allow generic wild-card
+ * construction of new paths.
+ */
private static <C extends ConfigurationClient, S extends Configuration>
ManagedObjectPath<C, S> create(
LinkedList<Element<?, ?>> elements, Element<C, S> lastElement) {
@@ -751,7 +719,7 @@
- // Decode an element.
+ /** Decode an element. */
private static <C extends ConfigurationClient, S extends Configuration>
Element<? extends C, ? extends S> createElement(
RelationDefinition<C, S> r, String path, String element, String type,
@@ -825,18 +793,18 @@
}
}
- // The managed object definition in this path.
+ /** The managed object definition in this path. */
private final AbstractManagedObjectDefinition<C, S> d;
- // The list of path elements in this path.
+ /** The list of path elements in this path. */
private final List<Element<?, ?>> elements;
- // The last relation definition in this path.
+ /** The last relation definition in this path. */
private final RelationDefinition<? super C, ? super S> r;
- // Private constructor.
+ /** Private constructor. */
private ManagedObjectPath(LinkedList<Element<?, ?>> elements,
RelationDefinition<? super C, ? super S> r,
AbstractManagedObjectDefinition<C, S> d) {
@@ -1158,9 +1126,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean equals(Object obj) {
if (obj == this) {
@@ -1228,9 +1194,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
return toString().hashCode();
@@ -1407,9 +1371,7 @@
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
StringBuilder builder = new StringBuilder();
--
Gitblit v1.10.0