Skip navigation links

oracle.oud.types
Interface FilterVisitor<R,P>

Type Parameters:

R - The return type of this visitor's methods. Use Void for visitors that do not need to return results.

P - The type of the additional parameter to this visitor's methods. Use Void for visitors that do not need an additional parameter.

public interface FilterVisitor<R,P>

A visitor of Filters, in the style of the visitor design pattern.

Classes implementing this interface can query filters in a type-safe manner. When a visitor is passed to a filter's accept method, the corresponding visit method most applicable to that filter is invoked.

Method Summary

R	visitAndFilter(P p, java.util.List<Filter> subFilters) Visits an and filter.
R	visitApproxMatchFilter(P p, java.lang.String attributeDescription, ByteString assertionValue) Visits an approximate match filter.
R	visitEqualityMatchFilter(P p, java.lang.String attributeDescription, ByteString assertionValue) Visits an equality match filter.
R	visitExtensibleMatchFilter(P p, java.lang.String matchingRule, java.lang.String attributeDescription, ByteString assertionValue, boolean dnAttributes) Visits an extensible filter.
R	visitGreaterOrEqualFilter(P p, java.lang.String attributeDescription, ByteString assertionValue) Visits a greater or equal filter.
R	visitLessOrEqualFilter(P p, java.lang.String attributeDescription, ByteString assertionValue) Visits a less or equal filter.
R	visitNotFilter(P p, Filter subFilter) Visits a not filter.
R	visitOrFilter(P p, java.util.List<Filter> subFilters) Visits an or filter.
R	visitPresentFilter(P p, java.lang.String attributeDescription) Visits a present filter.
R	visitSubstringsFilter(P p, java.lang.String attributeDescription, ByteString initialSubstring, java.util.List<ByteString> anySubstrings, ByteString finalSubstring) Visits a substrings filter.
R	visitUnrecognizedFilter(P p, byte filterTag, ByteString filterBytes) Visits an unrecognized filter.

Method Detail

visitAndFilter

R visitAndFilter(P p,
                 java.util.List<Filter> subFilters)

Visits an and filter.

Implementation note: for the purposes of matching an empty sub-filter list should always evaluate to true as per RFC 4526.

Parameters:

p - A visitor specified parameter.

subFilters - The unmodifiable list of sub-filters.

Returns:

Returns a visitor specified result.

visitApproxMatchFilter

R visitApproxMatchFilter(P p,
                         java.lang.String attributeDescription,
                         ByteString assertionValue)

Visits an approximate match filter.

Parameters:

p - A visitor specified parameter.

attributeDescription - The attribute description.

assertionValue - The assertion value.

Returns:

Returns a visitor specified result.

visitEqualityMatchFilter

R visitEqualityMatchFilter(P p,
                           java.lang.String attributeDescription,
                           ByteString assertionValue)

Visits an equality match filter.

Parameters:

p - A visitor specified parameter.

attributeDescription - The attribute description.

assertionValue - The assertion value.

Returns:

Returns a visitor specified result.

visitExtensibleMatchFilter

R visitExtensibleMatchFilter(P p,
                             java.lang.String matchingRule,
                             java.lang.String attributeDescription,
                             ByteString assertionValue,
                             boolean dnAttributes)

Visits an extensible filter.

Parameters:

p - A visitor specified parameter.

matchingRule - The matching rule name, may be null if attributeDescription is specified.

attributeDescription - The attribute description, may be null if matchingRule is specified.

assertionValue - The assertion value.

dnAttributes - Indicates whether DN matching should be performed.

Returns:

Returns a visitor specified result.

visitGreaterOrEqualFilter

R visitGreaterOrEqualFilter(P p,
                            java.lang.String attributeDescription,
                            ByteString assertionValue)

Visits a greater or equal filter.

Parameters:

p - A visitor specified parameter.

attributeDescription - The attribute description.

assertionValue - The assertion value.

Returns:

Returns a visitor specified result.

visitLessOrEqualFilter

R visitLessOrEqualFilter(P p,
                         java.lang.String attributeDescription,
                         ByteString assertionValue)

Visits a less or equal filter.

Parameters:

p - A visitor specified parameter.

attributeDescription - The attribute description.

assertionValue - The assertion value.

Returns:

Returns a visitor specified result.

visitNotFilter

R visitNotFilter(P p,
                 Filter subFilter)

Visits a not filter.

Parameters:

p - A visitor specified parameter.

subFilter - The sub-filter.

Returns:

Returns a visitor specified result.

visitOrFilter

R visitOrFilter(P p,
                java.util.List<Filter> subFilters)

Visits an or filter.

Implementation note: for the purposes of matching an empty sub-filter list should always evaluate to false as per RFC 4526.

Parameters:

p - A visitor specified parameter.

subFilters - The unmodifiable list of sub-filters.

Returns:

Returns a visitor specified result.

visitPresentFilter

R visitPresentFilter(P p,
                     java.lang.String attributeDescription)

Visits a present filter.

Parameters:

p - A visitor specified parameter.

attributeDescription - The attribute description.

Returns:

Returns a visitor specified result.

visitSubstringsFilter

R visitSubstringsFilter(P p,
                        java.lang.String attributeDescription,
                        ByteString initialSubstring,
                        java.util.List<ByteString> anySubstrings,
                        ByteString finalSubstring)

Visits a substrings filter.

Parameters:

p - A visitor specified parameter.

attributeDescription - The attribute description.

initialSubstring - The initial sub-string, may be null.

anySubstrings - The unmodifiable list of any sub-strings, may be empty.

finalSubstring - The final sub-string, may be null.

Returns:

Returns a visitor specified result.

visitUnrecognizedFilter

R visitUnrecognizedFilter(P p,
                          byte filterTag,
                          ByteString filterBytes)

Visits an unrecognized filter.

Parameters:

p - A visitor specified parameter.

filterTag - The ASN.1 tag.

filterBytes - The filter content.

Returns:

Returns a visitor specified result.

Skip navigation links