Package com.unboundid.ldap.protocol
Class CompareResponseProtocolOp
- java.lang.Object
-
- com.unboundid.ldap.protocol.GenericResponseProtocolOp
-
- com.unboundid.ldap.protocol.CompareResponseProtocolOp
-
- All Implemented Interfaces:
ProtocolOp
,java.io.Serializable
@InternalUseOnly @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class CompareResponseProtocolOp extends GenericResponseProtocolOp
This class provides an implementation of a compare response protocol op.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.unboundid.ldap.protocol.GenericResponseProtocolOp
TYPE_REFERRALS
-
-
Constructor Summary
Constructors Constructor Description CompareResponseProtocolOp(int resultCode, java.lang.String matchedDN, java.lang.String diagnosticMessage, java.util.List<java.lang.String> referralURLs)
Creates a new instance of this compare response protocol op with the provided information.CompareResponseProtocolOp(LDAPResult result)
Creates a new compare response protocol op from the provided LDAP result object.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CompareResponseProtocolOp
decodeProtocolOp(ASN1Element element)
Decodes the provided ASN.1 element as a compare response protocol op.ASN1Element
encodeProtocolOp()
Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.-
Methods inherited from class com.unboundid.ldap.protocol.GenericResponseProtocolOp
getDiagnosticMessage, getMatchedDN, getProtocolOpType, getReferralURLs, getResultCode, toLDAPResult, toString, toString, writeTo
-
-
-
-
Constructor Detail
-
CompareResponseProtocolOp
public CompareResponseProtocolOp(int resultCode, @Nullable java.lang.String matchedDN, @Nullable java.lang.String diagnosticMessage, @Nullable java.util.List<java.lang.String> referralURLs)
Creates a new instance of this compare response protocol op with the provided information.- Parameters:
resultCode
- The result code for this response.matchedDN
- The matched DN for this response, if available.diagnosticMessage
- The diagnostic message for this response, if any.referralURLs
- The list of referral URLs for this response, if any.
-
CompareResponseProtocolOp
public CompareResponseProtocolOp(@NotNull LDAPResult result)
Creates a new compare response protocol op from the provided LDAP result object.- Parameters:
result
- The LDAP result object to use to create this protocol op.
-
-
Method Detail
-
encodeProtocolOp
@NotNull public ASN1Element encodeProtocolOp()
Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.- Returns:
- The ASN.1 element containing the encoded protocol op.
-
decodeProtocolOp
@NotNull public static CompareResponseProtocolOp decodeProtocolOp(@NotNull ASN1Element element) throws LDAPException
Decodes the provided ASN.1 element as a compare response protocol op.- Parameters:
element
- The ASN.1 element to be decoded.- Returns:
- The decoded compare response protocol op.
- Throws:
LDAPException
- If the provided ASN.1 element cannot be decoded as a compare response protocol op.
-
-