SearchScopeSyntaxChecker (Apache LDAP API 2.1.1 API Documentation)

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

All Implemented Interfaces:

Serializable, SchemaObject
```
public final class SearchScopeSyntaxChecker
extends SyntaxChecker
```
A SyntaxChecker which verifies that a value is a valid Search Scope. We have three possible values :
- OBJECT
- ONE
- SUBTREE
The value is case insensitive
Author:

Apache Directory Project

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SearchScopeSyntaxChecker.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 SearchScopeSyntaxChecker INSTANCE
A static instance of SearchScopeSyntaxChecker
- Fields inherited from class org.apache.directory.api.ldap.model.schema.SyntaxChecker
  serialVersionUID

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SearchScopeSyntaxChecker.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, 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
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - INSTANCE
```
public static final SearchScopeSyntaxChecker INSTANCE
```
    A static instance of SearchScopeSyntaxChecker
- Method Detail
  - builder
```
public static SearchScopeSyntaxChecker.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