Top Description Inners Fields Constructors Methods
org.keycloak.representations.idm

public Class LDAPCapabilityRepresentation

extends Object
Class Inheritance
Imports
java.util.Objects, org.keycloak.common.util.ObjectUtil

Value object to represent an OID (object identifier) as used to describe LDAP schema, extension and features. See LDAP OID Reference Guide.
Author
Lars Uffmann, 2020-05-13
Since
11.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum

Field Summary

Modifier and TypeField and Description
private Object
private LDAPCapabilityRepresentation.CapabilityType

Constructor Summary

AccessConstructor and Description
public
public

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public String
public LDAPCapabilityRepresentation.CapabilityType
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

oidback to summary
private Object oid
typeback to summary
private LDAPCapabilityRepresentation.CapabilityType type

Constructor Detail

LDAPCapabilityRepresentationback to summary
public LDAPCapabilityRepresentation()
LDAPCapabilityRepresentationback to summary
public LDAPCapabilityRepresentation(Object oidValue, LDAPCapabilityRepresentation.CapabilityType type)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getOidback to summary
public String getOid()
getTypeback to summary
public LDAPCapabilityRepresentation.CapabilityType getType()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
org.keycloak.representations.idm back to summary

public final Enum LDAPCapabilityRepresentation.CapabilityType

extends Enum<LDAPCapabilityRepresentation.CapabilityType>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final LDAPCapabilityRepresentation.CapabilityType
public static final LDAPCapabilityRepresentation.CapabilityType
public static final LDAPCapabilityRepresentation.CapabilityType
public static final LDAPCapabilityRepresentation.CapabilityType

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static LDAPCapabilityRepresentation.CapabilityType
public static LDAPCapabilityRepresentation.CapabilityType
public static LDAPCapabilityRepresentation.CapabilityType[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CONTROLback to summary
public static final LDAPCapabilityRepresentation.CapabilityType CONTROL
EXTENSIONback to summary
public static final LDAPCapabilityRepresentation.CapabilityType EXTENSION
FEATUREback to summary
public static final LDAPCapabilityRepresentation.CapabilityType FEATURE
UNKNOWNback to summary
public static final LDAPCapabilityRepresentation.CapabilityType UNKNOWN

Constructor Detail

CapabilityTypeback to summary
private CapabilityType()

Method Detail

fromRootDseAttributeNameback to summary
public static LDAPCapabilityRepresentation.CapabilityType fromRootDseAttributeName(String attributeName)
valueOfback to summary
public static LDAPCapabilityRepresentation.CapabilityType valueOf(String name)
valuesback to summary
public static LDAPCapabilityRepresentation.CapabilityType[] values()