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 a Fax according to RFC 4517.
029 * <p>
030 * We didn't implemented the check against RFC 804, so the value is considered
031 * to contain an OctetString.
032 *  
033 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
034 */
035@SuppressWarnings("serial")
036public final class FaxSyntaxChecker extends SyntaxChecker
037{
038    /**
039     * A static instance of FaxSyntaxChecker
040     */
041    public static final FaxSyntaxChecker INSTANCE = new FaxSyntaxChecker( SchemaConstants.FAX_SYNTAX );
042    
043    /**
044     * A static Builder for this class
045     */
046    public static final class Builder extends SCBuilder<FaxSyntaxChecker>
047    {
048        /**
049         * The Builder constructor
050         */
051        private Builder()
052        {
053            super( SchemaConstants.FAX_SYNTAX );
054        }
055        
056        
057        /**
058         * Create a new instance of FaxSyntaxChecker
059         * @return A new instance of FaxSyntaxChecker
060         */
061        @Override
062        public FaxSyntaxChecker build()
063        {
064            return new FaxSyntaxChecker( oid );
065        }
066    }
067
068    
069    /**
070     * Private default constructor to prevent unnecessary instantiation.
071     * 
072     * @param oid The OID to use for this SyntaxChecker
073     */
074    private FaxSyntaxChecker( String oid )
075    {
076        super( oid );
077    }
078
079    
080    /**
081     * @return An instance of the Builder for this class
082     */
083    public static Builder builder()
084    {
085        return new Builder();
086    }
087}