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-config/src/main/java/org/forgerock/opendj/config/IntegerPropertyDefinition.java | 59 +++++++++++++++++++++++------------------------------------
1 files changed, 23 insertions(+), 36 deletions(-)
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);
--
Gitblit v1.10.0