com.unboundid.ldap.sdk.unboundidds.extensions
Class IgnoreAttributesChangeSelectionCriteria

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.extensions.ChangelogBatchChangeSelectionCriteria
      extended by com.unboundid.ldap.sdk.unboundidds.extensions.IgnoreAttributesChangeSelectionCriteria

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class IgnoreAttributesChangeSelectionCriteria
extends ChangelogBatchChangeSelectionCriteria

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class provides an implementation of a get changelog batch change selection criteria value that indicates that the server should not return changes which target only the specified attributes. This can be useful for ignoring changes to attributes which are changed frequently but not of interest to the client. Note that changes returned may include changes to these attributes, but only if the change targets other attributes that should not be ignored.


Constructor Summary
IgnoreAttributesChangeSelectionCriteria(boolean ignoreOperationalAttributes, java.util.Collection<java.lang.String> attributeNames)
          Creates a new ignore attributes change selection criteria value with the provided information.
IgnoreAttributesChangeSelectionCriteria(boolean ignoreOperationalAttributes, java.lang.String... attributeNames)
          Creates a new ignore attributes change selection criteria value with the provided information.
 
Method Summary
 ASN1Element encodeInnerElement()
          Encodes the inner element for this changelog batch change selection criteria to an ASN.1 element.
 java.util.List<java.lang.String> getAttributeNames()
          Retrieves the names of the target attributes for changes that should be retrieved.
 boolean ignoreOperationalAttributes()
          Indicates whether to automatically include all operational attributes in the set of attributes to ignore.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this changelog batch change selection criteria value to the provided buffer.
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.extensions.ChangelogBatchChangeSelectionCriteria
decode, encode, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IgnoreAttributesChangeSelectionCriteria

public IgnoreAttributesChangeSelectionCriteria(boolean ignoreOperationalAttributes,
                                               java.lang.String... attributeNames)
Creates a new ignore attributes change selection criteria value with the provided information.

Parameters:
ignoreOperationalAttributes - Indicates whether to automatically include all operational attributes in the set of attributes to ignore.
attributeNames - The names of the attributes to ignore. It may be null or empty only if ignoreOperationalAttributes is true and no user attributes changes should be ignored.

IgnoreAttributesChangeSelectionCriteria

public IgnoreAttributesChangeSelectionCriteria(boolean ignoreOperationalAttributes,
                                               java.util.Collection<java.lang.String> attributeNames)
Creates a new ignore attributes change selection criteria value with the provided information.

Parameters:
ignoreOperationalAttributes - Indicates whether to automatically include all operational attributes in the set of attributes to ignore.
attributeNames - The names of the attributes to ignore. It may be null or empty only if ignoreOperationalAttributes is true and no user attributes changes should be ignored.
Method Detail

ignoreOperationalAttributes

public boolean ignoreOperationalAttributes()
Indicates whether to automatically include all operational attributes in the set of attributes to ignore.

Returns:
true if all operational attributes should automatically be included in the set of attributes to ignore, or false if only those operational attributes which are explicitly named should be ignored.

getAttributeNames

public java.util.List<java.lang.String> getAttributeNames()
Retrieves the names of the target attributes for changes that should be retrieved.

Returns:
The names of the target attributes for changes that should be retrieved.

encodeInnerElement

public ASN1Element encodeInnerElement()
Encodes the inner element for this changelog batch change selection criteria to an ASN.1 element.

Specified by:
encodeInnerElement in class ChangelogBatchChangeSelectionCriteria
Returns:
The encoded representation of the inner element to include in the encoded representation of the changelog batch change selection criteria element.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this changelog batch change selection criteria value to the provided buffer.

Specified by:
toString in class ChangelogBatchChangeSelectionCriteria
Parameters:
buffer - The buffer to which the information should be appended.