org.apache.directory.api.ldap.model.schema.syntaxCheckers

Class FacsimileTelephoneNumberSyntaxChecker

java.lang.Object

org.apache.directory.api.ldap.model.schema.AbstractSchemaObject

org.apache.directory.api.ldap.model.schema.LoadableSchemaObject

org.apache.directory.api.ldap.model.schema.SyntaxChecker

org.apache.directory.api.ldap.model.schema.syntaxCheckers.FacsimileTelephoneNumberSyntaxChecker

All Implemented Interfaces:

Serializable, SchemaObject

public final class FacsimileTelephoneNumberSyntaxChecker
extends SyntaxChecker

A SyntaxChecker which verifies that a value is a facsimile TelephoneNumber according to ITU recommendation E.123 for the Telephone number part, and from RFC 4517, par. 3.3.11 :

 fax-number       = telephone-number *( DOLLAR fax-parameter )
 telephone-number = PrintableString
 fax-parameter    = "twoDimensional" |
                    "fineResolution" |
                    "unlimitedLength" |
                    "b4Length" |
                    "a3Width" |
                    "b4Width" |
                    "uncompressed"
 

If needed, and to allow more syntaxes, a list of regexps has been added which can be initialized to other values

Author:

Apache Directory Project

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FacsimileTelephoneNumberSyntaxChecker.Builder A static Builder for this class

Nested classes/interfaces inherited from class org.apache.directory.api.ldap.model.schema.SyntaxChecker

SyntaxChecker.SCBuilder<SC>

Field Summary

Fields

Modifier and Type	Field and Description
private static String	A3_LENGTH
private static String	B4_LENGTH
private static String	B4_WIDTH
private static String	DEFAULT_REGEXP The default pattern used to check a TelephoneNumber
private Pattern	defaultPattern The compiled default pattern
private String	defaultRegexp The compiled default pattern
private static Set<String>	faxParameters A set which contains all the possible fax parameters values
private static String	FINE_RESOLUTION
static FacsimileTelephoneNumberSyntaxChecker	INSTANCE A static instance of FacsimileTelephoneNumberSyntaxChecker
private static String	TWO_DIMENSIONAL Fax parameters possible values
private static String	UNCOMPRESSED
private static String	UNLIMITED_LENGTH

Fields inherited from class org.apache.directory.api.ldap.model.schema.SyntaxChecker

LOG, serialVersionUID

Fields inherited from class org.apache.directory.api.ldap.model.schema.AbstractSchemaObject

description, extensions, h, isEnabled, isObsolete, locked, names, objectType, oid, schemaName, specification

Constructor Summary

Constructors

Modifier	Constructor and Description
private	FacsimileTelephoneNumberSyntaxChecker(String oid) Creates a new instance of TelephoneNumberSyntaxChecker.
private	FacsimileTelephoneNumberSyntaxChecker(String oid, String defaultRegexp, Pattern defaultPattern) Creates a new instance of TelephoneNumberSyntaxChecker.

Method Summary

Modifier and Type	Method and Description
static FacsimileTelephoneNumberSyntaxChecker.Builder	builder()
String	getRegexp() Get the default regexp (either the original one, or the one that has been set)
boolean	isValidSyntax(Object value) Determines if the attribute's value conforms to the attribute syntax.

Methods inherited from class org.apache.directory.api.ldap.model.schema.SyntaxChecker

equals, setSchemaManager, toString

Methods inherited from class org.apache.directory.api.ldap.model.schema.LoadableSchemaObject

copy, getBytecode, getFqcn, hashCode, isValid, setBytecode, setFqcn

Methods inherited from class org.apache.directory.api.ldap.model.schema.AbstractSchemaObject

addExtension, addExtension, addName, clear, compareOid, computeHashCode, copy, getDescription, getExtension, getExtensions, getName, getNames, getObjectType, getOid, getSchemaName, getSpecification, hasExtension, isDisabled, isEnabled, isObsolete, lock, setDescription, setEnabled, setExtensions, setNames, setNames, setObsolete, setOid, setSchemaName, setSpecification, unlock

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_REGEXP

private static final String DEFAULT_REGEXP

The default pattern used to check a TelephoneNumber

See Also:

Constant Field Values

defaultRegexp

private String defaultRegexp

The compiled default pattern

defaultPattern

private Pattern defaultPattern

The compiled default pattern

TWO_DIMENSIONAL

private static final String TWO_DIMENSIONAL

Fax parameters possible values

See Also:

Constant Field Values

FINE_RESOLUTION

private static final String FINE_RESOLUTION

See Also:

Constant Field Values

UNLIMITED_LENGTH

private static final String UNLIMITED_LENGTH

See Also:

Constant Field Values

B4_LENGTH

private static final String B4_LENGTH

See Also:

Constant Field Values

A3_LENGTH

private static final String A3_LENGTH

See Also:

Constant Field Values

B4_WIDTH

private static final String B4_WIDTH

See Also:

Constant Field Values

UNCOMPRESSED

private static final String UNCOMPRESSED

See Also:

Constant Field Values

faxParameters

private static Set<String> faxParameters

A set which contains all the possible fax parameters values

INSTANCE

public static final FacsimileTelephoneNumberSyntaxChecker INSTANCE

A static instance of FacsimileTelephoneNumberSyntaxChecker

Constructor Detail

FacsimileTelephoneNumberSyntaxChecker

private FacsimileTelephoneNumberSyntaxChecker(String oid)

Creates a new instance of TelephoneNumberSyntaxChecker.

Parameters:

oid - the OID

FacsimileTelephoneNumberSyntaxChecker

private FacsimileTelephoneNumberSyntaxChecker(String oid,
                                              String defaultRegexp,
                                              Pattern defaultPattern)

Creates a new instance of TelephoneNumberSyntaxChecker.

Parameters:

oid - The OID

defaultRegexp - the default regexp to use

defaultPattern - The default pattern to use

Method Detail

builder

public static FacsimileTelephoneNumberSyntaxChecker.Builder builder()

Returns:

An instance of the Builder for this class

getRegexp

public String getRegexp()

Get the default regexp (either the original one, or the one that has been set)

Returns:

The default regexp

isValidSyntax

public boolean isValidSyntax(Object value)

Determines if the attribute's value conforms to the attribute syntax.

Overrides:

isValidSyntax in class SyntaxChecker

Parameters:

value - the value of some attribute with the syntax

Returns:

true if the value is in the valid syntax, false otherwise