|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.types.RawModification
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=true, mayExtend=false, mayInvoke=true) public abstract class RawModification
This class defines the data structures and methods to use when interacting with a raw modification, which describes a change that should be made to an attribute.
Constructor Summary | |
---|---|
RawModification()
|
Method Summary | |
---|---|
static RawModification |
create(ModificationType modificationType,
RawAttribute attribute)
Creates a new raw modification with the provided type and attribute. |
static RawModification |
create(ModificationType modificationType,
java.lang.String attributeType)
Creates a new raw modification with the provided type and attribute. |
static RawModification |
create(ModificationType modificationType,
java.lang.String attributeType,
ByteString attributeValue)
Creates a new raw modification with the provided type and attribute. |
static RawModification |
create(ModificationType modificationType,
java.lang.String attributeType,
java.util.List<ByteString> attributeValues)
Creates a new raw modification with the provided type and attribute. |
static RawModification |
create(ModificationType modificationType,
java.lang.String attributeType,
java.lang.String attributeValue)
Creates a new raw modification with the provided type and attribute. |
static LDAPModification |
decode(ASN1Element element)
Decodes the provided ASN.1 element as an LDAP modification. |
ASN1Element |
encode()
Encodes this modification to an ASN.1 element. |
abstract RawAttribute |
getAttribute()
Retrieves the attribute for this modification. |
abstract ModificationType |
getModificationType()
Retrieves the modification type for this modification. |
abstract void |
setAttribute(RawAttribute attribute)
Specifies the attribute for this modification. |
abstract void |
setModificationType(ModificationType modificationType)
Specifies the modification type for this modification. |
abstract Modification |
toModification()
Creates a new core Modification object from this raw
modification. |
java.lang.String |
toString()
Retrieves a string representation of this modification. |
abstract void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this modification to the provided buffer. |
abstract void |
toString(java.lang.StringBuilder buffer,
int indent)
Appends a multi-line string representation of this LDAP modification to the provided buffer. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public RawModification()
Method Detail |
---|
public static RawModification create(ModificationType modificationType, RawAttribute attribute)
modificationType
- The modification type for this
modification.attribute
- The attribute for this modification.
public static RawModification create(ModificationType modificationType, java.lang.String attributeType)
modificationType
- The modification type for this
modification.attributeType
- The name of the attribute type for this
modification.
public static RawModification create(ModificationType modificationType, java.lang.String attributeType, java.lang.String attributeValue)
modificationType
- The modification type for this
modification.attributeType
- The name of the attribute type for this
modification.attributeValue
- The attribute value for this
modification.
public static RawModification create(ModificationType modificationType, java.lang.String attributeType, ByteString attributeValue)
modificationType
- The modification type for this
modification.attributeType
- The name of the attribute type for this
modification.attributeValue
- The attribute value for this
modification.
public static RawModification create(ModificationType modificationType, java.lang.String attributeType, java.util.List<ByteString> attributeValues)
modificationType
- The modification type for this
modification.attributeType
- The name of the attribute type for this
modification.attributeValues
- The set of attribute values for this
modification.
public abstract ModificationType getModificationType()
public abstract void setModificationType(ModificationType modificationType)
modificationType
- The modification type for this
modification.public abstract RawAttribute getAttribute()
public abstract void setAttribute(RawAttribute attribute)
attribute
- The attribute for this modification.public final ASN1Element encode()
public static LDAPModification decode(ASN1Element element) throws LDAPException
element
- The ASN.1 element to decode.
LDAPException
- If a problem occurs while attempting to
decode the provided ASN.1 element as a
raw modification.public abstract Modification toModification() throws LDAPException
Modification
object from this raw
modification.
LDAPException
- If a problem occurs while trying to
convert the raw modification to a core
Modification
.public java.lang.String toString()
toString
in class java.lang.Object
public abstract void toString(java.lang.StringBuilder buffer)
buffer
- The buffer to which the information should be
appended.public abstract void toString(java.lang.StringBuilder buffer, int indent)
buffer
- The buffer to which the information should be
appended.indent
- The number of spaces from the margin that the
lines should be indented.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |