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

Class TelephoneNumberSyntaxChecker

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.TelephoneNumberSyntaxChecker

All Implemented Interfaces:

Serializable, SchemaObject

public final class TelephoneNumberSyntaxChecker
extends SyntaxChecker

A SyntaxChecker which verifies that a value is a TelephoneNumber according to ITU recommendation E.123 (which is quite vague ...).

A valid Telephone number respects more or less this syntax :

 " *[+]? *((\([0-9- ,;/#*]+\))|[0-9- ,;/#*]+)+"
 

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	Description
static class	TelephoneNumberSyntaxChecker.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	Description
private static String	DEFAULT_REGEXP	The default pattern used to check a TelephoneNumber
private Pattern	defaultPattern	The compiled default pattern
private String	defaultRegexp	The default pattern
static TelephoneNumberSyntaxChecker	INSTANCE	A static instance of TelephoneNumberSyntaxChecker

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	Description
private	TelephoneNumberSyntaxChecker(String oid)	Creates a new instance of a child of this class, with an OID.
private	TelephoneNumberSyntaxChecker(String oid, String defaultRegexp, Pattern defaultPattern)	Creates a new instance of a child of this class, with an OID.

Method Summary

Modifier and Type	Method	Description
static TelephoneNumberSyntaxChecker.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 final String defaultRegexp

The default pattern

defaultPattern

private final Pattern defaultPattern

The compiled default pattern

INSTANCE

public static final TelephoneNumberSyntaxChecker INSTANCE

A static instance of TelephoneNumberSyntaxChecker

Constructor Detail

TelephoneNumberSyntaxChecker

private TelephoneNumberSyntaxChecker(String oid)

Creates a new instance of a child of this class, with an OID.

Parameters:

oid - the child's OID

TelephoneNumberSyntaxChecker

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

Creates a new instance of a child of this class, with an OID.

Parameters:

oid - the child's OID

defaultRegexp - The regexp to use

defaultPattern - The compiled version of the regexp

Method Detail

builder

public static TelephoneNumberSyntaxChecker.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