001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *  
010 *    https://www.apache.org/licenses/LICENSE-2.0
011 *  
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License. 
018 *  
019 */
020package org.apache.directory.api.ldap.model.schema;
021
022
023import org.apache.directory.api.ldap.model.exception.LdapException;
024
025
026/**
027 * An interface that is implemented by Normalizers calling the PrepareString class.
028 * 
029 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
030 */
031public interface PreparedNormalizer
032{
033    /**
034     * Gets the normalized value.
035     * 
036     * @param value the value to normalize. It must *not* be null !
037     * @param assertionType The type of String we have to normalize
038     * @return the normalized form for a value
039     * @throws LdapException if an error results during normalization
040     */
041    String normalize( String value, PrepareString.AssertionType assertionType ) throws LdapException;
042}