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

Class CountrySyntaxChecker

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

All Implemented Interfaces:

Serializable, SchemaObject

public final class CountrySyntaxChecker
extends SyntaxChecker

A SyntaxChecker which verifies that a value is a country according to RFC 4517. From RFC 4517 :

 A value of the Country String syntax is one of the two-character
 codes from ISO 3166 [ISO3166] for representing a country.
 

Author:

Apache Directory Project

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CountrySyntaxChecker.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 Set<String>	COUNTRIES The Set which contains the countries
private static String[]	COUNTRY_ISO_3166 The ISO 3166 list of countries, as of 2006
static CountrySyntaxChecker	INSTANCE A static instance of CountrySyntaxChecker

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	CountrySyntaxChecker(String oid) Creates a new instance of CountrySyntaxChecker.

Method Summary

Modifier and Type	Method and Description
static CountrySyntaxChecker.Builder	builder()
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

COUNTRY_ISO_3166

private static final String[] COUNTRY_ISO_3166

The ISO 3166 list of countries, as of 2006

COUNTRIES

private static final Set<String> COUNTRIES

The Set which contains the countries

INSTANCE

public static final CountrySyntaxChecker INSTANCE

A static instance of CountrySyntaxChecker

Constructor Detail

CountrySyntaxChecker

private CountrySyntaxChecker(String oid)

Creates a new instance of CountrySyntaxChecker.

Parameters:

oid - The OID to use for this SyntaxChecker

Method Detail

builder

public static CountrySyntaxChecker.Builder builder()

Returns:

An instance of the Builder for this class

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