Autorefactored javadocs

Jean-Noel Rouvignac

24.11.2015 8d21db36015f8560d9cd2bcee9817f2c0a07a386

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

@@ -22,12 +22,10 @@
 *
 *
 *      Copyright 2006-2008 Sun Microsystems, Inc.
 *      Portions Copyright 2012-2014 ForgeRock AS
 *      Portions Copyright 2012-2015 ForgeRock AS
 */
package org.opends.server.schema;



import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;
@@ -49,8 +47,6 @@
import static org.opends.server.schema.SchemaConstants.*;
import static org.opends.server.util.ServerConstants.*;



/**
 * This class implements the UTC time attribute syntax.  This is very similar to
 * the generalized time syntax (and actually has been deprecated in favor of
@@ -64,16 +60,12 @@
{
  private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();



  /**
   * The lock that will be used to provide threadsafe access to the date
   * formatter.
   */
  private static Object dateFormatLock;



  /**
   * The date formatter that will be used to convert dates into UTC time values.
   * Note that all interaction with it must be synchronized.
@@ -87,18 +79,16 @@
  private static Date datum2000;


  // 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;



  /*
  /**
   * Create the date formatter that will be used to construct and parse
   * normalized UTC time values.
   */
@@ -120,8 +110,6 @@
    dateFormatLock = new Object();
  }



  /**
   * 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
@@ -133,11 +121,7 @@
    super();
  }



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



  /**
   * Retrieves the common name for this attribute syntax.
   *
@@ -175,8 +157,6 @@
    return SYNTAX_UTC_TIME_NAME;
  }



  /**
   * Retrieves the OID for this attribute syntax.
   *
@@ -187,8 +167,6 @@
    return SYNTAX_UTC_TIME_OID;
  }



  /**
   * Retrieves a description for this attribute syntax.
   *
@@ -199,8 +177,6 @@
    return SYNTAX_UTC_TIME_DESCRIPTION;
  }



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



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



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



  /**
   * Retrieves the default approximate matching rule that will be used for
   * attributes with this syntax.
@@ -260,8 +230,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
@@ -691,8 +659,6 @@
    }
  }



  /**
   * Indicates whether the provided string contains a valid set of two or four
   * UTC offset digits.  The provided string must have either two or four
@@ -819,8 +785,6 @@
    return true;
  }



  /**
   * Retrieves an attribute value containing a UTC time representation of the
   * provided date.
@@ -839,8 +803,6 @@
    return ByteString.valueOf(valueString);
  }



  /**
   * Decodes the provided normalized value as a UTC time value and
   * retrieves a Java <CODE>Date</CODE> object containing its representation.
@@ -897,21 +859,13 @@
    }
  }



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



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