org.apache.directory.shared.ldap.schema
Class SyntaxChecker

java.lang.Object
  extended by org.apache.directory.shared.ldap.schema.AbstractSchemaObject
      extended by org.apache.directory.shared.ldap.schema.LoadableSchemaObject
          extended by org.apache.directory.shared.ldap.schema.SyntaxChecker
All Implemented Interfaces:
java.io.Serializable, SchemaObject
Direct Known Subclasses:
AccessPointSyntaxChecker, ACIItemSyntaxChecker, AttributeTypeDescriptionSyntaxChecker, AttributeTypeUsageSyntaxChecker, BinarySyntaxChecker, BitStringSyntaxChecker, BooleanSyntaxChecker, CountrySyntaxChecker, CsnSidSyntaxChecker, CsnSyntaxChecker, DataQualitySyntaxSyntaxChecker, DeliveryMethodSyntaxChecker, DirectoryStringSyntaxChecker, DITContentRuleDescriptionSyntaxChecker, DITStructureRuleDescriptionSyntaxChecker, DLSubmitPermissionSyntaxChecker, DNSyntaxChecker, DSAQualitySyntaxSyntaxChecker, DSETypeSyntaxChecker, GeneralizedTimeSyntaxChecker, Ia5StringSyntaxChecker, IntegerSyntaxChecker, JavaByteSyntaxChecker, JavaIntegerSyntaxChecker, JavaLongSyntaxChecker, JavaShortSyntaxChecker, JpegSyntaxChecker, LdapSyntaxDescriptionSyntaxChecker, MailPreferenceSyntaxChecker, MasterAndShadowAccessPointSyntaxChecker, MatchingRuleDescriptionSyntaxChecker, MatchingRuleUseDescriptionSyntaxChecker, MHSORAddressSyntaxChecker, NameAndOptionalUIDSyntaxChecker, NameFormDescriptionSyntaxChecker, NumberSyntaxChecker, NumericOidSyntaxChecker, NumericStringSyntaxChecker, ObjectClassDescriptionSyntaxChecker, ObjectClassTypeSyntaxChecker, ObjectNameSyntaxChecker, OctetStringSyntaxChecker, OidLenSyntaxChecker, OidSyntaxChecker, OtherMailboxSyntaxChecker, PostalAddressSyntaxChecker, PrintableStringSyntaxChecker, ProtocolInformationSyntaxChecker, RegexSyntaxChecker, SubtreeSpecificationSyntaxChecker, SupplierAndConsumerSyntaxChecker, SupplierInformationSyntaxChecker, SupplierOrConsumerSyntaxChecker, TelephoneNumberSyntaxChecker, TeletexTerminalIdentifierSyntaxChecker, TelexNumberSyntaxChecker, UtcTimeSyntaxChecker, UuidSyntaxChecker

public abstract class SyntaxChecker
extends LoadableSchemaObject

Used to validate values of a particular syntax. This interface does not correlate to any LDAP or X.500 construct. It has been created as a means to enforce a syntax within the Eve server.

Version:
$Rev: 923524 $, $Date: 2010-03-16 01:31:36 +0100 (Tue, 16 Mar 2010) $
Author:
Apache Directory Project
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.apache.directory.shared.ldap.schema.AbstractSchemaObject
description, extensions, isEnabled, isObsolete, isReadOnly, locked, names, objectType, oid, schemaName, specification
 
Constructor Summary
protected SyntaxChecker()
          The SyntaxChecker default constructor where the oid is set after instantiation.
protected SyntaxChecker(java.lang.String oid)
          The SyntaxChecker base constructor
 
Method Summary
 void assertSyntax(java.lang.Object value)
          Asserts whether or not the attribute's value conforms to the attribute syntax.
 boolean equals(java.lang.Object o)
           
abstract  boolean isValidSyntax(java.lang.Object value)
          Determines if the attribute's value conforms to the attribute syntax.
 java.lang.String toString()
           
 
Methods inherited from class org.apache.directory.shared.ldap.schema.LoadableSchemaObject
copy, getBytecode, getFqcn, isValid, registerOid, setBytecode, setFqcn
 
Methods inherited from class org.apache.directory.shared.ldap.schema.AbstractSchemaObject
addExtension, addName, addToRegistries, clear, compareOid, copy, getDescription, getExtensions, getName, getNames, getObjectType, getOid, getSchemaName, getSpecification, hashCode, isDisabled, isEnabled, isObsolete, isReadOnly, lock, removeFromRegistries, setDescription, setEnabled, setExtensions, setNames, setNames, setObsolete, setOid, setReadOnly, setRegistries, setSchemaName, setSpecification
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SyntaxChecker

protected SyntaxChecker(java.lang.String oid)
The SyntaxChecker base constructor

Parameters:
oid - The associated OID

SyntaxChecker

protected SyntaxChecker()
The SyntaxChecker default constructor where the oid is set after instantiation.

Method Detail

isValidSyntax

public abstract boolean isValidSyntax(java.lang.Object value)
Determines if the attribute's value conforms to the attribute syntax.

Parameters:
value - the value of some attribute with the syntax
Returns:
true if the value is in the valid syntax, false otherwise

assertSyntax

public void assertSyntax(java.lang.Object value)
                  throws LdapException
Asserts whether or not the attribute's value conforms to the attribute syntax.

Parameters:
value - the value of some attribute with the syntax
Throws:
LdapException - if the value does not conform to the attribute syntax.

equals

public boolean equals(java.lang.Object o)
Specified by:
equals in interface SchemaObject
Overrides:
equals in class LoadableSchemaObject
See Also:
Object#equals()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
See Also:
Object.toString()


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.