001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2006-2008 Sun Microsystems, Inc.
025 *      Portions Copyright 2012-2015 ForgeRock AS
026 */
027package org.opends.server.schema;
028
029import static org.opends.server.schema.SchemaConstants.*;
030
031import org.forgerock.opendj.ldap.schema.Schema;
032import org.forgerock.opendj.ldap.schema.Syntax;
033import org.opends.server.admin.std.server.AttributeSyntaxCfg;
034import org.opends.server.api.AttributeSyntax;
035
036/**
037 * This class implements the IA5 string attribute syntax, which is simply a
038 * set of ASCII characters.  By default, they will be treated in a
039 * case-insensitive manner, and equality, ordering, substring, and approximate
040 * matching will be allowed.
041 */
042public class IA5StringSyntax
043       extends AttributeSyntax<AttributeSyntaxCfg>
044{
045
046  /**
047   * Creates a new instance of this syntax.  Note that the only thing that
048   * should be done here is to invoke the default constructor for the
049   * superclass.  All initialization should be performed in the
050   * <CODE>initializeSyntax</CODE> method.
051   */
052  public IA5StringSyntax()
053  {
054    super();
055  }
056
057  /** {@inheritDoc} */
058  @Override
059  public Syntax getSDKSyntax(Schema schema)
060  {
061    return schema.getSyntax(SchemaConstants.SYNTAX_IA5_STRING_OID);
062  }
063
064  /**
065   * Retrieves the common name for this attribute syntax.
066   *
067   * @return  The common name for this attribute syntax.
068   */
069  @Override
070  public String getName()
071  {
072    return SYNTAX_IA5_STRING_NAME;
073  }
074
075  /**
076   * Retrieves the OID for this attribute syntax.
077   *
078   * @return  The OID for this attribute syntax.
079   */
080  @Override
081  public String getOID()
082  {
083    return SYNTAX_IA5_STRING_OID;
084  }
085
086  /**
087   * Retrieves a description for this attribute syntax.
088   *
089   * @return  A description for this attribute syntax.
090   */
091  @Override
092  public String getDescription()
093  {
094    return SYNTAX_IA5_STRING_DESCRIPTION;
095  }
096}
097