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/**
038 * This class implements the printable string attribute syntax, which is simply
039 * a string of characters from a limited ASCII character set (uppercase and
040 * lowercase letters, numeric digits, the space, and a set of various symbols).
041 * By default, they will be treated in a case-insensitive manner, and equality,
042 * ordering, substring, and approximate matching will be allowed.
043 */
044public class PrintableStringSyntax
045       extends AttributeSyntax<AttributeSyntaxCfg>
046{
047
048  /**
049   * Creates a new instance of this syntax.  Note that the only thing that
050   * should be done here is to invoke the default constructor for the
051   * superclass.  All initialization should be performed in the
052   * <CODE>initializeSyntax</CODE> method.
053   */
054  public PrintableStringSyntax()
055  {
056    super();
057  }
058
059  /** {@inheritDoc} */
060  @Override
061  public Syntax getSDKSyntax(Schema schema)
062  {
063    return schema.getSyntax(SchemaConstants.SYNTAX_PRINTABLE_STRING_OID);
064  }
065
066  /**
067   * Retrieves the common name for this attribute syntax.
068   *
069   * @return  The common name for this attribute syntax.
070   */
071  @Override
072  public String getName()
073  {
074    return SYNTAX_PRINTABLE_STRING_NAME;
075  }
076
077  /**
078   * Retrieves the OID for this attribute syntax.
079   *
080   * @return  The OID for this attribute syntax.
081   */
082  @Override
083  public String getOID()
084  {
085    return SYNTAX_PRINTABLE_STRING_OID;
086  }
087
088  /**
089   * Retrieves a description for this attribute syntax.
090   *
091   * @return  A description for this attribute syntax.
092   */
093  @Override
094  public String getDescription()
095  {
096    return SYNTAX_PRINTABLE_STRING_DESCRIPTION;
097  }
098}
099