/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
 * add the following below this CDDL HEADER, with the fields enclosed
 * by brackets "[]" replaced with your own identifying information:
 *      Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 *
 *
 *      Copyright 2009 Sun Microsystems, Inc.
 */
package org.opends.sdk.schema;



import static com.sun.opends.sdk.messages.Messages.WARN_ATTR_SYNTAX_LDAPSYNTAX_ENUM_INVALID_VALUE;

import org.opends.sdk.ByteSequence;
import org.opends.sdk.ByteString;
import org.opends.sdk.DecodeException;

import com.sun.opends.sdk.util.Validator;



/**
 * This class is the ordering matching rule implementation for an enum syntax
 * implmentation. The ordering is determined by the order of the entries in the
 * X-ENUM extension value.
 */
final class EnumOrderingMatchingRule extends AbstractOrderingMatchingRuleImpl
{
  private final EnumSyntaxImpl syntax;



  EnumOrderingMatchingRule(final EnumSyntaxImpl syntax)
  {
    Validator.ensureNotNull(syntax);
    this.syntax = syntax;
  }



  public ByteString normalizeAttributeValue(final Schema schema,
      final ByteSequence value) throws DecodeException
  {
    final int index = syntax.indexOf(value);
    if (index < 0)
    {
      throw DecodeException
          .error(WARN_ATTR_SYNTAX_LDAPSYNTAX_ENUM_INVALID_VALUE.get(value
              .toString(), syntax.getName()));
    }
    return ByteString.valueOf(index);
  }

}