NameAndOptionalUIDSyntaxChecker (org.apache.directory.api_api-all_sources-and-javadoc 2.1.1 API)

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

All Implemented Interfaces:

Serializable, SchemaObject
```
public final class NameAndOptionalUIDSyntaxChecker
extends SyntaxChecker
```
A SyntaxChecker which verifies that a value is a valid Name and Optional UID.
This element is a composition of two parts, a Dn and an optional UID :
```
 NameAndOptionalUID = distinguishedName [ SHARP BitString ]
 
```
Both part already have their syntax checkers, so we will just call them after having split the element in two ( if necessary)
We just check that the Dn is valid, we don't need to verify each of the Rdn syntax.
Author:

Apache Directory Project

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class NameAndOptionalUIDSyntaxChecker.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

static NameAndOptionalUIDSyntaxChecker INSTANCE
A static instance of NameAndOptionalUIDSyntaxChecker
- 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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static NameAndOptionalUIDSyntaxChecker.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
  - INSTANCE
```
public static final NameAndOptionalUIDSyntaxChecker INSTANCE
```
    A static instance of NameAndOptionalUIDSyntaxChecker
- Method Detail
  - builder
```
public static NameAndOptionalUIDSyntaxChecker.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