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 *    http://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.syntaxCheckers;
021
022
023import org.apache.directory.api.ldap.model.constants.SchemaConstants;
024import org.apache.directory.api.ldap.model.schema.SyntaxChecker;
025
026
027/**
028 * A SyntaxChecker which verifies that a value is an EnhancedGuide according to 
029 * RFC 4517.
030 *
031 * Implemented as binary right now...
032 *  
033 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
034 */
035@SuppressWarnings("serial")
036public final class EnhancedGuideSyntaxChecker extends SyntaxChecker
037{
038    /**
039     * A static instance of EnhancedGuideSyntaxChecker
040     */
041    public static final EnhancedGuideSyntaxChecker INSTANCE = 
042        new EnhancedGuideSyntaxChecker( SchemaConstants.ENHANCED_GUIDE_SYNTAX );
043    
044    /**
045     * A static Builder for this class
046     */
047    public static final class Builder extends SCBuilder<EnhancedGuideSyntaxChecker>
048    {
049        /**
050         * The Builder constructor
051         */
052        private Builder()
053        {
054            super( SchemaConstants.DIRECTORY_STRING_SYNTAX );
055        }
056        
057        
058        /**
059         * Create a new instance of EnhancedGuideSyntaxChecker
060         * @return A new instance of EnhancedGuideSyntaxChecker
061         */
062        @Override
063        public EnhancedGuideSyntaxChecker build()
064        {
065            return new EnhancedGuideSyntaxChecker( oid );
066        }
067    }
068
069    
070    /**
071     * Creates a new instance of EnhancedGuideSyntaxChecker.
072     * 
073     * @param oid The OID to use for this SyntaxChecker
074     */
075    private EnhancedGuideSyntaxChecker( String oid )
076    {
077        super( oid );
078    }
079
080    
081    /**
082     * @return An instance of the Builder for this class
083     */
084    public static Builder builder()
085    {
086        return new Builder();
087    }
088}