Autorefactored javadocs

Jean-Noel Rouvignac

24.11.2015 8d21db36015f8560d9cd2bcee9817f2c0a07a386

 opendj-server-legacy/src/main/java/org/opends/server/schema/MatchingRuleSyntax.java

@@ -22,14 +22,12 @@
 *
 *
 *      Copyright 2006-2009 Sun Microsystems, Inc.
 *      Portions Copyright 2011-2014 ForgeRock AS
 *      Portions Copyright 2011-2015 ForgeRock AS
 */
package org.opends.server.schema;
import org.forgerock.i18n.LocalizableMessage;




import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CopyOnWriteArrayList;

@@ -50,8 +48,6 @@
import static org.opends.server.schema.SchemaConstants.*;
import static org.opends.server.util.StaticUtils.*;



/**
 * This class implements the matching rule description syntax, which is used to
 * hold matching rule definitions in the server schema.  The format of this
@@ -62,19 +58,15 @@
{
  private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();



  // The default equality matching rule for this syntax.
  /** The default equality matching rule for this syntax. */
  private MatchingRule defaultEqualityMatchingRule;

  // The default ordering matching rule for this syntax.
  /** The default ordering matching rule for this syntax. */
  private MatchingRule defaultOrderingMatchingRule;

  // The default substring matching rule for this syntax.
  /** The default substring matching rule for this syntax. */
  private MatchingRule defaultSubstringMatchingRule;



  /**
   * Creates a new instance of this syntax.  Note that the only thing that
   * should be done here is to invoke the default constructor for the
@@ -86,11 +78,7 @@
    super();
  }



  /**
   * {@inheritDoc}
   */
  /** {@inheritDoc} */
  @Override
  public void initializeSyntax(AttributeSyntaxCfg configuration)
         throws ConfigException
@@ -117,8 +105,6 @@
    }
  }



  /**
   * Retrieves the common name for this attribute syntax.
   *
@@ -130,8 +116,6 @@
    return SYNTAX_MATCHING_RULE_NAME;
  }



  /**
   * Retrieves the OID for this attribute syntax.
   *
@@ -143,8 +127,6 @@
    return SYNTAX_MATCHING_RULE_OID;
  }



  /**
   * Retrieves a description for this attribute syntax.
   *
@@ -156,8 +138,6 @@
    return SYNTAX_MATCHING_RULE_DESCRIPTION;
  }



  /**
   * Retrieves the default equality matching rule that will be used for
   * attributes with this syntax.
@@ -172,8 +152,6 @@
    return defaultEqualityMatchingRule;
  }



  /**
   * Retrieves the default ordering matching rule that will be used for
   * attributes with this syntax.
@@ -188,8 +166,6 @@
    return defaultOrderingMatchingRule;
  }



  /**
   * Retrieves the default substring matching rule that will be used for
   * attributes with this syntax.
@@ -204,8 +180,6 @@
    return defaultSubstringMatchingRule;
  }



  /**
   * Retrieves the default approximate matching rule that will be used for
   * attributes with this syntax.
@@ -221,8 +195,6 @@
    return null;
  }



  /**
   * Indicates whether the provided value is acceptable for use in an attribute
   * with this syntax.  If it is not, then the reason may be appended to the
@@ -592,8 +564,6 @@
    return true;
  }



  /**
   * Reads the next token name from the matching rule definition, skipping over
   * any leading or trailing spaces, and appends it to the provided buffer.
@@ -648,8 +618,6 @@
    return startPos;
  }



  /**
   * Reads the value of a string enclosed in single quotes, skipping over the
   * quotes and any leading or trailing spaces, and appending the string to the
@@ -726,8 +694,6 @@
    return startPos;
  }



  /**
   * Reads the value of a string enclosed in single quotes, skipping over the
   * quotes and any leading or trailing spaces, and appending the string to the
@@ -811,8 +777,6 @@
    return startPos;
  }



  /**
   * Reads the attribute type/objectclass description or numeric OID from the
   * provided string, skipping over any leading or trailing spaces, and
@@ -959,8 +923,6 @@
    return startPos;
  }



  /**
   * Reads the value for an "extra" parameter.  It will handle a single unquoted
   * word (which is technically illegal, but we'll allow it), a single quoted
@@ -1115,22 +1077,14 @@
    return startPos;
  }



  /**
   * {@inheritDoc}
   */
  /** {@inheritDoc} */
  @Override
  public boolean isBEREncodingRequired()
  {
    return false;
  }



  /**
   * {@inheritDoc}
   */
  /** {@inheritDoc} */
  public boolean isHumanReadable()
  {
    return true;